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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain;
  15 use chain::Listen;
  16 use chain::Watch;
  17 use chain::channelmonitor;
  18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  19 use chain::transaction::OutPoint;
  20 use chain::keysinterface::{KeysInterface, BaseSign};
  21 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  22 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  23 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  24 use ln::channel::{Channel, ChannelError};
  25 use ln::{chan_utils, onion_utils};
  26 use routing::router::{Route, RouteHop, get_route};
  27 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  28 use ln::msgs;
  29 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  30 use util::enforcing_trait_impls::EnforcingSigner;
  31 use util::{byte_utils, test_utils};
  32 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  33 use util::errors::APIError;
  34 use util::ser::{Writeable, ReadableArgs};
  35 use util::config::UserConfig;
  36
  37 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  38 use bitcoin::hash_types::{Txid, BlockHash};
  39 use bitcoin::blockdata::block::{Block, BlockHeader};
  40 use bitcoin::blockdata::script::Builder;
  41 use bitcoin::blockdata::opcodes;
  42 use bitcoin::blockdata::constants::genesis_block;
  43 use bitcoin::network::constants::Network;
  44
  45 use bitcoin::hashes::sha256::Hash as Sha256;
  46 use bitcoin::hashes::Hash;
  47
  48 use bitcoin::secp256k1::{Secp256k1, Message};
  49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  50
  51 use regex;
  52
  53 use std::collections::{BTreeSet, HashMap, HashSet};
  54 use std::default::Default;
  55 use std::sync::Mutex;
  56
  57 use ln::functional_test_utils::*;
  58 use ln::chan_utils::CommitmentTransaction;
  59 use ln::msgs::OptionalField::Present;
  60
  61 #[test]
  62 fn test_insane_channel_opens() {
  63         // Stand up a network of 2 nodes
  64         let chanmon_cfgs = create_chanmon_cfgs(2);
  65         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  66         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  67         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  68
  69         // Instantiate channel parameters where we push the maximum msats given our
  70         // funding satoshis
  71         let channel_value_sat = 31337; // same as funding satoshis
  72         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  73         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  74
  75         // Have node0 initiate a channel to node1 with aforementioned parameters
  76         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  77
  78         // Extract the channel open message from node0 to node1
  79         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  80
  81         // Test helper that asserts we get the correct error string given a mutator
  82         // that supposedly makes the channel open message insane
  83         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  84                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  85                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  86                 assert_eq!(msg_events.len(), 1);
  87                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  88                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  89                         match action {
  90                                 &ErrorAction::SendErrorMessage { .. } => {
  91                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  92                                 },
  93                                 _ => panic!("unexpected event!"),
  94                         }
  95                 } else { assert!(false); }
  96         };
  97
  98         use ln::channel::MAX_FUNDING_SATOSHIS;
  99         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 100
 101         // Test all mutations that would make the channel open message insane
 102         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 });
 103
 104         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 105
 106         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 });
 107
 108         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 109
 110         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 });
 111
 112         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 });
 113
 114         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 });
 115
 116         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 117
 118         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 119 }
 120
 121 #[test]
 122 fn test_async_inbound_update_fee() {
 123         let chanmon_cfgs = create_chanmon_cfgs(2);
 124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 126         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 127         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 128         let logger = test_utils::TestLogger::new();
 129         let channel_id = chan.2;
 130
 131         // balancing
 132         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 133
 134         // A                                        B
 135         // update_fee                            ->
 136         // send (1) commitment_signed            -.
 137         //                                       <- update_add_htlc/commitment_signed
 138         // send (2) RAA (awaiting remote revoke) -.
 139         // (1) commitment_signed is delivered    ->
 140         //                                       .- send (3) RAA (awaiting remote revoke)
 141         // (2) RAA is delivered                  ->
 142         //                                       .- send (4) commitment_signed
 143         //                                       <- (3) RAA is delivered
 144         // send (5) commitment_signed            -.
 145         //                                       <- (4) commitment_signed is delivered
 146         // send (6) RAA                          -.
 147         // (5) commitment_signed is delivered    ->
 148         //                                       <- RAA
 149         // (6) RAA is delivered                  ->
 150
 151         // First nodes[0] generates an update_fee
 152         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 153         check_added_monitors!(nodes[0], 1);
 154
 155         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 156         assert_eq!(events_0.len(), 1);
 157         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 158                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 159                         (update_fee.as_ref(), commitment_signed)
 160                 },
 161                 _ => panic!("Unexpected event"),
 162         };
 163
 164         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 165
 166         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 167         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 168         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 169         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 170         check_added_monitors!(nodes[1], 1);
 171
 172         let payment_event = {
 173                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 174                 assert_eq!(events_1.len(), 1);
 175                 SendEvent::from_event(events_1.remove(0))
 176         };
 177         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 178         assert_eq!(payment_event.msgs.len(), 1);
 179
 180         // ...now when the messages get delivered everyone should be happy
 181         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 182         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 183         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 184         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 185         check_added_monitors!(nodes[0], 1);
 186
 187         // deliver(1), generate (3):
 188         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 189         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 190         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 191         check_added_monitors!(nodes[1], 1);
 192
 193         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 194         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 195         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 196         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 197         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fee.is_none()); // (4)
 200         check_added_monitors!(nodes[1], 1);
 201
 202         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 203         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 204         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 205         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 206         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fee.is_none()); // (5)
 209         check_added_monitors!(nodes[0], 1);
 210
 211         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 212         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 213         // only (6) so get_event_msg's assert(len == 1) passes
 214         check_added_monitors!(nodes[0], 1);
 215
 216         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 217         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 218         check_added_monitors!(nodes[1], 1);
 219
 220         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 221         check_added_monitors!(nodes[0], 1);
 222
 223         let events_2 = nodes[0].node.get_and_clear_pending_events();
 224         assert_eq!(events_2.len(), 1);
 225         match events_2[0] {
 226                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 227                 _ => panic!("Unexpected event"),
 228         }
 229
 230         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 231         check_added_monitors!(nodes[1], 1);
 232 }
 233
 234 #[test]
 235 fn test_update_fee_unordered_raa() {
 236         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 237         // crash in an earlier version of the update_fee patch)
 238         let chanmon_cfgs = create_chanmon_cfgs(2);
 239         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 240         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 241         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 242         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 243         let channel_id = chan.2;
 244         let logger = test_utils::TestLogger::new();
 245
 246         // balancing
 247         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 248
 249         // First nodes[0] generates an update_fee
 250         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 251         check_added_monitors!(nodes[0], 1);
 252
 253         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 254         assert_eq!(events_0.len(), 1);
 255         let update_msg = match events_0[0] { // (1)
 256                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 257                         update_fee.as_ref()
 258                 },
 259                 _ => panic!("Unexpected event"),
 260         };
 261
 262         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 263
 264         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 265         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 266         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 267         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 268         check_added_monitors!(nodes[1], 1);
 269
 270         let payment_event = {
 271                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 272                 assert_eq!(events_1.len(), 1);
 273                 SendEvent::from_event(events_1.remove(0))
 274         };
 275         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 276         assert_eq!(payment_event.msgs.len(), 1);
 277
 278         // ...now when the messages get delivered everyone should be happy
 279         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 280         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 281         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 282         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 283         check_added_monitors!(nodes[0], 1);
 284
 285         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 286         check_added_monitors!(nodes[1], 1);
 287
 288         // We can't continue, sadly, because our (1) now has a bogus signature
 289 }
 290
 291 #[test]
 292 fn test_multi_flight_update_fee() {
 293         let chanmon_cfgs = create_chanmon_cfgs(2);
 294         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 295         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 296         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 297         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 298         let channel_id = chan.2;
 299
 300         // A                                        B
 301         // update_fee/commitment_signed          ->
 302         //                                       .- send (1) RAA and (2) commitment_signed
 303         // update_fee (never committed)          ->
 304         // (3) update_fee                        ->
 305         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 306         // don't track which updates correspond to which revoke_and_ack responses so we're in
 307         // AwaitingRAA mode and will not generate the update_fee yet.
 308         //                                       <- (1) RAA delivered
 309         // (3) is generated and send (4) CS      -.
 310         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 311         // know the per_commitment_point to use for it.
 312         //                                       <- (2) commitment_signed delivered
 313         // revoke_and_ack                        ->
 314         //                                          B should send no response here
 315         // (4) commitment_signed delivered       ->
 316         //                                       <- RAA/commitment_signed delivered
 317         // revoke_and_ack                        ->
 318
 319         // First nodes[0] generates an update_fee
 320         let initial_feerate = get_feerate!(nodes[0], channel_id);
 321         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 322         check_added_monitors!(nodes[0], 1);
 323
 324         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 325         assert_eq!(events_0.len(), 1);
 326         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 327                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 328                         (update_fee.as_ref().unwrap(), commitment_signed)
 329                 },
 330                 _ => panic!("Unexpected event"),
 331         };
 332
 333         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 334         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 335         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 336         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 337         check_added_monitors!(nodes[1], 1);
 338
 339         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 340         // transaction:
 341         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 342         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 343         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 344
 345         // Create the (3) update_fee message that nodes[0] will generate before it does...
 346         let mut update_msg_2 = msgs::UpdateFee {
 347                 channel_id: update_msg_1.channel_id.clone(),
 348                 feerate_per_kw: (initial_feerate + 30) as u32,
 349         };
 350
 351         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 352
 353         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 354         // Deliver (3)
 355         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 356
 357         // Deliver (1), generating (3) and (4)
 358         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 359         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 360         check_added_monitors!(nodes[0], 1);
 361         assert!(as_second_update.update_add_htlcs.is_empty());
 362         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 363         assert!(as_second_update.update_fail_htlcs.is_empty());
 364         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 365         // Check that the update_fee newly generated matches what we delivered:
 366         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 367         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 368
 369         // Deliver (2) commitment_signed
 370         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 371         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 372         check_added_monitors!(nodes[0], 1);
 373         // No commitment_signed so get_event_msg's assert(len == 1) passes
 374
 375         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 376         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 377         check_added_monitors!(nodes[1], 1);
 378
 379         // Delever (4)
 380         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 381         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 382         check_added_monitors!(nodes[1], 1);
 383
 384         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 385         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 386         check_added_monitors!(nodes[0], 1);
 387
 388         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 389         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 390         // No commitment_signed so get_event_msg's assert(len == 1) passes
 391         check_added_monitors!(nodes[0], 1);
 392
 393         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 394         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 395         check_added_monitors!(nodes[1], 1);
 396 }
 397
 398 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 399         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 400         // tests that we properly send one in that case.
 401         let mut alice_config = UserConfig::default();
 402         alice_config.own_channel_config.minimum_depth = 1;
 403         alice_config.channel_options.announced_channel = true;
 404         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 405         let mut bob_config = UserConfig::default();
 406         bob_config.own_channel_config.minimum_depth = 1;
 407         bob_config.channel_options.announced_channel = true;
 408         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 409         let chanmon_cfgs = create_chanmon_cfgs(2);
 410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 413         *nodes[0].connect_style.borrow_mut() = connect_style;
 414
 415         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 416         mine_transaction(&nodes[1], &tx);
 417         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()));
 418
 419         mine_transaction(&nodes[0], &tx);
 420         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 421         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 422
 423         for node in nodes {
 424                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 425                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 426                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 427         }
 428 }
 429 #[test]
 430 fn test_1_conf_open() {
 431         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 432         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 433         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 434 }
 435
 436 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 437         // Previously, we had issues deserializing channels when we hadn't connected the first block
 438         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 439         // serialization round-trips and simply do steps towards opening a channel and then drop the
 440         // Node objects.
 441
 442         let chanmon_cfgs = create_chanmon_cfgs(2);
 443         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 444         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 445         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 446
 447         if steps & 0b1000_0000 != 0{
 448                 let block = Block {
 449                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 450                         txdata: vec![],
 451                 };
 452                 connect_block(&nodes[0], &block);
 453                 connect_block(&nodes[1], &block);
 454         }
 455
 456         if steps & 0x0f == 0 { return; }
 457         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 458         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 1 { return; }
 461         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 462         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 463
 464         if steps & 0x0f == 2 { return; }
 465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 466
 467         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 468
 469         if steps & 0x0f == 3 { return; }
 470         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 471         check_added_monitors!(nodes[0], 0);
 472         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 473
 474         if steps & 0x0f == 4 { return; }
 475         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 476         {
 477                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 483
 484         if steps & 0x0f == 5 { return; }
 485         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 486         {
 487                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 488                 assert_eq!(added_monitors.len(), 1);
 489                 assert_eq!(added_monitors[0].0, funding_output);
 490                 added_monitors.clear();
 491         }
 492
 493         let events_4 = nodes[0].node.get_and_clear_pending_events();
 494         assert_eq!(events_4.len(), 0);
 495
 496         if steps & 0x0f == 6 { return; }
 497         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 498
 499         if steps & 0x0f == 7 { return; }
 500         confirm_transaction_at(&nodes[0], &tx, 2);
 501         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 502         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 503 }
 504
 505 #[test]
 506 fn test_sanity_on_in_flight_opens() {
 507         do_test_sanity_on_in_flight_opens(0);
 508         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(1);
 510         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(2);
 512         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(3);
 514         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(4);
 516         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(5);
 518         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(6);
 520         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(7);
 522         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(8);
 524         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 525 }
 526
 527 #[test]
 528 fn test_update_fee_vanilla() {
 529         let chanmon_cfgs = create_chanmon_cfgs(2);
 530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 533         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 534         let channel_id = chan.2;
 535
 536         let feerate = get_feerate!(nodes[0], channel_id);
 537         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 538         check_added_monitors!(nodes[0], 1);
 539
 540         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 541         assert_eq!(events_0.len(), 1);
 542         let (update_msg, commitment_signed) = match events_0[0] {
 543                         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 } } => {
 544                         (update_fee.as_ref(), commitment_signed)
 545                 },
 546                 _ => panic!("Unexpected event"),
 547         };
 548         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 549
 550         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 551         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 552         check_added_monitors!(nodes[1], 1);
 553
 554         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 555         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 556         check_added_monitors!(nodes[0], 1);
 557
 558         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 559         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 560         // No commitment_signed so get_event_msg's assert(len == 1) passes
 561         check_added_monitors!(nodes[0], 1);
 562
 563         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 564         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 565         check_added_monitors!(nodes[1], 1);
 566 }
 567
 568 #[test]
 569 fn test_update_fee_that_funder_cannot_afford() {
 570         let chanmon_cfgs = create_chanmon_cfgs(2);
 571         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 572         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 573         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 574         let channel_value = 1888;
 575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 576         let channel_id = chan.2;
 577
 578         let feerate = 260;
 579         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 580         check_added_monitors!(nodes[0], 1);
 581         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 582
 583         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 584
 585         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 586
 587         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 588         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 589         {
 590                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 591
 592                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 593                 let num_htlcs = commitment_tx.output.len() - 2;
 594                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 595                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 596                 actual_fee = channel_value - actual_fee;
 597                 assert_eq!(total_fee, actual_fee);
 598         }
 599
 600         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 601         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 602         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 603         check_added_monitors!(nodes[0], 1);
 604
 605         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 606
 607         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 608
 609         //While producing the commitment_signed response after handling a received update_fee request the
 610         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 611         //Should produce and error.
 612         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 613         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 614         check_added_monitors!(nodes[1], 1);
 615         check_closed_broadcast!(nodes[1], true);
 616 }
 617
 618 #[test]
 619 fn test_update_fee_with_fundee_update_add_htlc() {
 620         let chanmon_cfgs = create_chanmon_cfgs(2);
 621         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 622         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 623         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 624         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 625         let channel_id = chan.2;
 626         let logger = test_utils::TestLogger::new();
 627
 628         // balancing
 629         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 630
 631         let feerate = get_feerate!(nodes[0], channel_id);
 632         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 633         check_added_monitors!(nodes[0], 1);
 634
 635         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 636         assert_eq!(events_0.len(), 1);
 637         let (update_msg, commitment_signed) = match events_0[0] {
 638                         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 } } => {
 639                         (update_fee.as_ref(), commitment_signed)
 640                 },
 641                 _ => panic!("Unexpected event"),
 642         };
 643         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 644         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 645         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 646         check_added_monitors!(nodes[1], 1);
 647
 648         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 649         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 650         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 651
 652         // nothing happens since node[1] is in AwaitingRemoteRevoke
 653         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 654         {
 655                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 656                 assert_eq!(added_monitors.len(), 0);
 657                 added_monitors.clear();
 658         }
 659         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 660         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 661         // node[1] has nothing to do
 662
 663         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 664         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 665         check_added_monitors!(nodes[0], 1);
 666
 667         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 668         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 669         // No commitment_signed so get_event_msg's assert(len == 1) passes
 670         check_added_monitors!(nodes[0], 1);
 671         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 672         check_added_monitors!(nodes[1], 1);
 673         // AwaitingRemoteRevoke ends here
 674
 675         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 676         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 677         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 678         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 679         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fee.is_none(), true);
 681
 682         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 683         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 684         check_added_monitors!(nodes[0], 1);
 685         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 686
 687         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 688         check_added_monitors!(nodes[1], 1);
 689         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 690
 691         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 692         check_added_monitors!(nodes[1], 1);
 693         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 694         // No commitment_signed so get_event_msg's assert(len == 1) passes
 695
 696         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 697         check_added_monitors!(nodes[0], 1);
 698         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 699
 700         expect_pending_htlcs_forwardable!(nodes[0]);
 701
 702         let events = nodes[0].node.get_and_clear_pending_events();
 703         assert_eq!(events.len(), 1);
 704         match events[0] {
 705                 Event::PaymentReceived { .. } => { },
 706                 _ => panic!("Unexpected event"),
 707         };
 708
 709         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 710
 711         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 712         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 713         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 714 }
 715
 716 #[test]
 717 fn test_update_fee() {
 718         let chanmon_cfgs = create_chanmon_cfgs(2);
 719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 721         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 722         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 723         let channel_id = chan.2;
 724
 725         // A                                        B
 726         // (1) update_fee/commitment_signed      ->
 727         //                                       <- (2) revoke_and_ack
 728         //                                       .- send (3) commitment_signed
 729         // (4) update_fee/commitment_signed      ->
 730         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 731         //                                       <- (3) commitment_signed delivered
 732         // send (6) revoke_and_ack               -.
 733         //                                       <- (5) deliver revoke_and_ack
 734         // (6) deliver revoke_and_ack            ->
 735         //                                       .- send (7) commitment_signed in response to (4)
 736         //                                       <- (7) deliver commitment_signed
 737         // revoke_and_ack                        ->
 738
 739         // Create and deliver (1)...
 740         let feerate = get_feerate!(nodes[0], channel_id);
 741         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 742         check_added_monitors!(nodes[0], 1);
 743
 744         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 745         assert_eq!(events_0.len(), 1);
 746         let (update_msg, commitment_signed) = match events_0[0] {
 747                         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 } } => {
 748                         (update_fee.as_ref(), commitment_signed)
 749                 },
 750                 _ => panic!("Unexpected event"),
 751         };
 752         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 753
 754         // Generate (2) and (3):
 755         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 756         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 757         check_added_monitors!(nodes[1], 1);
 758
 759         // Deliver (2):
 760         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 761         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 762         check_added_monitors!(nodes[0], 1);
 763
 764         // Create and deliver (4)...
 765         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 766         check_added_monitors!(nodes[0], 1);
 767         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 768         assert_eq!(events_0.len(), 1);
 769         let (update_msg, commitment_signed) = match events_0[0] {
 770                         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 } } => {
 771                         (update_fee.as_ref(), commitment_signed)
 772                 },
 773                 _ => panic!("Unexpected event"),
 774         };
 775
 776         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 777         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 778         check_added_monitors!(nodes[1], 1);
 779         // ... creating (5)
 780         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 781         // No commitment_signed so get_event_msg's assert(len == 1) passes
 782
 783         // Handle (3), creating (6):
 784         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 785         check_added_monitors!(nodes[0], 1);
 786         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 787         // No commitment_signed so get_event_msg's assert(len == 1) passes
 788
 789         // Deliver (5):
 790         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 791         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 792         check_added_monitors!(nodes[0], 1);
 793
 794         // Deliver (6), creating (7):
 795         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 796         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 797         assert!(commitment_update.update_add_htlcs.is_empty());
 798         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 799         assert!(commitment_update.update_fail_htlcs.is_empty());
 800         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 801         assert!(commitment_update.update_fee.is_none());
 802         check_added_monitors!(nodes[1], 1);
 803
 804         // Deliver (7)
 805         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 806         check_added_monitors!(nodes[0], 1);
 807         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 808         // No commitment_signed so get_event_msg's assert(len == 1) passes
 809
 810         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 811         check_added_monitors!(nodes[1], 1);
 812         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 813
 814         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 815         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 816         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 817 }
 818
 819 #[test]
 820 fn pre_funding_lock_shutdown_test() {
 821         // Test sending a shutdown prior to funding_locked after funding generation
 822         let chanmon_cfgs = create_chanmon_cfgs(2);
 823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 825         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 826         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 827         mine_transaction(&nodes[0], &tx);
 828         mine_transaction(&nodes[1], &tx);
 829
 830         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 831         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 832         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 833         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 834         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 835
 836         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 837         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 838         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 839         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 840         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 841         assert!(node_0_none.is_none());
 842
 843         assert!(nodes[0].node.list_channels().is_empty());
 844         assert!(nodes[1].node.list_channels().is_empty());
 845 }
 846
 847 #[test]
 848 fn updates_shutdown_wait() {
 849         // Test sending a shutdown with outstanding updates pending
 850         let chanmon_cfgs = create_chanmon_cfgs(3);
 851         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 852         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 853         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 854         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 855         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 856         let logger = test_utils::TestLogger::new();
 857
 858         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 859
 860         nodes[0].node.close_channel(&chan_1.2).unwrap();
 861         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 862         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 863         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 864         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 865
 866         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 867         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 868
 869         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 870
 871         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 872         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 873         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 874         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 875         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 876         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 877
 878         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 879         check_added_monitors!(nodes[2], 1);
 880         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 881         assert!(updates.update_add_htlcs.is_empty());
 882         assert!(updates.update_fail_htlcs.is_empty());
 883         assert!(updates.update_fail_malformed_htlcs.is_empty());
 884         assert!(updates.update_fee.is_none());
 885         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 886         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 887         check_added_monitors!(nodes[1], 1);
 888         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 889         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 890
 891         assert!(updates_2.update_add_htlcs.is_empty());
 892         assert!(updates_2.update_fail_htlcs.is_empty());
 893         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 894         assert!(updates_2.update_fee.is_none());
 895         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 896         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 897         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 898
 899         let events = nodes[0].node.get_and_clear_pending_events();
 900         assert_eq!(events.len(), 1);
 901         match events[0] {
 902                 Event::PaymentSent { ref payment_preimage } => {
 903                         assert_eq!(our_payment_preimage, *payment_preimage);
 904                 },
 905                 _ => panic!("Unexpected event"),
 906         }
 907
 908         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 909         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 910         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 911         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 912         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 913         assert!(node_0_none.is_none());
 914
 915         assert!(nodes[0].node.list_channels().is_empty());
 916
 917         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 918         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 919         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 920         assert!(nodes[1].node.list_channels().is_empty());
 921         assert!(nodes[2].node.list_channels().is_empty());
 922 }
 923
 924 #[test]
 925 fn htlc_fail_async_shutdown() {
 926         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 927         let chanmon_cfgs = create_chanmon_cfgs(3);
 928         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 929         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 930         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 932         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 933         let logger = test_utils::TestLogger::new();
 934
 935         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 936         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 937         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 938         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 939         check_added_monitors!(nodes[0], 1);
 940         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 941         assert_eq!(updates.update_add_htlcs.len(), 1);
 942         assert!(updates.update_fulfill_htlcs.is_empty());
 943         assert!(updates.update_fail_htlcs.is_empty());
 944         assert!(updates.update_fail_malformed_htlcs.is_empty());
 945         assert!(updates.update_fee.is_none());
 946
 947         nodes[1].node.close_channel(&chan_1.2).unwrap();
 948         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 949         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 950         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 951
 952         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 953         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 954         check_added_monitors!(nodes[1], 1);
 955         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 956         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 957
 958         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 959         assert!(updates_2.update_add_htlcs.is_empty());
 960         assert!(updates_2.update_fulfill_htlcs.is_empty());
 961         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 962         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 963         assert!(updates_2.update_fee.is_none());
 964
 965         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 966         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 967
 968         expect_payment_failed!(nodes[0], our_payment_hash, false);
 969
 970         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 971         assert_eq!(msg_events.len(), 2);
 972         let node_0_closing_signed = match msg_events[0] {
 973                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 974                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 975                         (*msg).clone()
 976                 },
 977                 _ => panic!("Unexpected event"),
 978         };
 979         match msg_events[1] {
 980                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 981                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 982                 },
 983                 _ => panic!("Unexpected event"),
 984         }
 985
 986         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 987         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 988         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 989         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 990         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 991         assert!(node_0_none.is_none());
 992
 993         assert!(nodes[0].node.list_channels().is_empty());
 994
 995         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 996         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 997         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 998         assert!(nodes[1].node.list_channels().is_empty());
 999         assert!(nodes[2].node.list_channels().is_empty());
1000 }
1001
1002 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1003         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1004         // messages delivered prior to disconnect
1005         let chanmon_cfgs = create_chanmon_cfgs(3);
1006         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1007         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1008         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1009         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1010         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1011
1012         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013
1014         nodes[1].node.close_channel(&chan_1.2).unwrap();
1015         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016         if recv_count > 0 {
1017                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1018                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019                 if recv_count > 1 {
1020                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1021                 }
1022         }
1023
1024         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1025         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026
1027         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1028         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1029         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031
1032         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1033         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1034         assert!(node_1_shutdown == node_1_2nd_shutdown);
1035
1036         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1037         let node_0_2nd_shutdown = if recv_count > 0 {
1038                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1039                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1040                 node_0_2nd_shutdown
1041         } else {
1042                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1043                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1044                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1045         };
1046         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1047
1048         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1049         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1050
1051         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1052         check_added_monitors!(nodes[2], 1);
1053         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1054         assert!(updates.update_add_htlcs.is_empty());
1055         assert!(updates.update_fail_htlcs.is_empty());
1056         assert!(updates.update_fail_malformed_htlcs.is_empty());
1057         assert!(updates.update_fee.is_none());
1058         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1059         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1060         check_added_monitors!(nodes[1], 1);
1061         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1062         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1063
1064         assert!(updates_2.update_add_htlcs.is_empty());
1065         assert!(updates_2.update_fail_htlcs.is_empty());
1066         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1067         assert!(updates_2.update_fee.is_none());
1068         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1069         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1070         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1071
1072         let events = nodes[0].node.get_and_clear_pending_events();
1073         assert_eq!(events.len(), 1);
1074         match events[0] {
1075                 Event::PaymentSent { ref payment_preimage } => {
1076                         assert_eq!(our_payment_preimage, *payment_preimage);
1077                 },
1078                 _ => panic!("Unexpected event"),
1079         }
1080
1081         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1082         if recv_count > 0 {
1083                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1084                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1085                 assert!(node_1_closing_signed.is_some());
1086         }
1087
1088         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1089         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1090
1091         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1092         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1093         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1094         if recv_count == 0 {
1095                 // If all closing_signeds weren't delivered we can just resume where we left off...
1096                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1097
1098                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1099                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1100                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1101
1102                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1103                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1104                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1105
1106                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1107                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1108
1109                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1110                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1111                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1112
1113                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1114                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1115                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1116                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1117                 assert!(node_0_none.is_none());
1118         } else {
1119                 // If one node, however, received + responded with an identical closing_signed we end
1120                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1121                 // There isn't really anything better we can do simply, but in the future we might
1122                 // explore storing a set of recently-closed channels that got disconnected during
1123                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1124                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1125                 // transaction.
1126                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1127
1128                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1129                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1130                 assert_eq!(msg_events.len(), 1);
1131                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1132                         match action {
1133                                 &ErrorAction::SendErrorMessage { ref msg } => {
1134                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1135                                         assert_eq!(msg.channel_id, chan_1.2);
1136                                 },
1137                                 _ => panic!("Unexpected event!"),
1138                         }
1139                 } else { panic!("Needed SendErrorMessage close"); }
1140
1141                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1142                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1143                 // closing_signed so we do it ourselves
1144                 check_closed_broadcast!(nodes[0], false);
1145                 check_added_monitors!(nodes[0], 1);
1146         }
1147
1148         assert!(nodes[0].node.list_channels().is_empty());
1149
1150         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1151         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1152         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1153         assert!(nodes[1].node.list_channels().is_empty());
1154         assert!(nodes[2].node.list_channels().is_empty());
1155 }
1156
1157 #[test]
1158 fn test_shutdown_rebroadcast() {
1159         do_test_shutdown_rebroadcast(0);
1160         do_test_shutdown_rebroadcast(1);
1161         do_test_shutdown_rebroadcast(2);
1162 }
1163
1164 #[test]
1165 fn fake_network_test() {
1166         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1167         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1168         let chanmon_cfgs = create_chanmon_cfgs(4);
1169         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1170         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1171         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1172
1173         // Create some initial channels
1174         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1175         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1176         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1177
1178         // Rebalance the network a bit by relaying one payment through all the channels...
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1181         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1183
1184         // Send some more payments
1185         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1186         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1187         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1188
1189         // Test failure packets
1190         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1191         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1192
1193         // Add a new channel that skips 3
1194         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1195
1196         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1197         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1200         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1202         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1203
1204         // Do some rebalance loop payments, simultaneously
1205         let mut hops = Vec::with_capacity(3);
1206         hops.push(RouteHop {
1207                 pubkey: nodes[2].node.get_our_node_id(),
1208                 node_features: NodeFeatures::empty(),
1209                 short_channel_id: chan_2.0.contents.short_channel_id,
1210                 channel_features: ChannelFeatures::empty(),
1211                 fee_msat: 0,
1212                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1213         });
1214         hops.push(RouteHop {
1215                 pubkey: nodes[3].node.get_our_node_id(),
1216                 node_features: NodeFeatures::empty(),
1217                 short_channel_id: chan_3.0.contents.short_channel_id,
1218                 channel_features: ChannelFeatures::empty(),
1219                 fee_msat: 0,
1220                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1221         });
1222         hops.push(RouteHop {
1223                 pubkey: nodes[1].node.get_our_node_id(),
1224                 node_features: NodeFeatures::known(),
1225                 short_channel_id: chan_4.0.contents.short_channel_id,
1226                 channel_features: ChannelFeatures::known(),
1227                 fee_msat: 1000000,
1228                 cltv_expiry_delta: TEST_FINAL_CLTV,
1229         });
1230         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;
1231         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;
1232         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1233
1234         let mut hops = Vec::with_capacity(3);
1235         hops.push(RouteHop {
1236                 pubkey: nodes[3].node.get_our_node_id(),
1237                 node_features: NodeFeatures::empty(),
1238                 short_channel_id: chan_4.0.contents.short_channel_id,
1239                 channel_features: ChannelFeatures::empty(),
1240                 fee_msat: 0,
1241                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1242         });
1243         hops.push(RouteHop {
1244                 pubkey: nodes[2].node.get_our_node_id(),
1245                 node_features: NodeFeatures::empty(),
1246                 short_channel_id: chan_3.0.contents.short_channel_id,
1247                 channel_features: ChannelFeatures::empty(),
1248                 fee_msat: 0,
1249                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1250         });
1251         hops.push(RouteHop {
1252                 pubkey: nodes[1].node.get_our_node_id(),
1253                 node_features: NodeFeatures::known(),
1254                 short_channel_id: chan_2.0.contents.short_channel_id,
1255                 channel_features: ChannelFeatures::known(),
1256                 fee_msat: 1000000,
1257                 cltv_expiry_delta: TEST_FINAL_CLTV,
1258         });
1259         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;
1260         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;
1261         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1262
1263         // Claim the rebalances...
1264         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1265         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1266
1267         // Add a duplicate new channel from 2 to 4
1268         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1269
1270         // Send some payments across both channels
1271         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274
1275
1276         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1277         let events = nodes[0].node.get_and_clear_pending_msg_events();
1278         assert_eq!(events.len(), 0);
1279         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);
1280
1281         //TODO: Test that routes work again here as we've been notified that the channel is full
1282
1283         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1285         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1286
1287         // Close down the channels...
1288         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1289         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1290         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1291         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1292         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1293 }
1294
1295 #[test]
1296 fn holding_cell_htlc_counting() {
1297         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1298         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1299         // commitment dance rounds.
1300         let chanmon_cfgs = create_chanmon_cfgs(3);
1301         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1302         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1303         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1304         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1305         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1306         let logger = test_utils::TestLogger::new();
1307
1308         let mut payments = Vec::new();
1309         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1310                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1311                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1312                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1313                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1314                 payments.push((payment_preimage, payment_hash));
1315         }
1316         check_added_monitors!(nodes[1], 1);
1317
1318         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1319         assert_eq!(events.len(), 1);
1320         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1321         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1322
1323         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1324         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1325         // another HTLC.
1326         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1327         {
1328                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1329                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1330                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1331                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1332                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1333                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1334         }
1335
1336         // This should also be true if we try to forward a payment.
1337         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1338         {
1339                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1340                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1341                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1342                 check_added_monitors!(nodes[0], 1);
1343         }
1344
1345         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1346         assert_eq!(events.len(), 1);
1347         let payment_event = SendEvent::from_event(events.pop().unwrap());
1348         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1349
1350         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1351         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1352         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1353         // fails), the second will process the resulting failure and fail the HTLC backward.
1354         expect_pending_htlcs_forwardable!(nodes[1]);
1355         expect_pending_htlcs_forwardable!(nodes[1]);
1356         check_added_monitors!(nodes[1], 1);
1357
1358         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1359         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1360         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1361
1362         let events = nodes[0].node.get_and_clear_pending_msg_events();
1363         assert_eq!(events.len(), 1);
1364         match events[0] {
1365                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1366                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1367                 },
1368                 _ => panic!("Unexpected event"),
1369         }
1370
1371         expect_payment_failed!(nodes[0], payment_hash_2, false);
1372
1373         // Now forward all the pending HTLCs and claim them back
1374         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1375         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1376         check_added_monitors!(nodes[2], 1);
1377
1378         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1379         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1380         check_added_monitors!(nodes[1], 1);
1381         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1382
1383         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1384         check_added_monitors!(nodes[1], 1);
1385         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1386
1387         for ref update in as_updates.update_add_htlcs.iter() {
1388                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1389         }
1390         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1391         check_added_monitors!(nodes[2], 1);
1392         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1393         check_added_monitors!(nodes[2], 1);
1394         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1395
1396         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1397         check_added_monitors!(nodes[1], 1);
1398         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1399         check_added_monitors!(nodes[1], 1);
1400         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1401
1402         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1403         check_added_monitors!(nodes[2], 1);
1404
1405         expect_pending_htlcs_forwardable!(nodes[2]);
1406
1407         let events = nodes[2].node.get_and_clear_pending_events();
1408         assert_eq!(events.len(), payments.len());
1409         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1410                 match event {
1411                         &Event::PaymentReceived { ref payment_hash, .. } => {
1412                                 assert_eq!(*payment_hash, *hash);
1413                         },
1414                         _ => panic!("Unexpected event"),
1415                 };
1416         }
1417
1418         for (preimage, _) in payments.drain(..) {
1419                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1420         }
1421
1422         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1423 }
1424
1425 #[test]
1426 fn duplicate_htlc_test() {
1427         // Test that we accept duplicate payment_hash HTLCs across the network and that
1428         // claiming/failing them are all separate and don't affect each other
1429         let chanmon_cfgs = create_chanmon_cfgs(6);
1430         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1431         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1432         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433
1434         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1435         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1437         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1438         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1439         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1440
1441         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1442
1443         *nodes[0].network_payment_count.borrow_mut() -= 1;
1444         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1445
1446         *nodes[0].network_payment_count.borrow_mut() -= 1;
1447         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1448
1449         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1450         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1451         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1452 }
1453
1454 #[test]
1455 fn test_duplicate_htlc_different_direction_onchain() {
1456         // Test that ChannelMonitor doesn't generate 2 preimage txn
1457         // when we have 2 HTLCs with same preimage that go across a node
1458         // in opposite directions, even with the same payment secret.
1459         let chanmon_cfgs = create_chanmon_cfgs(2);
1460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1462         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1463
1464         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1465         let logger = test_utils::TestLogger::new();
1466
1467         // balancing
1468         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1469
1470         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1471
1472         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1473         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1474         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1475         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1476
1477         // Provide preimage to node 0 by claiming payment
1478         nodes[0].node.claim_funds(payment_preimage);
1479         check_added_monitors!(nodes[0], 1);
1480
1481         // Broadcast node 1 commitment txn
1482         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1483
1484         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1485         let mut has_both_htlcs = 0; // check htlcs match ones committed
1486         for outp in remote_txn[0].output.iter() {
1487                 if outp.value == 800_000 / 1000 {
1488                         has_both_htlcs += 1;
1489                 } else if outp.value == 900_000 / 1000 {
1490                         has_both_htlcs += 1;
1491                 }
1492         }
1493         assert_eq!(has_both_htlcs, 2);
1494
1495         mine_transaction(&nodes[0], &remote_txn[0]);
1496         check_added_monitors!(nodes[0], 1);
1497
1498         // Check we only broadcast 1 timeout tx
1499         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1500         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()) };
1501         assert_eq!(claim_txn.len(), 5);
1502         check_spends!(claim_txn[2], chan_1.3);
1503         check_spends!(claim_txn[3], claim_txn[2]);
1504         assert_eq!(htlc_pair.0.input.len(), 1);
1505         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1506         check_spends!(htlc_pair.0, remote_txn[0]);
1507         assert_eq!(htlc_pair.1.input.len(), 1);
1508         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1509         check_spends!(htlc_pair.1, remote_txn[0]);
1510
1511         let events = nodes[0].node.get_and_clear_pending_msg_events();
1512         assert_eq!(events.len(), 3);
1513         for e in events {
1514                 match e {
1515                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1516                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1517                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1518                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1519                         },
1520                         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, .. } } => {
1521                                 assert!(update_add_htlcs.is_empty());
1522                                 assert!(update_fail_htlcs.is_empty());
1523                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1524                                 assert!(update_fail_malformed_htlcs.is_empty());
1525                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1526                         },
1527                         _ => panic!("Unexpected event"),
1528                 }
1529         }
1530 }
1531
1532 #[test]
1533 fn test_basic_channel_reserve() {
1534         let chanmon_cfgs = create_chanmon_cfgs(2);
1535         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1536         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1537         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1538         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1539         let logger = test_utils::TestLogger::new();
1540
1541         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1542         let channel_reserve = chan_stat.channel_reserve_msat;
1543
1544         // The 2* and +1 are for the fee spike reserve.
1545         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1546         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1547         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1548         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1549         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1550         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1551         match err {
1552                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1553                         match &fails[0] {
1554                                 &APIError::ChannelUnavailable{ref err} =>
1555                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1556                                 _ => panic!("Unexpected error variant"),
1557                         }
1558                 },
1559                 _ => panic!("Unexpected error variant"),
1560         }
1561         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1562         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);
1563
1564         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1565 }
1566
1567 #[test]
1568 fn test_fee_spike_violation_fails_htlc() {
1569         let chanmon_cfgs = create_chanmon_cfgs(2);
1570         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1572         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1573         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1574
1575         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1576         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1577         let secp_ctx = Secp256k1::new();
1578         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1579
1580         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1581
1582         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1583         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1584         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1585         let msg = msgs::UpdateAddHTLC {
1586                 channel_id: chan.2,
1587                 htlc_id: 0,
1588                 amount_msat: htlc_msat,
1589                 payment_hash: payment_hash,
1590                 cltv_expiry: htlc_cltv,
1591                 onion_routing_packet: onion_packet,
1592         };
1593
1594         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1595
1596         // Now manually create the commitment_signed message corresponding to the update_add
1597         // nodes[0] just sent. In the code for construction of this message, "local" refers
1598         // to the sender of the message, and "remote" refers to the receiver.
1599
1600         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1601
1602         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1603
1604         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1605         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1606         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1607                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1608                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1609                 let chan_signer = local_chan.get_signer();
1610                 let pubkeys = chan_signer.pubkeys();
1611                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1612                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1613                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1614         };
1615         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1616                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1617                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1618                 let chan_signer = remote_chan.get_signer();
1619                 let pubkeys = chan_signer.pubkeys();
1620                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1621                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1622         };
1623
1624         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1625         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1626                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1627
1628         // Build the remote commitment transaction so we can sign it, and then later use the
1629         // signature for the commitment_signed message.
1630         let local_chan_balance = 1313;
1631
1632         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1633                 offered: false,
1634                 amount_msat: 3460001,
1635                 cltv_expiry: htlc_cltv,
1636                 payment_hash,
1637                 transaction_output_index: Some(1),
1638         };
1639
1640         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1641
1642         let res = {
1643                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1644                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1645                 let local_chan_signer = local_chan.get_signer();
1646                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1647                         commitment_number,
1648                         95000,
1649                         local_chan_balance,
1650                         commit_tx_keys.clone(),
1651                         feerate_per_kw,
1652                         &mut vec![(accepted_htlc_info, ())],
1653                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1654                 );
1655                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1656         };
1657
1658         let commit_signed_msg = msgs::CommitmentSigned {
1659                 channel_id: chan.2,
1660                 signature: res.0,
1661                 htlc_signatures: res.1
1662         };
1663
1664         // Send the commitment_signed message to the nodes[1].
1665         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1666         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1667
1668         // Send the RAA to nodes[1].
1669         let raa_msg = msgs::RevokeAndACK {
1670                 channel_id: chan.2,
1671                 per_commitment_secret: local_secret,
1672                 next_per_commitment_point: next_local_point
1673         };
1674         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1675
1676         let events = nodes[1].node.get_and_clear_pending_msg_events();
1677         assert_eq!(events.len(), 1);
1678         // Make sure the HTLC failed in the way we expect.
1679         match events[0] {
1680                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1681                         assert_eq!(update_fail_htlcs.len(), 1);
1682                         update_fail_htlcs[0].clone()
1683                 },
1684                 _ => panic!("Unexpected event"),
1685         };
1686         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1687
1688         check_added_monitors!(nodes[1], 2);
1689 }
1690
1691 #[test]
1692 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1693         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1694         // Set the fee rate for the channel very high, to the point where the fundee
1695         // sending any above-dust amount would result in a channel reserve violation.
1696         // In this test we check that we would be prevented from sending an HTLC in
1697         // this situation.
1698         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1699         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1700         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1701         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1702         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1703         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1704
1705         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1706         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1707                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1708         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1709         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);
1710 }
1711
1712 #[test]
1713 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1714         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1715         // Set the fee rate for the channel very high, to the point where the funder
1716         // receiving 1 update_add_htlc would result in them closing the channel due
1717         // to channel reserve violation. This close could also happen if the fee went
1718         // up a more realistic amount, but many HTLCs were outstanding at the time of
1719         // the update_add_htlc.
1720         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1721         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1722         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1723         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1724         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1725         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1726
1727         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1728         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1729         let secp_ctx = Secp256k1::new();
1730         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1731         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1732         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1733         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1734         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1735         let msg = msgs::UpdateAddHTLC {
1736                 channel_id: chan.2,
1737                 htlc_id: 1,
1738                 amount_msat: htlc_msat + 1,
1739                 payment_hash: payment_hash,
1740                 cltv_expiry: htlc_cltv,
1741                 onion_routing_packet: onion_packet,
1742         };
1743
1744         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1745         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1746         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);
1747         assert_eq!(nodes[0].node.list_channels().len(), 0);
1748         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1749         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1750         check_added_monitors!(nodes[0], 1);
1751 }
1752
1753 #[test]
1754 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1755         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1756         // calculating our commitment transaction fee (this was previously broken).
1757         let chanmon_cfgs = create_chanmon_cfgs(2);
1758         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1759         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1760         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1761
1762         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1763         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1764         // transaction fee with 0 HTLCs (183 sats)).
1765         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1766
1767         let dust_amt = 329000; // Dust amount
1768         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1769         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1770         // commitment transaction fee.
1771         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1772 }
1773
1774 #[test]
1775 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1776         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1777         // calculating our counterparty's commitment transaction fee (this was previously broken).
1778         let chanmon_cfgs = create_chanmon_cfgs(2);
1779         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1780         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1781         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1782         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1783
1784         let payment_amt = 46000; // Dust amount
1785         // In the previous code, these first four payments would succeed.
1786         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1787         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1788         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1789         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1790
1791         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1792         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1795         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1797
1798         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1799         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1800         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1801         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1802 }
1803
1804 #[test]
1805 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1806         let chanmon_cfgs = create_chanmon_cfgs(3);
1807         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1808         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1809         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1810         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1811         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1812
1813         let feemsat = 239;
1814         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1815         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1816         let feerate = get_feerate!(nodes[0], chan.2);
1817
1818         // Add a 2* and +1 for the fee spike reserve.
1819         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1820         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;
1821         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1822
1823         // Add a pending HTLC.
1824         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1825         let payment_event_1 = {
1826                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1827                 check_added_monitors!(nodes[0], 1);
1828
1829                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1830                 assert_eq!(events.len(), 1);
1831                 SendEvent::from_event(events.remove(0))
1832         };
1833         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1834
1835         // Attempt to trigger a channel reserve violation --> payment failure.
1836         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1837         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;
1838         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1839         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1840
1841         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1842         let secp_ctx = Secp256k1::new();
1843         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1844         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1845         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1846         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1847         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1848         let msg = msgs::UpdateAddHTLC {
1849                 channel_id: chan.2,
1850                 htlc_id: 1,
1851                 amount_msat: htlc_msat + 1,
1852                 payment_hash: our_payment_hash_1,
1853                 cltv_expiry: htlc_cltv,
1854                 onion_routing_packet: onion_packet,
1855         };
1856
1857         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1858         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1859         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1860         assert_eq!(nodes[1].node.list_channels().len(), 1);
1861         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1862         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1863         check_added_monitors!(nodes[1], 1);
1864 }
1865
1866 #[test]
1867 fn test_inbound_outbound_capacity_is_not_zero() {
1868         let chanmon_cfgs = create_chanmon_cfgs(2);
1869         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1870         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1871         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1872         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1873         let channels0 = node_chanmgrs[0].list_channels();
1874         let channels1 = node_chanmgrs[1].list_channels();
1875         assert_eq!(channels0.len(), 1);
1876         assert_eq!(channels1.len(), 1);
1877
1878         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1879         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1880
1881         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1882         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1883 }
1884
1885 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1886         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1887 }
1888
1889 #[test]
1890 fn test_channel_reserve_holding_cell_htlcs() {
1891         let chanmon_cfgs = create_chanmon_cfgs(3);
1892         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1893         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1894         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1895         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1896         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1897
1898         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1899         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1900
1901         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1902         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1903
1904         macro_rules! expect_forward {
1905                 ($node: expr) => {{
1906                         let mut events = $node.node.get_and_clear_pending_msg_events();
1907                         assert_eq!(events.len(), 1);
1908                         check_added_monitors!($node, 1);
1909                         let payment_event = SendEvent::from_event(events.remove(0));
1910                         payment_event
1911                 }}
1912         }
1913
1914         let feemsat = 239; // somehow we know?
1915         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1916         let feerate = get_feerate!(nodes[0], chan_1.2);
1917
1918         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1919
1920         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1921         {
1922                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1923                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1924                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1925                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1926                         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)));
1927                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1928                 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);
1929         }
1930
1931         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1932         // nodes[0]'s wealth
1933         loop {
1934                 let amt_msat = recv_value_0 + total_fee_msat;
1935                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1936                 // Also, ensure that each payment has enough to be over the dust limit to
1937                 // ensure it'll be included in each commit tx fee calculation.
1938                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1939                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1940                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1941                         break;
1942                 }
1943                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1944
1945                 let (stat01_, stat11_, stat12_, stat22_) = (
1946                         get_channel_value_stat!(nodes[0], chan_1.2),
1947                         get_channel_value_stat!(nodes[1], chan_1.2),
1948                         get_channel_value_stat!(nodes[1], chan_2.2),
1949                         get_channel_value_stat!(nodes[2], chan_2.2),
1950                 );
1951
1952                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1953                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1954                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1955                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1956                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1957         }
1958
1959         // adding pending output.
1960         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1961         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1962         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1963         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1964         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1965         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1966         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1967         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1968         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1969         // policy.
1970         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1971         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1972         let amt_msat_1 = recv_value_1 + total_fee_msat;
1973
1974         let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1975         let payment_event_1 = {
1976                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1977                 check_added_monitors!(nodes[0], 1);
1978
1979                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1980                 assert_eq!(events.len(), 1);
1981                 SendEvent::from_event(events.remove(0))
1982         };
1983         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1984
1985         // channel reserve test with htlc pending output > 0
1986         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1987         {
1988                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1989                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1990                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1991                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1992         }
1993
1994         // split the rest to test holding cell
1995         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1996         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1997         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1998         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1999         {
2000                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2001                 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);
2002         }
2003
2004         // now see if they go through on both sides
2005         let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
2006         // but this will stuck in the holding cell
2007         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2008         check_added_monitors!(nodes[0], 0);
2009         let events = nodes[0].node.get_and_clear_pending_events();
2010         assert_eq!(events.len(), 0);
2011
2012         // test with outbound holding cell amount > 0
2013         {
2014                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2015                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2016                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2017                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2018                 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);
2019         }
2020
2021         let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
2022         // this will also stuck in the holding cell
2023         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2024         check_added_monitors!(nodes[0], 0);
2025         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2026         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2027
2028         // flush the pending htlc
2029         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2030         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2031         check_added_monitors!(nodes[1], 1);
2032
2033         // the pending htlc should be promoted to committed
2034         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2035         check_added_monitors!(nodes[0], 1);
2036         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2037
2038         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2039         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2040         // No commitment_signed so get_event_msg's assert(len == 1) passes
2041         check_added_monitors!(nodes[0], 1);
2042
2043         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2044         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2045         check_added_monitors!(nodes[1], 1);
2046
2047         expect_pending_htlcs_forwardable!(nodes[1]);
2048
2049         let ref payment_event_11 = expect_forward!(nodes[1]);
2050         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2051         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2052
2053         expect_pending_htlcs_forwardable!(nodes[2]);
2054         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2055
2056         // flush the htlcs in the holding cell
2057         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2058         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2059         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2060         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2061         expect_pending_htlcs_forwardable!(nodes[1]);
2062
2063         let ref payment_event_3 = expect_forward!(nodes[1]);
2064         assert_eq!(payment_event_3.msgs.len(), 2);
2065         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2066         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2067
2068         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2069         expect_pending_htlcs_forwardable!(nodes[2]);
2070
2071         let events = nodes[2].node.get_and_clear_pending_events();
2072         assert_eq!(events.len(), 2);
2073         match events[0] {
2074                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2075                         assert_eq!(our_payment_hash_21, *payment_hash);
2076                         assert!(payment_preimage.is_none());
2077                         assert_eq!(our_payment_secret_21, *payment_secret);
2078                         assert_eq!(recv_value_21, amt);
2079                 },
2080                 _ => panic!("Unexpected event"),
2081         }
2082         match events[1] {
2083                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2084                         assert_eq!(our_payment_hash_22, *payment_hash);
2085                         assert!(payment_preimage.is_none());
2086                         assert_eq!(our_payment_secret_22, *payment_secret);
2087                         assert_eq!(recv_value_22, amt);
2088                 },
2089                 _ => panic!("Unexpected event"),
2090         }
2091
2092         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2093         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2094         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2095
2096         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2097         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2098         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2099
2100         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2101         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);
2102         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2103         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2104         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2105
2106         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2107         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2108 }
2109
2110 #[test]
2111 fn channel_reserve_in_flight_removes() {
2112         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2113         // can send to its counterparty, but due to update ordering, the other side may not yet have
2114         // considered those HTLCs fully removed.
2115         // This tests that we don't count HTLCs which will not be included in the next remote
2116         // commitment transaction towards the reserve value (as it implies no commitment transaction
2117         // will be generated which violates the remote reserve value).
2118         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2119         // To test this we:
2120         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2121         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2122         //    you only consider the value of the first HTLC, it may not),
2123         //  * start routing a third HTLC from A to B,
2124         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2125         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2126         //  * deliver the first fulfill from B
2127         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2128         //    claim,
2129         //  * deliver A's response CS and RAA.
2130         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2131         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2132         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2133         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2134         let chanmon_cfgs = create_chanmon_cfgs(2);
2135         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2136         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2137         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2138         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2139         let logger = test_utils::TestLogger::new();
2140
2141         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2142         // Route the first two HTLCs.
2143         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2144         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2145
2146         // Start routing the third HTLC (this is just used to get everyone in the right state).
2147         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2148         let send_1 = {
2149                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2150                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2151                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2152                 check_added_monitors!(nodes[0], 1);
2153                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2154                 assert_eq!(events.len(), 1);
2155                 SendEvent::from_event(events.remove(0))
2156         };
2157
2158         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2159         // initial fulfill/CS.
2160         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2161         check_added_monitors!(nodes[1], 1);
2162         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2163
2164         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2165         // remove the second HTLC when we send the HTLC back from B to A.
2166         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2167         check_added_monitors!(nodes[1], 1);
2168         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2169
2170         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2171         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2172         check_added_monitors!(nodes[0], 1);
2173         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2174         expect_payment_sent!(nodes[0], payment_preimage_1);
2175
2176         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2177         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2178         check_added_monitors!(nodes[1], 1);
2179         // B is already AwaitingRAA, so cant generate a CS here
2180         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2181
2182         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2183         check_added_monitors!(nodes[1], 1);
2184         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2185
2186         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2187         check_added_monitors!(nodes[0], 1);
2188         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2189
2190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2191         check_added_monitors!(nodes[1], 1);
2192         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2193
2194         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2195         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2196         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2197         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2198         // on-chain as necessary).
2199         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2200         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2201         check_added_monitors!(nodes[0], 1);
2202         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2203         expect_payment_sent!(nodes[0], payment_preimage_2);
2204
2205         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2206         check_added_monitors!(nodes[1], 1);
2207         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2208
2209         expect_pending_htlcs_forwardable!(nodes[1]);
2210         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2211
2212         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2213         // resolve the second HTLC from A's point of view.
2214         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2215         check_added_monitors!(nodes[0], 1);
2216         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2217
2218         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2219         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2220         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2221         let send_2 = {
2222                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2223                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2224                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2225                 check_added_monitors!(nodes[1], 1);
2226                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2227                 assert_eq!(events.len(), 1);
2228                 SendEvent::from_event(events.remove(0))
2229         };
2230
2231         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2232         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2233         check_added_monitors!(nodes[0], 1);
2234         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2235
2236         // Now just resolve all the outstanding messages/HTLCs for completeness...
2237
2238         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2239         check_added_monitors!(nodes[1], 1);
2240         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2241
2242         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2243         check_added_monitors!(nodes[1], 1);
2244
2245         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2246         check_added_monitors!(nodes[0], 1);
2247         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2248
2249         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2250         check_added_monitors!(nodes[1], 1);
2251         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2252
2253         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2254         check_added_monitors!(nodes[0], 1);
2255
2256         expect_pending_htlcs_forwardable!(nodes[0]);
2257         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2258
2259         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2260         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2261 }
2262
2263 #[test]
2264 fn channel_monitor_network_test() {
2265         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2266         // tests that ChannelMonitor is able to recover from various states.
2267         let chanmon_cfgs = create_chanmon_cfgs(5);
2268         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2269         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2270         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2271
2272         // Create some initial channels
2273         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2274         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2275         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2276         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2277
2278         // Make sure all nodes are at the same starting height
2279         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2280         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2281         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2282         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2283         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2284
2285         // Rebalance the network a bit by relaying one payment through all the channels...
2286         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2287         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2288         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2289         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2290
2291         // Simple case with no pending HTLCs:
2292         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2293         check_added_monitors!(nodes[1], 1);
2294         check_closed_broadcast!(nodes[1], false);
2295         {
2296                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2297                 assert_eq!(node_txn.len(), 1);
2298                 mine_transaction(&nodes[0], &node_txn[0]);
2299                 check_added_monitors!(nodes[0], 1);
2300                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2301         }
2302         check_closed_broadcast!(nodes[0], true);
2303         assert_eq!(nodes[0].node.list_channels().len(), 0);
2304         assert_eq!(nodes[1].node.list_channels().len(), 1);
2305
2306         // One pending HTLC is discarded by the force-close:
2307         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2308
2309         // Simple case of one pending HTLC to HTLC-Timeout
2310         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2311         check_closed_broadcast!(nodes[1], false);
2312         check_added_monitors!(nodes[1], 1);
2313         {
2314                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2315                 mine_transaction(&nodes[2], &node_txn[0]);
2316                 check_added_monitors!(nodes[2], 1);
2317                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2318         }
2319         check_closed_broadcast!(nodes[2], true);
2320         assert_eq!(nodes[1].node.list_channels().len(), 0);
2321         assert_eq!(nodes[2].node.list_channels().len(), 1);
2322
2323         macro_rules! claim_funds {
2324                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2325                         {
2326                                 assert!($node.node.claim_funds($preimage));
2327                                 check_added_monitors!($node, 1);
2328
2329                                 let events = $node.node.get_and_clear_pending_msg_events();
2330                                 assert_eq!(events.len(), 1);
2331                                 match events[0] {
2332                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2333                                                 assert!(update_add_htlcs.is_empty());
2334                                                 assert!(update_fail_htlcs.is_empty());
2335                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2336                                         },
2337                                         _ => panic!("Unexpected event"),
2338                                 };
2339                         }
2340                 }
2341         }
2342
2343         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2344         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2345         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2346         check_added_monitors!(nodes[2], 1);
2347         check_closed_broadcast!(nodes[2], false);
2348         let node2_commitment_txid;
2349         {
2350                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2351                 node2_commitment_txid = node_txn[0].txid();
2352
2353                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2354                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2355                 mine_transaction(&nodes[3], &node_txn[0]);
2356                 check_added_monitors!(nodes[3], 1);
2357                 check_preimage_claim(&nodes[3], &node_txn);
2358         }
2359         check_closed_broadcast!(nodes[3], true);
2360         assert_eq!(nodes[2].node.list_channels().len(), 0);
2361         assert_eq!(nodes[3].node.list_channels().len(), 1);
2362
2363         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2364         // confusing us in the following tests.
2365         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2366
2367         // One pending HTLC to time out:
2368         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2369         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2370         // buffer space).
2371
2372         let (close_chan_update_1, close_chan_update_2) = {
2373                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2374                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2375                 assert_eq!(events.len(), 2);
2376                 let close_chan_update_1 = match events[0] {
2377                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2378                                 msg.clone()
2379                         },
2380                         _ => panic!("Unexpected event"),
2381                 };
2382                 match events[1] {
2383                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2384                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2385                         },
2386                         _ => panic!("Unexpected event"),
2387                 }
2388                 check_added_monitors!(nodes[3], 1);
2389
2390                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2391                 {
2392                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2393                         node_txn.retain(|tx| {
2394                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2395                                         false
2396                                 } else { true }
2397                         });
2398                 }
2399
2400                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2401
2402                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2403                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2404
2405                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2406                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2407                 assert_eq!(events.len(), 2);
2408                 let close_chan_update_2 = match events[0] {
2409                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2410                                 msg.clone()
2411                         },
2412                         _ => panic!("Unexpected event"),
2413                 };
2414                 match events[1] {
2415                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2416                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2417                         },
2418                         _ => panic!("Unexpected event"),
2419                 }
2420                 check_added_monitors!(nodes[4], 1);
2421                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2422
2423                 mine_transaction(&nodes[4], &node_txn[0]);
2424                 check_preimage_claim(&nodes[4], &node_txn);
2425                 (close_chan_update_1, close_chan_update_2)
2426         };
2427         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2428         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2429         assert_eq!(nodes[3].node.list_channels().len(), 0);
2430         assert_eq!(nodes[4].node.list_channels().len(), 0);
2431
2432         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2433 }
2434
2435 #[test]
2436 fn test_justice_tx() {
2437         // Test justice txn built on revoked HTLC-Success tx, against both sides
2438         let mut alice_config = UserConfig::default();
2439         alice_config.channel_options.announced_channel = true;
2440         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2441         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2442         let mut bob_config = UserConfig::default();
2443         bob_config.channel_options.announced_channel = true;
2444         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2445         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2446         let user_cfgs = [Some(alice_config), Some(bob_config)];
2447         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2448         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2449         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2450         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2451         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2452         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2453         // Create some new channels:
2454         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2455
2456         // A pending HTLC which will be revoked:
2457         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2458         // Get the will-be-revoked local txn from nodes[0]
2459         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2460         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2461         assert_eq!(revoked_local_txn[0].input.len(), 1);
2462         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2463         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2464         assert_eq!(revoked_local_txn[1].input.len(), 1);
2465         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2466         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2467         // Revoke the old state
2468         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2469
2470         {
2471                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2472                 {
2473                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2474                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2475                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2476
2477                         check_spends!(node_txn[0], revoked_local_txn[0]);
2478                         node_txn.swap_remove(0);
2479                         node_txn.truncate(1);
2480                 }
2481                 check_added_monitors!(nodes[1], 1);
2482                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2483
2484                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2485                 // Verify broadcast of revoked HTLC-timeout
2486                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2487                 check_added_monitors!(nodes[0], 1);
2488                 // Broadcast revoked HTLC-timeout on node 1
2489                 mine_transaction(&nodes[1], &node_txn[1]);
2490                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2491         }
2492         get_announce_close_broadcast_events(&nodes, 0, 1);
2493
2494         assert_eq!(nodes[0].node.list_channels().len(), 0);
2495         assert_eq!(nodes[1].node.list_channels().len(), 0);
2496
2497         // We test justice_tx build by A on B's revoked HTLC-Success tx
2498         // Create some new channels:
2499         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2500         {
2501                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2502                 node_txn.clear();
2503         }
2504
2505         // A pending HTLC which will be revoked:
2506         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2507         // Get the will-be-revoked local txn from B
2508         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2509         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2510         assert_eq!(revoked_local_txn[0].input.len(), 1);
2511         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2512         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2513         // Revoke the old state
2514         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2515         {
2516                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2517                 {
2518                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2519                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2520                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2521
2522                         check_spends!(node_txn[0], revoked_local_txn[0]);
2523                         node_txn.swap_remove(0);
2524                 }
2525                 check_added_monitors!(nodes[0], 1);
2526                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2527
2528                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2529                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2530                 check_added_monitors!(nodes[1], 1);
2531                 mine_transaction(&nodes[0], &node_txn[1]);
2532                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2533         }
2534         get_announce_close_broadcast_events(&nodes, 0, 1);
2535         assert_eq!(nodes[0].node.list_channels().len(), 0);
2536         assert_eq!(nodes[1].node.list_channels().len(), 0);
2537 }
2538
2539 #[test]
2540 fn revoked_output_claim() {
2541         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2542         // transaction is broadcast by its counterparty
2543         let chanmon_cfgs = create_chanmon_cfgs(2);
2544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2546         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2547         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2548         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2549         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2550         assert_eq!(revoked_local_txn.len(), 1);
2551         // Only output is the full channel value back to nodes[0]:
2552         assert_eq!(revoked_local_txn[0].output.len(), 1);
2553         // Send a payment through, updating everyone's latest commitment txn
2554         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2555
2556         // Inform nodes[1] that nodes[0] broadcast a stale tx
2557         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2558         check_added_monitors!(nodes[1], 1);
2559         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2560         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2561
2562         check_spends!(node_txn[0], revoked_local_txn[0]);
2563         check_spends!(node_txn[1], chan_1.3);
2564
2565         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2566         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2567         get_announce_close_broadcast_events(&nodes, 0, 1);
2568         check_added_monitors!(nodes[0], 1)
2569 }
2570
2571 #[test]
2572 fn claim_htlc_outputs_shared_tx() {
2573         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2574         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2575         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2576         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2577         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2578         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2579
2580         // Create some new channel:
2581         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2582
2583         // Rebalance the network to generate htlc in the two directions
2584         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2585         // 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
2586         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2587         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2588
2589         // Get the will-be-revoked local txn from node[0]
2590         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2591         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2592         assert_eq!(revoked_local_txn[0].input.len(), 1);
2593         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2594         assert_eq!(revoked_local_txn[1].input.len(), 1);
2595         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2596         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2597         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2598
2599         //Revoke the old state
2600         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2601
2602         {
2603                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2604                 check_added_monitors!(nodes[0], 1);
2605                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2606                 check_added_monitors!(nodes[1], 1);
2607                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2608                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2609
2610                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2611                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2612
2613                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2614                 check_spends!(node_txn[0], revoked_local_txn[0]);
2615
2616                 let mut witness_lens = BTreeSet::new();
2617                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2618                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2619                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2620                 assert_eq!(witness_lens.len(), 3);
2621                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2622                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2623                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2624
2625                 // Next nodes[1] broadcasts its current local tx state:
2626                 assert_eq!(node_txn[1].input.len(), 1);
2627                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2628
2629                 assert_eq!(node_txn[2].input.len(), 1);
2630                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2631                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2632                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2633                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2634                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2635         }
2636         get_announce_close_broadcast_events(&nodes, 0, 1);
2637         assert_eq!(nodes[0].node.list_channels().len(), 0);
2638         assert_eq!(nodes[1].node.list_channels().len(), 0);
2639 }
2640
2641 #[test]
2642 fn claim_htlc_outputs_single_tx() {
2643         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2644         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2645         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2648         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2649
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);
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, but this
2655         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2656         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2657         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2658
2659         // Get the will-be-revoked local txn from node[0]
2660         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2661
2662         //Revoke the old state
2663         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2664
2665         {
2666                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2667                 check_added_monitors!(nodes[0], 1);
2668                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2669                 check_added_monitors!(nodes[1], 1);
2670                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2671
2672                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2673                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2674
2675                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2676                 assert_eq!(node_txn.len(), 9);
2677                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2678                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2679                 // 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)
2680                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2681
2682                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2683                 assert_eq!(node_txn[0].input.len(), 1);
2684                 check_spends!(node_txn[0], chan_1.3);
2685                 assert_eq!(node_txn[1].input.len(), 1);
2686                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2687                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2688                 check_spends!(node_txn[1], node_txn[0]);
2689
2690                 // Justice transactions are indices 1-2-4
2691                 assert_eq!(node_txn[2].input.len(), 1);
2692                 assert_eq!(node_txn[3].input.len(), 1);
2693                 assert_eq!(node_txn[4].input.len(), 1);
2694
2695                 check_spends!(node_txn[2], revoked_local_txn[0]);
2696                 check_spends!(node_txn[3], revoked_local_txn[0]);
2697                 check_spends!(node_txn[4], revoked_local_txn[0]);
2698
2699                 let mut witness_lens = BTreeSet::new();
2700                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2701                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2702                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2703                 assert_eq!(witness_lens.len(), 3);
2704                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2705                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2706                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2707         }
2708         get_announce_close_broadcast_events(&nodes, 0, 1);
2709         assert_eq!(nodes[0].node.list_channels().len(), 0);
2710         assert_eq!(nodes[1].node.list_channels().len(), 0);
2711 }
2712
2713 #[test]
2714 fn test_htlc_on_chain_success() {
2715         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2716         // the preimage backward accordingly. So here we test that ChannelManager is
2717         // broadcasting the right event to other nodes in payment path.
2718         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2719         // A --------------------> B ----------------------> C (preimage)
2720         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2721         // commitment transaction was broadcast.
2722         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2723         // towards B.
2724         // B should be able to claim via preimage if A then broadcasts its local tx.
2725         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2726         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2727         // PaymentSent event).
2728
2729         let chanmon_cfgs = create_chanmon_cfgs(3);
2730         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2731         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2732         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2733
2734         // Create some initial channels
2735         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2736         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2737
2738         // Rebalance the network a bit by relaying one payment through all the channels...
2739         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2740         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2741
2742         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2743         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2744
2745         // Broadcast legit commitment tx from C on B's chain
2746         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2747         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2748         assert_eq!(commitment_tx.len(), 1);
2749         check_spends!(commitment_tx[0], chan_2.3);
2750         nodes[2].node.claim_funds(our_payment_preimage);
2751         nodes[2].node.claim_funds(our_payment_preimage_2);
2752         check_added_monitors!(nodes[2], 2);
2753         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2754         assert!(updates.update_add_htlcs.is_empty());
2755         assert!(updates.update_fail_htlcs.is_empty());
2756         assert!(updates.update_fail_malformed_htlcs.is_empty());
2757         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2758
2759         mine_transaction(&nodes[2], &commitment_tx[0]);
2760         check_closed_broadcast!(nodes[2], true);
2761         check_added_monitors!(nodes[2], 1);
2762         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)
2763         assert_eq!(node_txn.len(), 5);
2764         assert_eq!(node_txn[0], node_txn[3]);
2765         assert_eq!(node_txn[1], node_txn[4]);
2766         assert_eq!(node_txn[2], commitment_tx[0]);
2767         check_spends!(node_txn[0], commitment_tx[0]);
2768         check_spends!(node_txn[1], commitment_tx[0]);
2769         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2770         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2771         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2772         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2773         assert_eq!(node_txn[0].lock_time, 0);
2774         assert_eq!(node_txn[1].lock_time, 0);
2775
2776         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2777         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2778         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2779         {
2780                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2781                 assert_eq!(added_monitors.len(), 1);
2782                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2783                 added_monitors.clear();
2784         }
2785         let events = nodes[1].node.get_and_clear_pending_msg_events();
2786         {
2787                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2788                 assert_eq!(added_monitors.len(), 2);
2789                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2790                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2791                 added_monitors.clear();
2792         }
2793         assert_eq!(events.len(), 3);
2794         match events[0] {
2795                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2796                 _ => panic!("Unexpected event"),
2797         }
2798         match events[1] {
2799                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2800                 _ => panic!("Unexpected event"),
2801         }
2802
2803         match events[2] {
2804                 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, .. } } => {
2805                         assert!(update_add_htlcs.is_empty());
2806                         assert!(update_fail_htlcs.is_empty());
2807                         assert_eq!(update_fulfill_htlcs.len(), 1);
2808                         assert!(update_fail_malformed_htlcs.is_empty());
2809                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2810                 },
2811                 _ => panic!("Unexpected event"),
2812         };
2813         macro_rules! check_tx_local_broadcast {
2814                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2815                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2816                         assert_eq!(node_txn.len(), 5);
2817                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2818                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2819                         check_spends!(node_txn[0], $commitment_tx);
2820                         check_spends!(node_txn[1], $commitment_tx);
2821                         assert_ne!(node_txn[0].lock_time, 0);
2822                         assert_ne!(node_txn[1].lock_time, 0);
2823                         if $htlc_offered {
2824                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2825                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2826                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2827                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2828                         } else {
2829                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2830                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2831                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2832                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2833                         }
2834                         check_spends!(node_txn[2], $chan_tx);
2835                         check_spends!(node_txn[3], node_txn[2]);
2836                         check_spends!(node_txn[4], node_txn[2]);
2837                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2838                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2839                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2840                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2841                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2842                         assert_ne!(node_txn[3].lock_time, 0);
2843                         assert_ne!(node_txn[4].lock_time, 0);
2844                         node_txn.clear();
2845                 } }
2846         }
2847         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2848         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2849         // timeout-claim of the output that nodes[2] just claimed via success.
2850         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2851
2852         // Broadcast legit commitment tx from A on B's chain
2853         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2854         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2855         check_spends!(commitment_tx[0], chan_1.3);
2856         mine_transaction(&nodes[1], &commitment_tx[0]);
2857         check_closed_broadcast!(nodes[1], true);
2858         check_added_monitors!(nodes[1], 1);
2859         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2860         assert_eq!(node_txn.len(), 4);
2861         check_spends!(node_txn[0], commitment_tx[0]);
2862         assert_eq!(node_txn[0].input.len(), 2);
2863         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2864         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2865         assert_eq!(node_txn[0].lock_time, 0);
2866         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2867         check_spends!(node_txn[1], chan_1.3);
2868         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2869         check_spends!(node_txn[2], node_txn[1]);
2870         check_spends!(node_txn[3], node_txn[1]);
2871         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2872         // we already checked the same situation with A.
2873
2874         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2875         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2876         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2877         check_closed_broadcast!(nodes[0], true);
2878         check_added_monitors!(nodes[0], 1);
2879         let events = nodes[0].node.get_and_clear_pending_events();
2880         assert_eq!(events.len(), 2);
2881         let mut first_claimed = false;
2882         for event in events {
2883                 match event {
2884                         Event::PaymentSent { payment_preimage } => {
2885                                 if payment_preimage == our_payment_preimage {
2886                                         assert!(!first_claimed);
2887                                         first_claimed = true;
2888                                 } else {
2889                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2890                                 }
2891                         },
2892                         _ => panic!("Unexpected event"),
2893                 }
2894         }
2895         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2896 }
2897
2898 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2899         // Test that in case of a unilateral close onchain, we detect the state of output and
2900         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2901         // broadcasting the right event to other nodes in payment path.
2902         // A ------------------> B ----------------------> C (timeout)
2903         //    B's commitment tx                 C's commitment tx
2904         //            \                                  \
2905         //         B's HTLC timeout tx               B's timeout tx
2906
2907         let chanmon_cfgs = create_chanmon_cfgs(3);
2908         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2909         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2910         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2911         *nodes[0].connect_style.borrow_mut() = connect_style;
2912         *nodes[1].connect_style.borrow_mut() = connect_style;
2913         *nodes[2].connect_style.borrow_mut() = connect_style;
2914
2915         // Create some intial channels
2916         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2917         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2918
2919         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2920         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2921         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2922
2923         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2924
2925         // Broadcast legit commitment tx from C on B's chain
2926         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2927         check_spends!(commitment_tx[0], chan_2.3);
2928         nodes[2].node.fail_htlc_backwards(&payment_hash);
2929         check_added_monitors!(nodes[2], 0);
2930         expect_pending_htlcs_forwardable!(nodes[2]);
2931         check_added_monitors!(nodes[2], 1);
2932
2933         let events = nodes[2].node.get_and_clear_pending_msg_events();
2934         assert_eq!(events.len(), 1);
2935         match events[0] {
2936                 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, .. } } => {
2937                         assert!(update_add_htlcs.is_empty());
2938                         assert!(!update_fail_htlcs.is_empty());
2939                         assert!(update_fulfill_htlcs.is_empty());
2940                         assert!(update_fail_malformed_htlcs.is_empty());
2941                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2942                 },
2943                 _ => panic!("Unexpected event"),
2944         };
2945         mine_transaction(&nodes[2], &commitment_tx[0]);
2946         check_closed_broadcast!(nodes[2], true);
2947         check_added_monitors!(nodes[2], 1);
2948         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2949         assert_eq!(node_txn.len(), 1);
2950         check_spends!(node_txn[0], chan_2.3);
2951         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2952
2953         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2954         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2955         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2956         mine_transaction(&nodes[1], &commitment_tx[0]);
2957         let timeout_tx;
2958         {
2959                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2960                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2961                 assert_eq!(node_txn[0], node_txn[3]);
2962                 assert_eq!(node_txn[1], node_txn[4]);
2963
2964                 check_spends!(node_txn[2], commitment_tx[0]);
2965                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2966
2967                 check_spends!(node_txn[0], chan_2.3);
2968                 check_spends!(node_txn[1], node_txn[0]);
2969                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2970                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2971
2972                 timeout_tx = node_txn[2].clone();
2973                 node_txn.clear();
2974         }
2975
2976         mine_transaction(&nodes[1], &timeout_tx);
2977         check_added_monitors!(nodes[1], 1);
2978         check_closed_broadcast!(nodes[1], true);
2979         {
2980                 // B will rebroadcast a fee-bumped timeout transaction here.
2981                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2982                 assert_eq!(node_txn.len(), 1);
2983                 check_spends!(node_txn[0], commitment_tx[0]);
2984         }
2985
2986         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2987         {
2988                 // B will rebroadcast its own holder commitment transaction here...just because
2989                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2990                 assert_eq!(node_txn.len(), 1);
2991                 check_spends!(node_txn[0], chan_2.3);
2992         }
2993
2994         expect_pending_htlcs_forwardable!(nodes[1]);
2995         check_added_monitors!(nodes[1], 1);
2996         let events = nodes[1].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_fail_htlcs, ref update_fulfill_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[0].node.get_our_node_id(), *node_id);
3005                 },
3006                 _ => panic!("Unexpected event"),
3007         };
3008
3009         // Broadcast legit commitment tx from B on A's chain
3010         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3011         check_spends!(commitment_tx[0], chan_1.3);
3012
3013         mine_transaction(&nodes[0], &commitment_tx[0]);
3014
3015         check_closed_broadcast!(nodes[0], true);
3016         check_added_monitors!(nodes[0], 1);
3017         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3018         assert_eq!(node_txn.len(), 3);
3019         check_spends!(node_txn[0], commitment_tx[0]);
3020         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3021         check_spends!(node_txn[1], chan_1.3);
3022         check_spends!(node_txn[2], node_txn[1]);
3023         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3024         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3025 }
3026
3027 #[test]
3028 fn test_htlc_on_chain_timeout() {
3029         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3030         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3031         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3032 }
3033
3034 #[test]
3035 fn test_simple_commitment_revoked_fail_backward() {
3036         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3037         // and fail backward accordingly.
3038
3039         let chanmon_cfgs = create_chanmon_cfgs(3);
3040         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3041         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3042         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3043
3044         // Create some initial channels
3045         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3046         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3047
3048         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3049         // Get the will-be-revoked local txn from nodes[2]
3050         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3051         // Revoke the old state
3052         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3053
3054         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3055
3056         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3057         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3058         check_added_monitors!(nodes[1], 1);
3059         check_closed_broadcast!(nodes[1], true);
3060
3061         expect_pending_htlcs_forwardable!(nodes[1]);
3062         check_added_monitors!(nodes[1], 1);
3063         let events = nodes[1].node.get_and_clear_pending_msg_events();
3064         assert_eq!(events.len(), 1);
3065         match events[0] {
3066                 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, .. } } => {
3067                         assert!(update_add_htlcs.is_empty());
3068                         assert_eq!(update_fail_htlcs.len(), 1);
3069                         assert!(update_fulfill_htlcs.is_empty());
3070                         assert!(update_fail_malformed_htlcs.is_empty());
3071                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3072
3073                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3074                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3075
3076                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3077                         assert_eq!(events.len(), 1);
3078                         match events[0] {
3079                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3080                                 _ => panic!("Unexpected event"),
3081                         }
3082                         expect_payment_failed!(nodes[0], payment_hash, false);
3083                 },
3084                 _ => panic!("Unexpected event"),
3085         }
3086 }
3087
3088 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3089         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3090         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3091         // commitment transaction anymore.
3092         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3093         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3094         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3095         // technically disallowed and we should probably handle it reasonably.
3096         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3097         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3098         // transactions:
3099         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3100         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3101         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3102         //   and once they revoke the previous commitment transaction (allowing us to send a new
3103         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3104         let chanmon_cfgs = create_chanmon_cfgs(3);
3105         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3106         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3107         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3108
3109         // Create some initial channels
3110         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3111         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3112
3113         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3114         // Get the will-be-revoked local txn from nodes[2]
3115         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3116         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3117         // Revoke the old state
3118         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3119
3120         let value = if use_dust {
3121                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3122                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3123                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3124         } else { 3000000 };
3125
3126         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3127         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3128         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3129
3130         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3131         expect_pending_htlcs_forwardable!(nodes[2]);
3132         check_added_monitors!(nodes[2], 1);
3133         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3134         assert!(updates.update_add_htlcs.is_empty());
3135         assert!(updates.update_fulfill_htlcs.is_empty());
3136         assert!(updates.update_fail_malformed_htlcs.is_empty());
3137         assert_eq!(updates.update_fail_htlcs.len(), 1);
3138         assert!(updates.update_fee.is_none());
3139         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3140         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3141         // Drop the last RAA from 3 -> 2
3142
3143         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3144         expect_pending_htlcs_forwardable!(nodes[2]);
3145         check_added_monitors!(nodes[2], 1);
3146         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3147         assert!(updates.update_add_htlcs.is_empty());
3148         assert!(updates.update_fulfill_htlcs.is_empty());
3149         assert!(updates.update_fail_malformed_htlcs.is_empty());
3150         assert_eq!(updates.update_fail_htlcs.len(), 1);
3151         assert!(updates.update_fee.is_none());
3152         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3153         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3154         check_added_monitors!(nodes[1], 1);
3155         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3156         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3157         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3158         check_added_monitors!(nodes[2], 1);
3159
3160         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3161         expect_pending_htlcs_forwardable!(nodes[2]);
3162         check_added_monitors!(nodes[2], 1);
3163         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3164         assert!(updates.update_add_htlcs.is_empty());
3165         assert!(updates.update_fulfill_htlcs.is_empty());
3166         assert!(updates.update_fail_malformed_htlcs.is_empty());
3167         assert_eq!(updates.update_fail_htlcs.len(), 1);
3168         assert!(updates.update_fee.is_none());
3169         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3170         // At this point first_payment_hash has dropped out of the latest two commitment
3171         // transactions that nodes[1] is tracking...
3172         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3173         check_added_monitors!(nodes[1], 1);
3174         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3175         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3176         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3177         check_added_monitors!(nodes[2], 1);
3178
3179         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3180         // on nodes[2]'s RAA.
3181         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3182         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3183         let logger = test_utils::TestLogger::new();
3184         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3185         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3186         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3187         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3188         check_added_monitors!(nodes[1], 0);
3189
3190         if deliver_bs_raa {
3191                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3192                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3193                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3194                 check_added_monitors!(nodes[1], 1);
3195                 let events = nodes[1].node.get_and_clear_pending_events();
3196                 assert_eq!(events.len(), 1);
3197                 match events[0] {
3198                         Event::PendingHTLCsForwardable { .. } => { },
3199                         _ => panic!("Unexpected event"),
3200                 };
3201                 // Deliberately don't process the pending fail-back so they all fail back at once after
3202                 // block connection just like the !deliver_bs_raa case
3203         }
3204
3205         let mut failed_htlcs = HashSet::new();
3206         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3207
3208         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3209         check_added_monitors!(nodes[1], 1);
3210         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3211
3212         let events = nodes[1].node.get_and_clear_pending_events();
3213         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3214         match events[0] {
3215                 Event::PaymentFailed { ref payment_hash, .. } => {
3216                         assert_eq!(*payment_hash, fourth_payment_hash);
3217                 },
3218                 _ => panic!("Unexpected event"),
3219         }
3220         if !deliver_bs_raa {
3221                 match events[1] {
3222                         Event::PendingHTLCsForwardable { .. } => { },
3223                         _ => panic!("Unexpected event"),
3224                 };
3225         }
3226         nodes[1].node.process_pending_htlc_forwards();
3227         check_added_monitors!(nodes[1], 1);
3228
3229         let events = nodes[1].node.get_and_clear_pending_msg_events();
3230         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3231         match events[if deliver_bs_raa { 1 } else { 0 }] {
3232                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3233                 _ => panic!("Unexpected event"),
3234         }
3235         match events[if deliver_bs_raa { 2 } else { 1 }] {
3236                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3237                         assert_eq!(channel_id, chan_2.2);
3238                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3239                 },
3240                 _ => panic!("Unexpected event"),
3241         }
3242         if deliver_bs_raa {
3243                 match events[0] {
3244                         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, .. } } => {
3245                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3246                                 assert_eq!(update_add_htlcs.len(), 1);
3247                                 assert!(update_fulfill_htlcs.is_empty());
3248                                 assert!(update_fail_htlcs.is_empty());
3249                                 assert!(update_fail_malformed_htlcs.is_empty());
3250                         },
3251                         _ => panic!("Unexpected event"),
3252                 }
3253         }
3254         match events[if deliver_bs_raa { 3 } else { 2 }] {
3255                 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, .. } } => {
3256                         assert!(update_add_htlcs.is_empty());
3257                         assert_eq!(update_fail_htlcs.len(), 3);
3258                         assert!(update_fulfill_htlcs.is_empty());
3259                         assert!(update_fail_malformed_htlcs.is_empty());
3260                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3261
3262                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3263                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3264                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3265
3266                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3267
3268                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3269                         // If we delivered B's RAA we got an unknown preimage error, not something
3270                         // that we should update our routing table for.
3271                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3272                         for event in events {
3273                                 match event {
3274                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3275                                         _ => panic!("Unexpected event"),
3276                                 }
3277                         }
3278                         let events = nodes[0].node.get_and_clear_pending_events();
3279                         assert_eq!(events.len(), 3);
3280                         match events[0] {
3281                                 Event::PaymentFailed { ref payment_hash, .. } => {
3282                                         assert!(failed_htlcs.insert(payment_hash.0));
3283                                 },
3284                                 _ => panic!("Unexpected event"),
3285                         }
3286                         match events[1] {
3287                                 Event::PaymentFailed { ref payment_hash, .. } => {
3288                                         assert!(failed_htlcs.insert(payment_hash.0));
3289                                 },
3290                                 _ => panic!("Unexpected event"),
3291                         }
3292                         match events[2] {
3293                                 Event::PaymentFailed { ref payment_hash, .. } => {
3294                                         assert!(failed_htlcs.insert(payment_hash.0));
3295                                 },
3296                                 _ => panic!("Unexpected event"),
3297                         }
3298                 },
3299                 _ => panic!("Unexpected event"),
3300         }
3301
3302         assert!(failed_htlcs.contains(&first_payment_hash.0));
3303         assert!(failed_htlcs.contains(&second_payment_hash.0));
3304         assert!(failed_htlcs.contains(&third_payment_hash.0));
3305 }
3306
3307 #[test]
3308 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3309         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3310         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3311         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3312         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3313 }
3314
3315 #[test]
3316 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3317         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3318         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3319         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3320         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3321 }
3322
3323 #[test]
3324 fn fail_backward_pending_htlc_upon_channel_failure() {
3325         let chanmon_cfgs = create_chanmon_cfgs(2);
3326         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3327         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3328         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3329         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3330         let logger = test_utils::TestLogger::new();
3331
3332         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3333         {
3334                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3335                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3336                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3337                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3338                 check_added_monitors!(nodes[0], 1);
3339
3340                 let payment_event = {
3341                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3342                         assert_eq!(events.len(), 1);
3343                         SendEvent::from_event(events.remove(0))
3344                 };
3345                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3346                 assert_eq!(payment_event.msgs.len(), 1);
3347         }
3348
3349         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3350         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3351         {
3352                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3353                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3354                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3355                 check_added_monitors!(nodes[0], 0);
3356
3357                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3358         }
3359
3360         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3361         {
3362                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3363
3364                 let secp_ctx = Secp256k1::new();
3365                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3366                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3367                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3368                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3369                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3370                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3371                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3372
3373                 // Send a 0-msat update_add_htlc to fail the channel.
3374                 let update_add_htlc = msgs::UpdateAddHTLC {
3375                         channel_id: chan.2,
3376                         htlc_id: 0,
3377                         amount_msat: 0,
3378                         payment_hash,
3379                         cltv_expiry,
3380                         onion_routing_packet,
3381                 };
3382                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3383         }
3384
3385         // Check that Alice fails backward the pending HTLC from the second payment.
3386         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3387         check_closed_broadcast!(nodes[0], true);
3388         check_added_monitors!(nodes[0], 1);
3389 }
3390
3391 #[test]
3392 fn test_htlc_ignore_latest_remote_commitment() {
3393         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3394         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3395         let chanmon_cfgs = create_chanmon_cfgs(2);
3396         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3397         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3398         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3399         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3400
3401         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3402         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3403         check_closed_broadcast!(nodes[0], true);
3404         check_added_monitors!(nodes[0], 1);
3405
3406         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3407         assert_eq!(node_txn.len(), 2);
3408
3409         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3410         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3411         check_closed_broadcast!(nodes[1], true);
3412         check_added_monitors!(nodes[1], 1);
3413
3414         // Duplicate the connect_block call since this may happen due to other listeners
3415         // registering new transactions
3416         header.prev_blockhash = header.block_hash();
3417         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3418 }
3419
3420 #[test]
3421 fn test_force_close_fail_back() {
3422         // Check which HTLCs are failed-backwards on channel force-closure
3423         let chanmon_cfgs = create_chanmon_cfgs(3);
3424         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3425         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3426         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3427         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3428         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3429         let logger = test_utils::TestLogger::new();
3430
3431         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3432
3433         let mut payment_event = {
3434                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3435                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3436                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3437                 check_added_monitors!(nodes[0], 1);
3438
3439                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3440                 assert_eq!(events.len(), 1);
3441                 SendEvent::from_event(events.remove(0))
3442         };
3443
3444         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3445         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3446
3447         expect_pending_htlcs_forwardable!(nodes[1]);
3448
3449         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3450         assert_eq!(events_2.len(), 1);
3451         payment_event = SendEvent::from_event(events_2.remove(0));
3452         assert_eq!(payment_event.msgs.len(), 1);
3453
3454         check_added_monitors!(nodes[1], 1);
3455         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3456         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3457         check_added_monitors!(nodes[2], 1);
3458         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3459
3460         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3461         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3462         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3463
3464         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3465         check_closed_broadcast!(nodes[2], true);
3466         check_added_monitors!(nodes[2], 1);
3467         let tx = {
3468                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3469                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3470                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3471                 // back to nodes[1] upon timeout otherwise.
3472                 assert_eq!(node_txn.len(), 1);
3473                 node_txn.remove(0)
3474         };
3475
3476         mine_transaction(&nodes[1], &tx);
3477
3478         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3479         check_closed_broadcast!(nodes[1], true);
3480         check_added_monitors!(nodes[1], 1);
3481
3482         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3483         {
3484                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3485                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3486                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3487         }
3488         mine_transaction(&nodes[2], &tx);
3489         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3490         assert_eq!(node_txn.len(), 1);
3491         assert_eq!(node_txn[0].input.len(), 1);
3492         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3493         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3494         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3495
3496         check_spends!(node_txn[0], tx);
3497 }
3498
3499 #[test]
3500 fn test_dup_events_on_peer_disconnect() {
3501         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3502         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3503         // as we used to generate the event immediately upon receipt of the payment preimage in the
3504         // update_fulfill_htlc message.
3505
3506         let chanmon_cfgs = create_chanmon_cfgs(2);
3507         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3508         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3509         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3510         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3511
3512         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3513
3514         assert!(nodes[1].node.claim_funds(payment_preimage));
3515         check_added_monitors!(nodes[1], 1);
3516         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3517         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3518         expect_payment_sent!(nodes[0], payment_preimage);
3519
3520         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3521         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3522
3523         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3524         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3525 }
3526
3527 #[test]
3528 fn test_simple_peer_disconnect() {
3529         // Test that we can reconnect when there are no lost messages
3530         let chanmon_cfgs = create_chanmon_cfgs(3);
3531         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3532         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3533         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3534         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3535         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3536
3537         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3538         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3539         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3540
3541         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3542         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3543         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3544         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3545
3546         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3547         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3548         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3549
3550         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3551         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3552         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3553         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3554
3555         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3556         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3557
3558         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3559         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3560
3561         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3562         {
3563                 let events = nodes[0].node.get_and_clear_pending_events();
3564                 assert_eq!(events.len(), 2);
3565                 match events[0] {
3566                         Event::PaymentSent { payment_preimage } => {
3567                                 assert_eq!(payment_preimage, payment_preimage_3);
3568                         },
3569                         _ => panic!("Unexpected event"),
3570                 }
3571                 match events[1] {
3572                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3573                                 assert_eq!(payment_hash, payment_hash_5);
3574                                 assert!(rejected_by_dest);
3575                         },
3576                         _ => panic!("Unexpected event"),
3577                 }
3578         }
3579
3580         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3581         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3582 }
3583
3584 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3585         // Test that we can reconnect when in-flight HTLC updates get dropped
3586         let chanmon_cfgs = create_chanmon_cfgs(2);
3587         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3588         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3589         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3590         if messages_delivered == 0 {
3591                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3592                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3593         } else {
3594                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3595         }
3596
3597         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3598
3599         let logger = test_utils::TestLogger::new();
3600         let payment_event = {
3601                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3602                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3603                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3604                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3605                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3606                 check_added_monitors!(nodes[0], 1);
3607
3608                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3609                 assert_eq!(events.len(), 1);
3610                 SendEvent::from_event(events.remove(0))
3611         };
3612         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3613
3614         if messages_delivered < 2 {
3615                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3616         } else {
3617                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3618                 if messages_delivered >= 3 {
3619                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3620                         check_added_monitors!(nodes[1], 1);
3621                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3622
3623                         if messages_delivered >= 4 {
3624                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3625                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3626                                 check_added_monitors!(nodes[0], 1);
3627
3628                                 if messages_delivered >= 5 {
3629                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3630                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3631                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3632                                         check_added_monitors!(nodes[0], 1);
3633
3634                                         if messages_delivered >= 6 {
3635                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3636                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3637                                                 check_added_monitors!(nodes[1], 1);
3638                                         }
3639                                 }
3640                         }
3641                 }
3642         }
3643
3644         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3645         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3646         if messages_delivered < 3 {
3647                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3648                 // received on either side, both sides will need to resend them.
3649                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3650         } else if messages_delivered == 3 {
3651                 // nodes[0] still wants its RAA + commitment_signed
3652                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3653         } else if messages_delivered == 4 {
3654                 // nodes[0] still wants its commitment_signed
3655                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3656         } else if messages_delivered == 5 {
3657                 // nodes[1] still wants its final RAA
3658                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3659         } else if messages_delivered == 6 {
3660                 // Everything was delivered...
3661                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3662         }
3663
3664         let events_1 = nodes[1].node.get_and_clear_pending_events();
3665         assert_eq!(events_1.len(), 1);
3666         match events_1[0] {
3667                 Event::PendingHTLCsForwardable { .. } => { },
3668                 _ => panic!("Unexpected event"),
3669         };
3670
3671         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3672         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3673         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3674
3675         nodes[1].node.process_pending_htlc_forwards();
3676
3677         let events_2 = nodes[1].node.get_and_clear_pending_events();
3678         assert_eq!(events_2.len(), 1);
3679         match events_2[0] {
3680                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3681                         assert_eq!(payment_hash_1, *payment_hash);
3682                         assert!(payment_preimage.is_none());
3683                         assert_eq!(payment_secret_1, *payment_secret);
3684                         assert_eq!(amt, 1000000);
3685                 },
3686                 _ => panic!("Unexpected event"),
3687         }
3688
3689         nodes[1].node.claim_funds(payment_preimage_1);
3690         check_added_monitors!(nodes[1], 1);
3691
3692         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3693         assert_eq!(events_3.len(), 1);
3694         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3695                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3696                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3697                         assert!(updates.update_add_htlcs.is_empty());
3698                         assert!(updates.update_fail_htlcs.is_empty());
3699                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3700                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3701                         assert!(updates.update_fee.is_none());
3702                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3703                 },
3704                 _ => panic!("Unexpected event"),
3705         };
3706
3707         if messages_delivered >= 1 {
3708                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3709
3710                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3711                 assert_eq!(events_4.len(), 1);
3712                 match events_4[0] {
3713                         Event::PaymentSent { ref payment_preimage } => {
3714                                 assert_eq!(payment_preimage_1, *payment_preimage);
3715                         },
3716                         _ => panic!("Unexpected event"),
3717                 }
3718
3719                 if messages_delivered >= 2 {
3720                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3721                         check_added_monitors!(nodes[0], 1);
3722                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3723
3724                         if messages_delivered >= 3 {
3725                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3726                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3727                                 check_added_monitors!(nodes[1], 1);
3728
3729                                 if messages_delivered >= 4 {
3730                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3731                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3732                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3733                                         check_added_monitors!(nodes[1], 1);
3734
3735                                         if messages_delivered >= 5 {
3736                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3737                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3738                                                 check_added_monitors!(nodes[0], 1);
3739                                         }
3740                                 }
3741                         }
3742                 }
3743         }
3744
3745         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3746         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3747         if messages_delivered < 2 {
3748                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3749                 if messages_delivered < 1 {
3750                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3751                         assert_eq!(events_4.len(), 1);
3752                         match events_4[0] {
3753                                 Event::PaymentSent { ref payment_preimage } => {
3754                                         assert_eq!(payment_preimage_1, *payment_preimage);
3755                                 },
3756                                 _ => panic!("Unexpected event"),
3757                         }
3758                 } else {
3759                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3760                 }
3761         } else if messages_delivered == 2 {
3762                 // nodes[0] still wants its RAA + commitment_signed
3763                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3764         } else if messages_delivered == 3 {
3765                 // nodes[0] still wants its commitment_signed
3766                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3767         } else if messages_delivered == 4 {
3768                 // nodes[1] still wants its final RAA
3769                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3770         } else if messages_delivered == 5 {
3771                 // Everything was delivered...
3772                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3773         }
3774
3775         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3776         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3777         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3778
3779         // Channel should still work fine...
3780         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3781         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3782                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3783                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3784         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3785         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3786 }
3787
3788 #[test]
3789 fn test_drop_messages_peer_disconnect_a() {
3790         do_test_drop_messages_peer_disconnect(0);
3791         do_test_drop_messages_peer_disconnect(1);
3792         do_test_drop_messages_peer_disconnect(2);
3793         do_test_drop_messages_peer_disconnect(3);
3794 }
3795
3796 #[test]
3797 fn test_drop_messages_peer_disconnect_b() {
3798         do_test_drop_messages_peer_disconnect(4);
3799         do_test_drop_messages_peer_disconnect(5);
3800         do_test_drop_messages_peer_disconnect(6);
3801 }
3802
3803 #[test]
3804 fn test_funding_peer_disconnect() {
3805         // Test that we can lock in our funding tx while disconnected
3806         let chanmon_cfgs = create_chanmon_cfgs(2);
3807         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3808         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3809         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3810         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3811
3812         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3813         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3814
3815         confirm_transaction(&nodes[0], &tx);
3816         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3817         assert_eq!(events_1.len(), 1);
3818         match events_1[0] {
3819                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3820                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3821                 },
3822                 _ => panic!("Unexpected event"),
3823         }
3824
3825         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3826
3827         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3828         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3829
3830         confirm_transaction(&nodes[1], &tx);
3831         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3832         assert_eq!(events_2.len(), 2);
3833         let funding_locked = match events_2[0] {
3834                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3835                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3836                         msg.clone()
3837                 },
3838                 _ => panic!("Unexpected event"),
3839         };
3840         let bs_announcement_sigs = match events_2[1] {
3841                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3842                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3843                         msg.clone()
3844                 },
3845                 _ => panic!("Unexpected event"),
3846         };
3847
3848         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3849
3850         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3851         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3852         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3853         assert_eq!(events_3.len(), 2);
3854         let as_announcement_sigs = match events_3[0] {
3855                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3856                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3857                         msg.clone()
3858                 },
3859                 _ => panic!("Unexpected event"),
3860         };
3861         let (as_announcement, as_update) = match events_3[1] {
3862                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3863                         (msg.clone(), update_msg.clone())
3864                 },
3865                 _ => panic!("Unexpected event"),
3866         };
3867
3868         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3869         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3870         assert_eq!(events_4.len(), 1);
3871         let (_, bs_update) = match events_4[0] {
3872                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3873                         (msg.clone(), update_msg.clone())
3874                 },
3875                 _ => panic!("Unexpected event"),
3876         };
3877
3878         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3879         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3880         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3881
3882         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3883         let logger = test_utils::TestLogger::new();
3884         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3885         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3886         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3887 }
3888
3889 #[test]
3890 fn test_drop_messages_peer_disconnect_dual_htlc() {
3891         // Test that we can handle reconnecting when both sides of a channel have pending
3892         // commitment_updates when we disconnect.
3893         let chanmon_cfgs = create_chanmon_cfgs(2);
3894         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3895         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3896         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3897         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3898         let logger = test_utils::TestLogger::new();
3899
3900         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3901
3902         // Now try to send a second payment which will fail to send
3903         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3904         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3905         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3906         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3907         check_added_monitors!(nodes[0], 1);
3908
3909         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3910         assert_eq!(events_1.len(), 1);
3911         match events_1[0] {
3912                 MessageSendEvent::UpdateHTLCs { .. } => {},
3913                 _ => panic!("Unexpected event"),
3914         }
3915
3916         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3917         check_added_monitors!(nodes[1], 1);
3918
3919         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3920         assert_eq!(events_2.len(), 1);
3921         match events_2[0] {
3922                 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 } } => {
3923                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3924                         assert!(update_add_htlcs.is_empty());
3925                         assert_eq!(update_fulfill_htlcs.len(), 1);
3926                         assert!(update_fail_htlcs.is_empty());
3927                         assert!(update_fail_malformed_htlcs.is_empty());
3928                         assert!(update_fee.is_none());
3929
3930                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3931                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3932                         assert_eq!(events_3.len(), 1);
3933                         match events_3[0] {
3934                                 Event::PaymentSent { ref payment_preimage } => {
3935                                         assert_eq!(*payment_preimage, payment_preimage_1);
3936                                 },
3937                                 _ => panic!("Unexpected event"),
3938                         }
3939
3940                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3941                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3942                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3943                         check_added_monitors!(nodes[0], 1);
3944                 },
3945                 _ => panic!("Unexpected event"),
3946         }
3947
3948         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3949         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3950
3951         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3952         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3953         assert_eq!(reestablish_1.len(), 1);
3954         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3955         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3956         assert_eq!(reestablish_2.len(), 1);
3957
3958         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3959         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3960         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3961         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3962
3963         assert!(as_resp.0.is_none());
3964         assert!(bs_resp.0.is_none());
3965
3966         assert!(bs_resp.1.is_none());
3967         assert!(bs_resp.2.is_none());
3968
3969         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3970
3971         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3972         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3973         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3974         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3975         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3976         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3977         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3978         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3979         // No commitment_signed so get_event_msg's assert(len == 1) passes
3980         check_added_monitors!(nodes[1], 1);
3981
3982         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3983         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3984         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3985         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3986         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3987         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3988         assert!(bs_second_commitment_signed.update_fee.is_none());
3989         check_added_monitors!(nodes[1], 1);
3990
3991         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3992         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3993         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3994         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3995         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3996         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3997         assert!(as_commitment_signed.update_fee.is_none());
3998         check_added_monitors!(nodes[0], 1);
3999
4000         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4001         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4002         // No commitment_signed so get_event_msg's assert(len == 1) passes
4003         check_added_monitors!(nodes[0], 1);
4004
4005         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4006         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4007         // No commitment_signed so get_event_msg's assert(len == 1) passes
4008         check_added_monitors!(nodes[1], 1);
4009
4010         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4011         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4012         check_added_monitors!(nodes[1], 1);
4013
4014         expect_pending_htlcs_forwardable!(nodes[1]);
4015
4016         let events_5 = nodes[1].node.get_and_clear_pending_events();
4017         assert_eq!(events_5.len(), 1);
4018         match events_5[0] {
4019                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4020                         assert_eq!(payment_hash_2, *payment_hash);
4021                         assert!(payment_preimage.is_none());
4022                         assert_eq!(payment_secret_2, *payment_secret);
4023                 },
4024                 _ => panic!("Unexpected event"),
4025         }
4026
4027         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4028         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4029         check_added_monitors!(nodes[0], 1);
4030
4031         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4032 }
4033
4034 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4035         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4036         // to avoid our counterparty failing the channel.
4037         let chanmon_cfgs = create_chanmon_cfgs(2);
4038         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4039         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4040         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4041
4042         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4043         let logger = test_utils::TestLogger::new();
4044
4045         let our_payment_hash = if send_partial_mpp {
4046                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4047                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4048                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4049                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4050                 // indicates there are more HTLCs coming.
4051                 let cur_height = CHAN_CONFIRM_DEPTH + 1; // route_payment calls send_payment, which adds 1 to the current height. So we do the same here to match.
4052                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4053                 check_added_monitors!(nodes[0], 1);
4054                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4055                 assert_eq!(events.len(), 1);
4056                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4057                 // hop should *not* yet generate any PaymentReceived event(s).
4058                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4059                 our_payment_hash
4060         } else {
4061                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4062         };
4063
4064         let mut block = Block {
4065                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4066                 txdata: vec![],
4067         };
4068         connect_block(&nodes[0], &block);
4069         connect_block(&nodes[1], &block);
4070         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4071         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4072                 block.header.prev_blockhash = block.block_hash();
4073                 connect_block(&nodes[0], &block);
4074                 connect_block(&nodes[1], &block);
4075         }
4076
4077         expect_pending_htlcs_forwardable!(nodes[1]);
4078
4079         check_added_monitors!(nodes[1], 1);
4080         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4081         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4082         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4083         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4084         assert!(htlc_timeout_updates.update_fee.is_none());
4085
4086         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4087         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4088         // 100_000 msat as u64, followed by the height at which we failed back above
4089         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4090         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4091         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4092 }
4093
4094 #[test]
4095 fn test_htlc_timeout() {
4096         do_test_htlc_timeout(true);
4097         do_test_htlc_timeout(false);
4098 }
4099
4100 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4101         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4102         let chanmon_cfgs = create_chanmon_cfgs(3);
4103         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4104         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4105         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4106         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4107         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4108
4109         // Make sure all nodes are at the same starting height
4110         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4111         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4112         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4113
4114         let logger = test_utils::TestLogger::new();
4115
4116         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4117         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4118         {
4119                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4120                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4121                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4122         }
4123         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4124         check_added_monitors!(nodes[1], 1);
4125
4126         // Now attempt to route a second payment, which should be placed in the holding cell
4127         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4128         if forwarded_htlc {
4129                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4130                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4131                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4132                 check_added_monitors!(nodes[0], 1);
4133                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4134                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4135                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4136                 expect_pending_htlcs_forwardable!(nodes[1]);
4137                 check_added_monitors!(nodes[1], 0);
4138         } else {
4139                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4140                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4141                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4142                 check_added_monitors!(nodes[1], 0);
4143         }
4144
4145         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4146         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4147         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4148         connect_blocks(&nodes[1], 1);
4149
4150         if forwarded_htlc {
4151                 expect_pending_htlcs_forwardable!(nodes[1]);
4152                 check_added_monitors!(nodes[1], 1);
4153                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4154                 assert_eq!(fail_commit.len(), 1);
4155                 match fail_commit[0] {
4156                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4157                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4158                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4159                         },
4160                         _ => unreachable!(),
4161                 }
4162                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4163                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4164                         match update {
4165                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4166                                 _ => panic!("Unexpected event"),
4167                         }
4168                 } else {
4169                         panic!("Unexpected event");
4170                 }
4171         } else {
4172                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4173         }
4174 }
4175
4176 #[test]
4177 fn test_holding_cell_htlc_add_timeouts() {
4178         do_test_holding_cell_htlc_add_timeouts(false);
4179         do_test_holding_cell_htlc_add_timeouts(true);
4180 }
4181
4182 #[test]
4183 fn test_invalid_channel_announcement() {
4184         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4185         let secp_ctx = Secp256k1::new();
4186         let chanmon_cfgs = create_chanmon_cfgs(2);
4187         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4188         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4189         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4190
4191         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4192
4193         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4194         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4195         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4196         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4197
4198         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 } );
4199
4200         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4201         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4202
4203         let as_network_key = nodes[0].node.get_our_node_id();
4204         let bs_network_key = nodes[1].node.get_our_node_id();
4205
4206         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4207
4208         let mut chan_announcement;
4209
4210         macro_rules! dummy_unsigned_msg {
4211                 () => {
4212                         msgs::UnsignedChannelAnnouncement {
4213                                 features: ChannelFeatures::known(),
4214                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4215                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4216                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4217                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4218                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4219                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4220                                 excess_data: Vec::new(),
4221                         };
4222                 }
4223         }
4224
4225         macro_rules! sign_msg {
4226                 ($unsigned_msg: expr) => {
4227                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4228                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4229                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4230                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4231                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4232                         chan_announcement = msgs::ChannelAnnouncement {
4233                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4234                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4235                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4236                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4237                                 contents: $unsigned_msg
4238                         }
4239                 }
4240         }
4241
4242         let unsigned_msg = dummy_unsigned_msg!();
4243         sign_msg!(unsigned_msg);
4244         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4245         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 } );
4246
4247         // Configured with Network::Testnet
4248         let mut unsigned_msg = dummy_unsigned_msg!();
4249         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4250         sign_msg!(unsigned_msg);
4251         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4252
4253         let mut unsigned_msg = dummy_unsigned_msg!();
4254         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4255         sign_msg!(unsigned_msg);
4256         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4257 }
4258
4259 #[test]
4260 fn test_no_txn_manager_serialize_deserialize() {
4261         let chanmon_cfgs = create_chanmon_cfgs(2);
4262         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4263         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4264         let logger: test_utils::TestLogger;
4265         let fee_estimator: test_utils::TestFeeEstimator;
4266         let persister: test_utils::TestPersister;
4267         let new_chain_monitor: test_utils::TestChainMonitor;
4268         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4269         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4270
4271         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4272
4273         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4274
4275         let nodes_0_serialized = nodes[0].node.encode();
4276         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4277         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4278
4279         logger = test_utils::TestLogger::new();
4280         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4281         persister = test_utils::TestPersister::new();
4282         let keys_manager = &chanmon_cfgs[0].keys_manager;
4283         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4284         nodes[0].chain_monitor = &new_chain_monitor;
4285         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4286         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4287                 &mut chan_0_monitor_read, keys_manager).unwrap();
4288         assert!(chan_0_monitor_read.is_empty());
4289
4290         let mut nodes_0_read = &nodes_0_serialized[..];
4291         let config = UserConfig::default();
4292         let (_, nodes_0_deserialized_tmp) = {
4293                 let mut channel_monitors = HashMap::new();
4294                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4295                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4296                         default_config: config,
4297                         keys_manager,
4298                         fee_estimator: &fee_estimator,
4299                         chain_monitor: nodes[0].chain_monitor,
4300                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4301                         logger: &logger,
4302                         channel_monitors,
4303                 }).unwrap()
4304         };
4305         nodes_0_deserialized = nodes_0_deserialized_tmp;
4306         assert!(nodes_0_read.is_empty());
4307
4308         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4309         nodes[0].node = &nodes_0_deserialized;
4310         assert_eq!(nodes[0].node.list_channels().len(), 1);
4311         check_added_monitors!(nodes[0], 1);
4312
4313         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4314         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4315         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4316         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4317
4318         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4319         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4320         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4321         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4322
4323         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4324         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4325         for node in nodes.iter() {
4326                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4327                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4328                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4329         }
4330
4331         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4332 }
4333
4334 #[test]
4335 fn test_dup_htlc_onchain_fails_on_reload() {
4336         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4337         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4338         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4339         // the ChannelMonitor tells it to.
4340         //
4341         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4342         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4343         // PaymentFailed event appearing). However, because we may not serialize the relevant
4344         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4345         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4346         // and de-duplicates ChannelMonitor events.
4347         //
4348         // This tests that explicit tracking behavior.
4349         let chanmon_cfgs = create_chanmon_cfgs(2);
4350         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4351         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4352         let persister: test_utils::TestPersister;
4353         let new_chain_monitor: test_utils::TestChainMonitor;
4354         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4355         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4356
4357         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4358
4359         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4360         // nodes[0].
4361         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4362         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4363         check_closed_broadcast!(nodes[0], true);
4364         check_added_monitors!(nodes[0], 1);
4365
4366         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4367         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4368
4369         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4370         assert_eq!(node_txn.len(), 2);
4371
4372         assert!(nodes[1].node.claim_funds(payment_preimage));
4373         check_added_monitors!(nodes[1], 1);
4374
4375         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4376         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
4377         check_closed_broadcast!(nodes[1], true);
4378         check_added_monitors!(nodes[1], 1);
4379         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4380
4381         connect_block(&nodes[0], &Block { header, txdata: node_txn});
4382
4383         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4384         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4385         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4386         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4387         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4388
4389         header.prev_blockhash = header.block_hash();
4390         let claim_block = Block { header, txdata: claim_txn};
4391         connect_block(&nodes[0], &claim_block);
4392         expect_payment_sent!(nodes[0], payment_preimage);
4393
4394         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4395         // connected a highly-relevant block, it likely gets serialized out now.
4396         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4397         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4398
4399         // Now reload nodes[0]...
4400         persister = test_utils::TestPersister::new();
4401         let keys_manager = &chanmon_cfgs[0].keys_manager;
4402         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
4403         nodes[0].chain_monitor = &new_chain_monitor;
4404         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4405         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4406                 &mut chan_0_monitor_read, keys_manager).unwrap();
4407         assert!(chan_0_monitor_read.is_empty());
4408
4409         let (_, nodes_0_deserialized_tmp) = {
4410                 let mut channel_monitors = HashMap::new();
4411                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4412                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4413                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4414                                 default_config: Default::default(),
4415                                 keys_manager,
4416                                 fee_estimator: node_cfgs[0].fee_estimator,
4417                                 chain_monitor: nodes[0].chain_monitor,
4418                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4419                                 logger: nodes[0].logger,
4420                                 channel_monitors,
4421                         }).unwrap()
4422         };
4423         nodes_0_deserialized = nodes_0_deserialized_tmp;
4424
4425         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4426         check_added_monitors!(nodes[0], 1);
4427         nodes[0].node = &nodes_0_deserialized;
4428
4429         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4430         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4431         // payment events should kick in, leaving us with no pending events here.
4432         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, nodes[0].blocks.borrow().len() as u32 - 1);
4433         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4434 }
4435
4436 #[test]
4437 fn test_manager_serialize_deserialize_events() {
4438         // This test makes sure the events field in ChannelManager survives de/serialization
4439         let chanmon_cfgs = create_chanmon_cfgs(2);
4440         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4441         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4442         let fee_estimator: test_utils::TestFeeEstimator;
4443         let persister: test_utils::TestPersister;
4444         let logger: test_utils::TestLogger;
4445         let new_chain_monitor: test_utils::TestChainMonitor;
4446         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4447         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4448
4449         // Start creating a channel, but stop right before broadcasting the funding transaction
4450         let channel_value = 100000;
4451         let push_msat = 10001;
4452         let a_flags = InitFeatures::known();
4453         let b_flags = InitFeatures::known();
4454         let node_a = nodes.remove(0);
4455         let node_b = nodes.remove(0);
4456         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4457         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()));
4458         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()));
4459
4460         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4461
4462         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4463         check_added_monitors!(node_a, 0);
4464
4465         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()));
4466         {
4467                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4468                 assert_eq!(added_monitors.len(), 1);
4469                 assert_eq!(added_monitors[0].0, funding_output);
4470                 added_monitors.clear();
4471         }
4472
4473         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()));
4474         {
4475                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4476                 assert_eq!(added_monitors.len(), 1);
4477                 assert_eq!(added_monitors[0].0, funding_output);
4478                 added_monitors.clear();
4479         }
4480         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4481
4482         nodes.push(node_a);
4483         nodes.push(node_b);
4484
4485         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4486         let nodes_0_serialized = nodes[0].node.encode();
4487         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4488         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4489
4490         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4491         logger = test_utils::TestLogger::new();
4492         persister = test_utils::TestPersister::new();
4493         let keys_manager = &chanmon_cfgs[0].keys_manager;
4494         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4495         nodes[0].chain_monitor = &new_chain_monitor;
4496         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4497         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4498                 &mut chan_0_monitor_read, keys_manager).unwrap();
4499         assert!(chan_0_monitor_read.is_empty());
4500
4501         let mut nodes_0_read = &nodes_0_serialized[..];
4502         let config = UserConfig::default();
4503         let (_, nodes_0_deserialized_tmp) = {
4504                 let mut channel_monitors = HashMap::new();
4505                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4506                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4507                         default_config: config,
4508                         keys_manager,
4509                         fee_estimator: &fee_estimator,
4510                         chain_monitor: nodes[0].chain_monitor,
4511                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4512                         logger: &logger,
4513                         channel_monitors,
4514                 }).unwrap()
4515         };
4516         nodes_0_deserialized = nodes_0_deserialized_tmp;
4517         assert!(nodes_0_read.is_empty());
4518
4519         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4520
4521         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4522         nodes[0].node = &nodes_0_deserialized;
4523
4524         // After deserializing, make sure the funding_transaction is still held by the channel manager
4525         let events_4 = nodes[0].node.get_and_clear_pending_events();
4526         assert_eq!(events_4.len(), 0);
4527         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4528         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4529
4530         // Make sure the channel is functioning as though the de/serialization never happened
4531         assert_eq!(nodes[0].node.list_channels().len(), 1);
4532         check_added_monitors!(nodes[0], 1);
4533
4534         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4535         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4536         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4537         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4538
4539         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4540         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4541         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4542         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4543
4544         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4545         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4546         for node in nodes.iter() {
4547                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4548                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4549                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4550         }
4551
4552         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4553 }
4554
4555 #[test]
4556 fn test_simple_manager_serialize_deserialize() {
4557         let chanmon_cfgs = create_chanmon_cfgs(2);
4558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4560         let logger: test_utils::TestLogger;
4561         let fee_estimator: test_utils::TestFeeEstimator;
4562         let persister: test_utils::TestPersister;
4563         let new_chain_monitor: test_utils::TestChainMonitor;
4564         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4565         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4566         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4567
4568         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4569         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4570
4571         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4572
4573         let nodes_0_serialized = nodes[0].node.encode();
4574         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4575         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4576
4577         logger = test_utils::TestLogger::new();
4578         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4579         persister = test_utils::TestPersister::new();
4580         let keys_manager = &chanmon_cfgs[0].keys_manager;
4581         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4582         nodes[0].chain_monitor = &new_chain_monitor;
4583         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4584         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4585                 &mut chan_0_monitor_read, keys_manager).unwrap();
4586         assert!(chan_0_monitor_read.is_empty());
4587
4588         let mut nodes_0_read = &nodes_0_serialized[..];
4589         let (_, nodes_0_deserialized_tmp) = {
4590                 let mut channel_monitors = HashMap::new();
4591                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4592                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4593                         default_config: UserConfig::default(),
4594                         keys_manager,
4595                         fee_estimator: &fee_estimator,
4596                         chain_monitor: nodes[0].chain_monitor,
4597                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4598                         logger: &logger,
4599                         channel_monitors,
4600                 }).unwrap()
4601         };
4602         nodes_0_deserialized = nodes_0_deserialized_tmp;
4603         assert!(nodes_0_read.is_empty());
4604
4605         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4606         nodes[0].node = &nodes_0_deserialized;
4607         check_added_monitors!(nodes[0], 1);
4608
4609         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4610
4611         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4612         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4613 }
4614
4615 #[test]
4616 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4617         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4618         let chanmon_cfgs = create_chanmon_cfgs(4);
4619         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4620         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4621         let logger: test_utils::TestLogger;
4622         let fee_estimator: test_utils::TestFeeEstimator;
4623         let persister: test_utils::TestPersister;
4624         let new_chain_monitor: test_utils::TestChainMonitor;
4625         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4626         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4627         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4628         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4629         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4630
4631         let mut node_0_stale_monitors_serialized = Vec::new();
4632         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4633                 let mut writer = test_utils::TestVecWriter(Vec::new());
4634                 monitor.1.write(&mut writer).unwrap();
4635                 node_0_stale_monitors_serialized.push(writer.0);
4636         }
4637
4638         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4639
4640         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4641         let nodes_0_serialized = nodes[0].node.encode();
4642
4643         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4644         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4645         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4646         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4647
4648         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4649         // nodes[3])
4650         let mut node_0_monitors_serialized = Vec::new();
4651         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4652                 let mut writer = test_utils::TestVecWriter(Vec::new());
4653                 monitor.1.write(&mut writer).unwrap();
4654                 node_0_monitors_serialized.push(writer.0);
4655         }
4656
4657         logger = test_utils::TestLogger::new();
4658         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4659         persister = test_utils::TestPersister::new();
4660         let keys_manager = &chanmon_cfgs[0].keys_manager;
4661         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4662         nodes[0].chain_monitor = &new_chain_monitor;
4663
4664
4665         let mut node_0_stale_monitors = Vec::new();
4666         for serialized in node_0_stale_monitors_serialized.iter() {
4667                 let mut read = &serialized[..];
4668                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4669                 assert!(read.is_empty());
4670                 node_0_stale_monitors.push(monitor);
4671         }
4672
4673         let mut node_0_monitors = Vec::new();
4674         for serialized in node_0_monitors_serialized.iter() {
4675                 let mut read = &serialized[..];
4676                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4677                 assert!(read.is_empty());
4678                 node_0_monitors.push(monitor);
4679         }
4680
4681         let mut nodes_0_read = &nodes_0_serialized[..];
4682         if let Err(msgs::DecodeError::InvalidValue) =
4683                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4684                 default_config: UserConfig::default(),
4685                 keys_manager,
4686                 fee_estimator: &fee_estimator,
4687                 chain_monitor: nodes[0].chain_monitor,
4688                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4689                 logger: &logger,
4690                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4691         }) { } else {
4692                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4693         };
4694
4695         let mut nodes_0_read = &nodes_0_serialized[..];
4696         let (_, nodes_0_deserialized_tmp) =
4697                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4698                 default_config: UserConfig::default(),
4699                 keys_manager,
4700                 fee_estimator: &fee_estimator,
4701                 chain_monitor: nodes[0].chain_monitor,
4702                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4703                 logger: &logger,
4704                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4705         }).unwrap();
4706         nodes_0_deserialized = nodes_0_deserialized_tmp;
4707         assert!(nodes_0_read.is_empty());
4708
4709         { // Channel close should result in a commitment tx and an HTLC tx
4710                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4711                 assert_eq!(txn.len(), 2);
4712                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4713                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4714         }
4715
4716         for monitor in node_0_monitors.drain(..) {
4717                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4718                 check_added_monitors!(nodes[0], 1);
4719         }
4720         nodes[0].node = &nodes_0_deserialized;
4721
4722         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4723         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4724         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4725         //... and we can even still claim the payment!
4726         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4727
4728         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4729         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4730         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4731         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4732         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4733         assert_eq!(msg_events.len(), 1);
4734         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4735                 match action {
4736                         &ErrorAction::SendErrorMessage { ref msg } => {
4737                                 assert_eq!(msg.channel_id, channel_id);
4738                         },
4739                         _ => panic!("Unexpected event!"),
4740                 }
4741         }
4742 }
4743
4744 macro_rules! check_spendable_outputs {
4745         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4746                 {
4747                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4748                         let mut txn = Vec::new();
4749                         let mut all_outputs = Vec::new();
4750                         let secp_ctx = Secp256k1::new();
4751                         for event in events.drain(..) {
4752                                 match event {
4753                                         Event::SpendableOutputs { mut outputs } => {
4754                                                 for outp in outputs.drain(..) {
4755                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4756                                                         all_outputs.push(outp);
4757                                                 }
4758                                         },
4759                                         _ => panic!("Unexpected event"),
4760                                 };
4761                         }
4762                         if all_outputs.len() > 1 {
4763                                 if let Ok(tx) = $keysinterface.backing.spend_spendable_outputs(&all_outputs.iter().map(|a| a).collect::<Vec<_>>(), Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx) {
4764                                         txn.push(tx);
4765                                 }
4766                         }
4767                         txn
4768                 }
4769         }
4770 }
4771
4772 #[test]
4773 fn test_claim_sizeable_push_msat() {
4774         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4775         let chanmon_cfgs = create_chanmon_cfgs(2);
4776         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4778         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4779
4780         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4781         nodes[1].node.force_close_channel(&chan.2).unwrap();
4782         check_closed_broadcast!(nodes[1], true);
4783         check_added_monitors!(nodes[1], 1);
4784         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4785         assert_eq!(node_txn.len(), 1);
4786         check_spends!(node_txn[0], chan.3);
4787         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
4788
4789         mine_transaction(&nodes[1], &node_txn[0]);
4790         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4791
4792         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4793         assert_eq!(spend_txn.len(), 1);
4794         check_spends!(spend_txn[0], node_txn[0]);
4795 }
4796
4797 #[test]
4798 fn test_claim_on_remote_sizeable_push_msat() {
4799         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4800         // to_remote output is encumbered by a P2WPKH
4801         let chanmon_cfgs = create_chanmon_cfgs(2);
4802         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4803         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4804         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4805
4806         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4807         nodes[0].node.force_close_channel(&chan.2).unwrap();
4808         check_closed_broadcast!(nodes[0], true);
4809         check_added_monitors!(nodes[0], 1);
4810
4811         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4812         assert_eq!(node_txn.len(), 1);
4813         check_spends!(node_txn[0], chan.3);
4814         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
4815
4816         mine_transaction(&nodes[1], &node_txn[0]);
4817         check_closed_broadcast!(nodes[1], true);
4818         check_added_monitors!(nodes[1], 1);
4819         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4820
4821         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4822         assert_eq!(spend_txn.len(), 1);
4823         check_spends!(spend_txn[0], node_txn[0]);
4824 }
4825
4826 #[test]
4827 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4828         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4829         // to_remote output is encumbered by a P2WPKH
4830
4831         let chanmon_cfgs = create_chanmon_cfgs(2);
4832         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4833         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4834         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4835
4836         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4837         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4838         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4839         assert_eq!(revoked_local_txn[0].input.len(), 1);
4840         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4841
4842         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4843         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4844         check_closed_broadcast!(nodes[1], true);
4845         check_added_monitors!(nodes[1], 1);
4846
4847         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4848         mine_transaction(&nodes[1], &node_txn[0]);
4849         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4850
4851         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4852         assert_eq!(spend_txn.len(), 3);
4853         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4854         check_spends!(spend_txn[1], node_txn[0]);
4855         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4856 }
4857
4858 #[test]
4859 fn test_static_spendable_outputs_preimage_tx() {
4860         let chanmon_cfgs = create_chanmon_cfgs(2);
4861         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4863         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4864
4865         // Create some initial channels
4866         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4867
4868         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4869
4870         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4871         assert_eq!(commitment_tx[0].input.len(), 1);
4872         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4873
4874         // Settle A's commitment tx on B's chain
4875         assert!(nodes[1].node.claim_funds(payment_preimage));
4876         check_added_monitors!(nodes[1], 1);
4877         mine_transaction(&nodes[1], &commitment_tx[0]);
4878         check_added_monitors!(nodes[1], 1);
4879         let events = nodes[1].node.get_and_clear_pending_msg_events();
4880         match events[0] {
4881                 MessageSendEvent::UpdateHTLCs { .. } => {},
4882                 _ => panic!("Unexpected event"),
4883         }
4884         match events[1] {
4885                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4886                 _ => panic!("Unexepected event"),
4887         }
4888
4889         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4890         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4891         assert_eq!(node_txn.len(), 3);
4892         check_spends!(node_txn[0], commitment_tx[0]);
4893         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4894         check_spends!(node_txn[1], chan_1.3);
4895         check_spends!(node_txn[2], node_txn[1]);
4896
4897         mine_transaction(&nodes[1], &node_txn[0]);
4898         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4899
4900         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4901         assert_eq!(spend_txn.len(), 1);
4902         check_spends!(spend_txn[0], node_txn[0]);
4903 }
4904
4905 #[test]
4906 fn test_static_spendable_outputs_timeout_tx() {
4907         let chanmon_cfgs = create_chanmon_cfgs(2);
4908         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4909         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4910         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4911
4912         // Create some initial channels
4913         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4914
4915         // Rebalance the network a bit by relaying one payment through all the channels ...
4916         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4917
4918         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4919
4920         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4921         assert_eq!(commitment_tx[0].input.len(), 1);
4922         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4923
4924         // Settle A's commitment tx on B' chain
4925         mine_transaction(&nodes[1], &commitment_tx[0]);
4926         check_added_monitors!(nodes[1], 1);
4927         let events = nodes[1].node.get_and_clear_pending_msg_events();
4928         match events[0] {
4929                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4930                 _ => panic!("Unexpected event"),
4931         }
4932
4933         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4934         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4935         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4936         check_spends!(node_txn[0],  commitment_tx[0].clone());
4937         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4938         check_spends!(node_txn[1], chan_1.3.clone());
4939         check_spends!(node_txn[2], node_txn[1]);
4940
4941         mine_transaction(&nodes[1], &node_txn[0]);
4942         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4943         expect_payment_failed!(nodes[1], our_payment_hash, true);
4944
4945         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4946         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4947         check_spends!(spend_txn[0], commitment_tx[0]);
4948         check_spends!(spend_txn[1], node_txn[0]);
4949         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4950 }
4951
4952 #[test]
4953 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4954         let chanmon_cfgs = create_chanmon_cfgs(2);
4955         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4956         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4957         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4958
4959         // Create some initial channels
4960         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4961
4962         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4963         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4964         assert_eq!(revoked_local_txn[0].input.len(), 1);
4965         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4966
4967         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4968
4969         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4970         check_closed_broadcast!(nodes[1], true);
4971         check_added_monitors!(nodes[1], 1);
4972
4973         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4974         assert_eq!(node_txn.len(), 2);
4975         assert_eq!(node_txn[0].input.len(), 2);
4976         check_spends!(node_txn[0], revoked_local_txn[0]);
4977
4978         mine_transaction(&nodes[1], &node_txn[0]);
4979         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4980
4981         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4982         assert_eq!(spend_txn.len(), 1);
4983         check_spends!(spend_txn[0], node_txn[0]);
4984 }
4985
4986 #[test]
4987 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4988         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4989         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4990         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4991         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4992         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4993
4994         // Create some initial channels
4995         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4996
4997         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4998         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4999         assert_eq!(revoked_local_txn[0].input.len(), 1);
5000         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5001
5002         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5003
5004         // A will generate HTLC-Timeout from revoked commitment tx
5005         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5006         check_closed_broadcast!(nodes[0], true);
5007         check_added_monitors!(nodes[0], 1);
5008
5009         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5010         assert_eq!(revoked_htlc_txn.len(), 2);
5011         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5012         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5013         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5014         check_spends!(revoked_htlc_txn[1], chan_1.3);
5015
5016         // B will generate justice tx from A's revoked commitment/HTLC tx
5017         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5018         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5019         check_closed_broadcast!(nodes[1], true);
5020         check_added_monitors!(nodes[1], 1);
5021
5022         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5023         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5024         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5025         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5026         // transactions next...
5027         assert_eq!(node_txn[0].input.len(), 3);
5028         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5029
5030         assert_eq!(node_txn[1].input.len(), 2);
5031         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5032         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5033                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5034         } else {
5035                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5036                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5037         }
5038
5039         assert_eq!(node_txn[2].input.len(), 1);
5040         check_spends!(node_txn[2], chan_1.3);
5041
5042         mine_transaction(&nodes[1], &node_txn[1]);
5043         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5044
5045         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5046         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5047         assert_eq!(spend_txn.len(), 1);
5048         assert_eq!(spend_txn[0].input.len(), 1);
5049         check_spends!(spend_txn[0], node_txn[1]);
5050 }
5051
5052 #[test]
5053 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5054         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5055         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5056         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5057         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5058         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5059
5060         // Create some initial channels
5061         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5062
5063         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5064         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5065         assert_eq!(revoked_local_txn[0].input.len(), 1);
5066         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5067
5068         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5069         assert_eq!(revoked_local_txn[0].output.len(), 2);
5070
5071         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5072
5073         // B will generate HTLC-Success from revoked commitment tx
5074         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5075         check_closed_broadcast!(nodes[1], true);
5076         check_added_monitors!(nodes[1], 1);
5077         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5078
5079         assert_eq!(revoked_htlc_txn.len(), 2);
5080         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5081         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5082         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5083
5084         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5085         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5086         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5087
5088         // A will generate justice tx from B's revoked commitment/HTLC tx
5089         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5090         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5091         check_closed_broadcast!(nodes[0], true);
5092         check_added_monitors!(nodes[0], 1);
5093
5094         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5095         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5096
5097         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5098         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5099         // transactions next...
5100         assert_eq!(node_txn[0].input.len(), 2);
5101         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5102         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5103                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5104         } else {
5105                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5106                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5107         }
5108
5109         assert_eq!(node_txn[1].input.len(), 1);
5110         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5111
5112         check_spends!(node_txn[2], chan_1.3);
5113
5114         mine_transaction(&nodes[0], &node_txn[1]);
5115         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5116
5117         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5118         // didn't try to generate any new transactions.
5119
5120         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5121         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5122         assert_eq!(spend_txn.len(), 3);
5123         assert_eq!(spend_txn[0].input.len(), 1);
5124         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5125         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5126         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5127         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5128 }
5129
5130 #[test]
5131 fn test_onchain_to_onchain_claim() {
5132         // Test that in case of channel closure, we detect the state of output and claim HTLC
5133         // on downstream peer's remote commitment tx.
5134         // First, have C claim an HTLC against its own latest commitment transaction.
5135         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5136         // channel.
5137         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5138         // gets broadcast.
5139
5140         let chanmon_cfgs = create_chanmon_cfgs(3);
5141         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5142         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5143         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5144
5145         // Create some initial channels
5146         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5147         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5148
5149         // Rebalance the network a bit by relaying one payment through all the channels ...
5150         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5151         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5152
5153         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5154         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5155         check_spends!(commitment_tx[0], chan_2.3);
5156         nodes[2].node.claim_funds(payment_preimage);
5157         check_added_monitors!(nodes[2], 1);
5158         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5159         assert!(updates.update_add_htlcs.is_empty());
5160         assert!(updates.update_fail_htlcs.is_empty());
5161         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5162         assert!(updates.update_fail_malformed_htlcs.is_empty());
5163
5164         mine_transaction(&nodes[2], &commitment_tx[0]);
5165         check_closed_broadcast!(nodes[2], true);
5166         check_added_monitors!(nodes[2], 1);
5167
5168         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5169         assert_eq!(c_txn.len(), 3);
5170         assert_eq!(c_txn[0], c_txn[2]);
5171         assert_eq!(commitment_tx[0], c_txn[1]);
5172         check_spends!(c_txn[1], chan_2.3);
5173         check_spends!(c_txn[2], c_txn[1]);
5174         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5175         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5176         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5177         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5178
5179         // 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
5180         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5181         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5182         {
5183                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5184                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5185                 assert_eq!(b_txn.len(), 3);
5186                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5187                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5188                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5189                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5190                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5191                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5192                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5193                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5194                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5195                 b_txn.clear();
5196         }
5197         check_added_monitors!(nodes[1], 1);
5198         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5199         assert_eq!(msg_events.len(), 3);
5200         check_added_monitors!(nodes[1], 1);
5201         match msg_events[0] {
5202                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5203                 _ => panic!("Unexpected event"),
5204         }
5205         match msg_events[1] {
5206                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5207                 _ => panic!("Unexpected event"),
5208         }
5209         match msg_events[2] {
5210                 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, .. } } => {
5211                         assert!(update_add_htlcs.is_empty());
5212                         assert!(update_fail_htlcs.is_empty());
5213                         assert_eq!(update_fulfill_htlcs.len(), 1);
5214                         assert!(update_fail_malformed_htlcs.is_empty());
5215                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5216                 },
5217                 _ => panic!("Unexpected event"),
5218         };
5219         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5220         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5221         mine_transaction(&nodes[1], &commitment_tx[0]);
5222         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5223         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5224         assert_eq!(b_txn.len(), 3);
5225         check_spends!(b_txn[1], chan_1.3);
5226         check_spends!(b_txn[2], b_txn[1]);
5227         check_spends!(b_txn[0], commitment_tx[0]);
5228         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5229         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5230         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5231
5232         check_closed_broadcast!(nodes[1], true);
5233         check_added_monitors!(nodes[1], 1);
5234 }
5235
5236 #[test]
5237 fn test_duplicate_payment_hash_one_failure_one_success() {
5238         // Topology : A --> B --> C --> D
5239         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5240         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5241         // we forward one of the payments onwards to D.
5242         let chanmon_cfgs = create_chanmon_cfgs(4);
5243         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5244         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5245         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5246
5247         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5248         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5249         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5250
5251         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5252
5253         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5254         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5255                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5256         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5257
5258         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5259         assert_eq!(commitment_txn[0].input.len(), 1);
5260         check_spends!(commitment_txn[0], chan_2.3);
5261
5262         mine_transaction(&nodes[1], &commitment_txn[0]);
5263         check_closed_broadcast!(nodes[1], true);
5264         check_added_monitors!(nodes[1], 1);
5265
5266         let htlc_timeout_tx;
5267         { // Extract one of the two HTLC-Timeout transaction
5268                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5269                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5270                 assert_eq!(node_txn.len(), 5);
5271                 check_spends!(node_txn[0], commitment_txn[0]);
5272                 assert_eq!(node_txn[0].input.len(), 1);
5273                 check_spends!(node_txn[1], commitment_txn[0]);
5274                 assert_eq!(node_txn[1].input.len(), 1);
5275                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5276                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5277                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5278                 check_spends!(node_txn[2], chan_2.3);
5279                 check_spends!(node_txn[3], node_txn[2]);
5280                 check_spends!(node_txn[4], node_txn[2]);
5281                 htlc_timeout_tx = node_txn[1].clone();
5282         }
5283
5284         nodes[2].node.claim_funds(our_payment_preimage);
5285         mine_transaction(&nodes[2], &commitment_txn[0]);
5286         check_added_monitors!(nodes[2], 2);
5287         let events = nodes[2].node.get_and_clear_pending_msg_events();
5288         match events[0] {
5289                 MessageSendEvent::UpdateHTLCs { .. } => {},
5290                 _ => panic!("Unexpected event"),
5291         }
5292         match events[1] {
5293                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5294                 _ => panic!("Unexepected event"),
5295         }
5296         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5297         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)
5298         check_spends!(htlc_success_txn[2], chan_2.3);
5299         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5300         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5301         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5302         assert_eq!(htlc_success_txn[0].input.len(), 1);
5303         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5304         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5305         assert_eq!(htlc_success_txn[1].input.len(), 1);
5306         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5307         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5308         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5309         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5310
5311         mine_transaction(&nodes[1], &htlc_timeout_tx);
5312         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5313         expect_pending_htlcs_forwardable!(nodes[1]);
5314         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5315         assert!(htlc_updates.update_add_htlcs.is_empty());
5316         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5317         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5318         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5319         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5320         check_added_monitors!(nodes[1], 1);
5321
5322         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5323         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5324         {
5325                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5326                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5327                 assert_eq!(events.len(), 1);
5328                 match events[0] {
5329                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5330                         },
5331                         _ => { panic!("Unexpected event"); }
5332                 }
5333         }
5334         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5335
5336         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5337         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5338         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5339         assert!(updates.update_add_htlcs.is_empty());
5340         assert!(updates.update_fail_htlcs.is_empty());
5341         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5342         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5343         assert!(updates.update_fail_malformed_htlcs.is_empty());
5344         check_added_monitors!(nodes[1], 1);
5345
5346         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5347         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5348
5349         let events = nodes[0].node.get_and_clear_pending_events();
5350         match events[0] {
5351                 Event::PaymentSent { ref payment_preimage } => {
5352                         assert_eq!(*payment_preimage, our_payment_preimage);
5353                 }
5354                 _ => panic!("Unexpected event"),
5355         }
5356 }
5357
5358 #[test]
5359 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5360         let chanmon_cfgs = create_chanmon_cfgs(2);
5361         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5362         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5363         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5364
5365         // Create some initial channels
5366         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5367
5368         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5369         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5370         assert_eq!(local_txn.len(), 1);
5371         assert_eq!(local_txn[0].input.len(), 1);
5372         check_spends!(local_txn[0], chan_1.3);
5373
5374         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5375         nodes[1].node.claim_funds(payment_preimage);
5376         check_added_monitors!(nodes[1], 1);
5377         mine_transaction(&nodes[1], &local_txn[0]);
5378         check_added_monitors!(nodes[1], 1);
5379         let events = nodes[1].node.get_and_clear_pending_msg_events();
5380         match events[0] {
5381                 MessageSendEvent::UpdateHTLCs { .. } => {},
5382                 _ => panic!("Unexpected event"),
5383         }
5384         match events[1] {
5385                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5386                 _ => panic!("Unexepected event"),
5387         }
5388         let node_tx = {
5389                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5390                 assert_eq!(node_txn.len(), 3);
5391                 assert_eq!(node_txn[0], node_txn[2]);
5392                 assert_eq!(node_txn[1], local_txn[0]);
5393                 assert_eq!(node_txn[0].input.len(), 1);
5394                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5395                 check_spends!(node_txn[0], local_txn[0]);
5396                 node_txn[0].clone()
5397         };
5398
5399         mine_transaction(&nodes[1], &node_tx);
5400         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5401
5402         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5403         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5404         assert_eq!(spend_txn.len(), 1);
5405         check_spends!(spend_txn[0], node_tx);
5406 }
5407
5408 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5409         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5410         // unrevoked commitment transaction.
5411         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5412         // a remote RAA before they could be failed backwards (and combinations thereof).
5413         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5414         // use the same payment hashes.
5415         // Thus, we use a six-node network:
5416         //
5417         // A \         / E
5418         //    - C - D -
5419         // B /         \ F
5420         // And test where C fails back to A/B when D announces its latest commitment transaction
5421         let chanmon_cfgs = create_chanmon_cfgs(6);
5422         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5423         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5424         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5425         let logger = test_utils::TestLogger::new();
5426
5427         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5428         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5429         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5430         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5431         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5432
5433         // Rebalance and check output sanity...
5434         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5435         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5436         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5437
5438         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5439         // 0th HTLC:
5440         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
5441         // 1st HTLC:
5442         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
5443         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5444         let our_node_id = &nodes[1].node.get_our_node_id();
5445         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5446         // 2nd HTLC:
5447         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5448         // 3rd HTLC:
5449         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5450         // 4th HTLC:
5451         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5452         // 5th HTLC:
5453         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5454         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5455         // 6th HTLC:
5456         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, 0).unwrap());
5457         // 7th HTLC:
5458         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, 0).unwrap());
5459
5460         // 8th HTLC:
5461         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5462         // 9th HTLC:
5463         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5464         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5465
5466         // 10th HTLC:
5467         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
5468         // 11th HTLC:
5469         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5470         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, 0).unwrap());
5471
5472         // Double-check that six of the new HTLC were added
5473         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5474         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5475         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5476         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5477
5478         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5479         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5480         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5481         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5482         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5483         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5484         check_added_monitors!(nodes[4], 0);
5485         expect_pending_htlcs_forwardable!(nodes[4]);
5486         check_added_monitors!(nodes[4], 1);
5487
5488         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5489         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5490         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5491         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5492         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5493         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5494
5495         // Fail 3rd below-dust and 7th above-dust HTLCs
5496         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5497         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5498         check_added_monitors!(nodes[5], 0);
5499         expect_pending_htlcs_forwardable!(nodes[5]);
5500         check_added_monitors!(nodes[5], 1);
5501
5502         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5503         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5504         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5505         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5506
5507         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5508
5509         expect_pending_htlcs_forwardable!(nodes[3]);
5510         check_added_monitors!(nodes[3], 1);
5511         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5512         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5513         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5514         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5515         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5516         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5517         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5518         if deliver_last_raa {
5519                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5520         } else {
5521                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5522         }
5523
5524         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5525         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5526         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5527         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5528         //
5529         // We now broadcast the latest commitment transaction, which *should* result in failures for
5530         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5531         // the non-broadcast above-dust HTLCs.
5532         //
5533         // Alternatively, we may broadcast the previous commitment transaction, which should only
5534         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5535         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5536
5537         if announce_latest {
5538                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5539         } else {
5540                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5541         }
5542         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5543         check_closed_broadcast!(nodes[2], true);
5544         expect_pending_htlcs_forwardable!(nodes[2]);
5545         check_added_monitors!(nodes[2], 3);
5546
5547         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5548         assert_eq!(cs_msgs.len(), 2);
5549         let mut a_done = false;
5550         for msg in cs_msgs {
5551                 match msg {
5552                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5553                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5554                                 // should be failed-backwards here.
5555                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5556                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5557                                         for htlc in &updates.update_fail_htlcs {
5558                                                 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 });
5559                                         }
5560                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5561                                         assert!(!a_done);
5562                                         a_done = true;
5563                                         &nodes[0]
5564                                 } else {
5565                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5566                                         for htlc in &updates.update_fail_htlcs {
5567                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5568                                         }
5569                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5570                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5571                                         &nodes[1]
5572                                 };
5573                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5574                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5575                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5576                                 if announce_latest {
5577                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5578                                         if *node_id == nodes[0].node.get_our_node_id() {
5579                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5580                                         }
5581                                 }
5582                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5583                         },
5584                         _ => panic!("Unexpected event"),
5585                 }
5586         }
5587
5588         let as_events = nodes[0].node.get_and_clear_pending_events();
5589         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5590         let mut as_failds = HashSet::new();
5591         for event in as_events.iter() {
5592                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5593                         assert!(as_failds.insert(*payment_hash));
5594                         if *payment_hash != payment_hash_2 {
5595                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5596                         } else {
5597                                 assert!(!rejected_by_dest);
5598                         }
5599                 } else { panic!("Unexpected event"); }
5600         }
5601         assert!(as_failds.contains(&payment_hash_1));
5602         assert!(as_failds.contains(&payment_hash_2));
5603         if announce_latest {
5604                 assert!(as_failds.contains(&payment_hash_3));
5605                 assert!(as_failds.contains(&payment_hash_5));
5606         }
5607         assert!(as_failds.contains(&payment_hash_6));
5608
5609         let bs_events = nodes[1].node.get_and_clear_pending_events();
5610         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5611         let mut bs_failds = HashSet::new();
5612         for event in bs_events.iter() {
5613                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5614                         assert!(bs_failds.insert(*payment_hash));
5615                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5616                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5617                         } else {
5618                                 assert!(!rejected_by_dest);
5619                         }
5620                 } else { panic!("Unexpected event"); }
5621         }
5622         assert!(bs_failds.contains(&payment_hash_1));
5623         assert!(bs_failds.contains(&payment_hash_2));
5624         if announce_latest {
5625                 assert!(bs_failds.contains(&payment_hash_4));
5626         }
5627         assert!(bs_failds.contains(&payment_hash_5));
5628
5629         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5630         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5631         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5632         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5633         // PaymentFailureNetworkUpdates.
5634         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5635         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5636         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5637         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5638         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5639                 match event {
5640                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5641                         _ => panic!("Unexpected event"),
5642                 }
5643         }
5644 }
5645
5646 #[test]
5647 fn test_fail_backwards_latest_remote_announce_a() {
5648         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5649 }
5650
5651 #[test]
5652 fn test_fail_backwards_latest_remote_announce_b() {
5653         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5654 }
5655
5656 #[test]
5657 fn test_fail_backwards_previous_remote_announce() {
5658         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5659         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5660         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5661 }
5662
5663 #[test]
5664 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5665         let chanmon_cfgs = create_chanmon_cfgs(2);
5666         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5667         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5668         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5669
5670         // Create some initial channels
5671         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5672
5673         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5674         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5675         assert_eq!(local_txn[0].input.len(), 1);
5676         check_spends!(local_txn[0], chan_1.3);
5677
5678         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5679         mine_transaction(&nodes[0], &local_txn[0]);
5680         check_closed_broadcast!(nodes[0], true);
5681         check_added_monitors!(nodes[0], 1);
5682
5683         let htlc_timeout = {
5684                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5685                 assert_eq!(node_txn[0].input.len(), 1);
5686                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5687                 check_spends!(node_txn[0], local_txn[0]);
5688                 node_txn[0].clone()
5689         };
5690
5691         mine_transaction(&nodes[0], &htlc_timeout);
5692         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5693         expect_payment_failed!(nodes[0], our_payment_hash, true);
5694
5695         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5696         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5697         assert_eq!(spend_txn.len(), 3);
5698         check_spends!(spend_txn[0], local_txn[0]);
5699         check_spends!(spend_txn[1], htlc_timeout);
5700         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5701 }
5702
5703 #[test]
5704 fn test_key_derivation_params() {
5705         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5706         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5707         // let us re-derive the channel key set to then derive a delayed_payment_key.
5708
5709         let chanmon_cfgs = create_chanmon_cfgs(3);
5710
5711         // We manually create the node configuration to backup the seed.
5712         let seed = [42; 32];
5713         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5714         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &chanmon_cfgs[0].persister, &keys_manager);
5715         let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chain_monitor, keys_manager: &keys_manager, node_seed: seed };
5716         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5717         node_cfgs.remove(0);
5718         node_cfgs.insert(0, node);
5719
5720         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5721         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5722
5723         // Create some initial channels
5724         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5725         // for node 0
5726         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5727         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5728         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5729
5730         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5731         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5732         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5733         assert_eq!(local_txn_1[0].input.len(), 1);
5734         check_spends!(local_txn_1[0], chan_1.3);
5735
5736         // We check funding pubkey are unique
5737         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]));
5738         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]));
5739         if from_0_funding_key_0 == from_1_funding_key_0
5740             || from_0_funding_key_0 == from_1_funding_key_1
5741             || from_0_funding_key_1 == from_1_funding_key_0
5742             || from_0_funding_key_1 == from_1_funding_key_1 {
5743                 panic!("Funding pubkeys aren't unique");
5744         }
5745
5746         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5747         mine_transaction(&nodes[0], &local_txn_1[0]);
5748         check_closed_broadcast!(nodes[0], true);
5749         check_added_monitors!(nodes[0], 1);
5750
5751         let htlc_timeout = {
5752                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5753                 assert_eq!(node_txn[0].input.len(), 1);
5754                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5755                 check_spends!(node_txn[0], local_txn_1[0]);
5756                 node_txn[0].clone()
5757         };
5758
5759         mine_transaction(&nodes[0], &htlc_timeout);
5760         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5761         expect_payment_failed!(nodes[0], our_payment_hash, true);
5762
5763         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5764         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5765         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5766         assert_eq!(spend_txn.len(), 3);
5767         check_spends!(spend_txn[0], local_txn_1[0]);
5768         check_spends!(spend_txn[1], htlc_timeout);
5769         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5770 }
5771
5772 #[test]
5773 fn test_static_output_closing_tx() {
5774         let chanmon_cfgs = create_chanmon_cfgs(2);
5775         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5776         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5777         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5778
5779         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5780
5781         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5782         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5783
5784         mine_transaction(&nodes[0], &closing_tx);
5785         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5786
5787         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5788         assert_eq!(spend_txn.len(), 1);
5789         check_spends!(spend_txn[0], closing_tx);
5790
5791         mine_transaction(&nodes[1], &closing_tx);
5792         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5793
5794         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5795         assert_eq!(spend_txn.len(), 1);
5796         check_spends!(spend_txn[0], closing_tx);
5797 }
5798
5799 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5800         let chanmon_cfgs = create_chanmon_cfgs(2);
5801         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5803         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5804         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5805
5806         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5807
5808         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5809         // present in B's local commitment transaction, but none of A's commitment transactions.
5810         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5811         check_added_monitors!(nodes[1], 1);
5812
5813         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5814         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5815         let events = nodes[0].node.get_and_clear_pending_events();
5816         assert_eq!(events.len(), 1);
5817         match events[0] {
5818                 Event::PaymentSent { payment_preimage } => {
5819                         assert_eq!(payment_preimage, our_payment_preimage);
5820                 },
5821                 _ => panic!("Unexpected event"),
5822         }
5823
5824         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5825         check_added_monitors!(nodes[0], 1);
5826         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5827         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5828         check_added_monitors!(nodes[1], 1);
5829
5830         let starting_block = nodes[1].best_block_info();
5831         let mut block = Block {
5832                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5833                 txdata: vec![],
5834         };
5835         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5836                 connect_block(&nodes[1], &block);
5837                 block.header.prev_blockhash = block.block_hash();
5838         }
5839         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5840         check_closed_broadcast!(nodes[1], true);
5841         check_added_monitors!(nodes[1], 1);
5842 }
5843
5844 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5845         let chanmon_cfgs = create_chanmon_cfgs(2);
5846         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5847         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5848         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5849         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5850         let logger = test_utils::TestLogger::new();
5851
5852         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5853         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5854         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5855         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5856         check_added_monitors!(nodes[0], 1);
5857
5858         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5859
5860         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5861         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5862         // to "time out" the HTLC.
5863
5864         let starting_block = nodes[1].best_block_info();
5865         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5866
5867         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5868                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5869                 header.prev_blockhash = header.block_hash();
5870         }
5871         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5872         check_closed_broadcast!(nodes[0], true);
5873         check_added_monitors!(nodes[0], 1);
5874 }
5875
5876 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5877         let chanmon_cfgs = create_chanmon_cfgs(3);
5878         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5879         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5880         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5881         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5882
5883         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5884         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5885         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5886         // actually revoked.
5887         let htlc_value = if use_dust { 50000 } else { 3000000 };
5888         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5889         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5890         expect_pending_htlcs_forwardable!(nodes[1]);
5891         check_added_monitors!(nodes[1], 1);
5892
5893         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5894         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5895         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5896         check_added_monitors!(nodes[0], 1);
5897         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5898         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5899         check_added_monitors!(nodes[1], 1);
5900         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5901         check_added_monitors!(nodes[1], 1);
5902         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5903
5904         if check_revoke_no_close {
5905                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5906                 check_added_monitors!(nodes[0], 1);
5907         }
5908
5909         let starting_block = nodes[1].best_block_info();
5910         let mut block = Block {
5911                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5912                 txdata: vec![],
5913         };
5914         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5915                 connect_block(&nodes[0], &block);
5916                 block.header.prev_blockhash = block.block_hash();
5917         }
5918         if !check_revoke_no_close {
5919                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5920                 check_closed_broadcast!(nodes[0], true);
5921                 check_added_monitors!(nodes[0], 1);
5922         } else {
5923                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5924         }
5925 }
5926
5927 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5928 // There are only a few cases to test here:
5929 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5930 //    broadcastable commitment transactions result in channel closure,
5931 //  * its included in an unrevoked-but-previous remote commitment transaction,
5932 //  * its included in the latest remote or local commitment transactions.
5933 // We test each of the three possible commitment transactions individually and use both dust and
5934 // non-dust HTLCs.
5935 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5936 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5937 // tested for at least one of the cases in other tests.
5938 #[test]
5939 fn htlc_claim_single_commitment_only_a() {
5940         do_htlc_claim_local_commitment_only(true);
5941         do_htlc_claim_local_commitment_only(false);
5942
5943         do_htlc_claim_current_remote_commitment_only(true);
5944         do_htlc_claim_current_remote_commitment_only(false);
5945 }
5946
5947 #[test]
5948 fn htlc_claim_single_commitment_only_b() {
5949         do_htlc_claim_previous_remote_commitment_only(true, false);
5950         do_htlc_claim_previous_remote_commitment_only(false, false);
5951         do_htlc_claim_previous_remote_commitment_only(true, true);
5952         do_htlc_claim_previous_remote_commitment_only(false, true);
5953 }
5954
5955 #[test]
5956 #[should_panic]
5957 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5958         let chanmon_cfgs = create_chanmon_cfgs(2);
5959         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5960         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5961         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5962         //Force duplicate channel ids
5963         for node in nodes.iter() {
5964                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5965         }
5966
5967         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5968         let channel_value_satoshis=10000;
5969         let push_msat=10001;
5970         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5971         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5972         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5973
5974         //Create a second channel with a channel_id collision
5975         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5976 }
5977
5978 #[test]
5979 fn bolt2_open_channel_sending_node_checks_part2() {
5980         let chanmon_cfgs = create_chanmon_cfgs(2);
5981         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5982         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5983         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5984
5985         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5986         let channel_value_satoshis=2^24;
5987         let push_msat=10001;
5988         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5989
5990         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5991         let channel_value_satoshis=10000;
5992         // Test when push_msat is equal to 1000 * funding_satoshis.
5993         let push_msat=1000*channel_value_satoshis+1;
5994         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5995
5996         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5997         let channel_value_satoshis=10000;
5998         let push_msat=10001;
5999         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
6000         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6001         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6002
6003         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6004         // 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
6005         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6006
6007         // 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.
6008         assert!(BREAKDOWN_TIMEOUT>0);
6009         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6010
6011         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6012         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6013         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6014
6015         // 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.
6016         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6017         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6018         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6019         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6020         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6021 }
6022
6023 #[test]
6024 fn bolt2_open_channel_sane_dust_limit() {
6025         let chanmon_cfgs = create_chanmon_cfgs(2);
6026         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6027         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6028         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6029
6030         let channel_value_satoshis=1000000;
6031         let push_msat=10001;
6032         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6033         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6034         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6035         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6036
6037         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6038         let events = nodes[1].node.get_and_clear_pending_msg_events();
6039         let err_msg = match events[0] {
6040                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6041                         msg.clone()
6042                 },
6043                 _ => panic!("Unexpected event"),
6044         };
6045         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6046 }
6047
6048 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6049 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6050 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6051 // is no longer affordable once it's freed.
6052 #[test]
6053 fn test_fail_holding_cell_htlc_upon_free() {
6054         let chanmon_cfgs = create_chanmon_cfgs(2);
6055         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6057         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6058         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6059         let logger = test_utils::TestLogger::new();
6060
6061         // First nodes[0] generates an update_fee, setting the channel's
6062         // pending_update_fee.
6063         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6064         check_added_monitors!(nodes[0], 1);
6065
6066         let events = nodes[0].node.get_and_clear_pending_msg_events();
6067         assert_eq!(events.len(), 1);
6068         let (update_msg, commitment_signed) = match events[0] {
6069                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6070                         (update_fee.as_ref(), commitment_signed)
6071                 },
6072                 _ => panic!("Unexpected event"),
6073         };
6074
6075         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6076
6077         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6078         let channel_reserve = chan_stat.channel_reserve_msat;
6079         let feerate = get_feerate!(nodes[0], chan.2);
6080
6081         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6082         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6083         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6084         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6085         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6086
6087         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6088         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6089         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6090         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6091
6092         // Flush the pending fee update.
6093         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6094         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6095         check_added_monitors!(nodes[1], 1);
6096         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6097         check_added_monitors!(nodes[0], 1);
6098
6099         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6100         // HTLC, but now that the fee has been raised the payment will now fail, causing
6101         // us to surface its failure to the user.
6102         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6103         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6104         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6105         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);
6106         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6107
6108         // Check that the payment failed to be sent out.
6109         let events = nodes[0].node.get_and_clear_pending_events();
6110         assert_eq!(events.len(), 1);
6111         match &events[0] {
6112                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6113                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6114                         assert_eq!(*rejected_by_dest, false);
6115                         assert_eq!(*error_code, None);
6116                         assert_eq!(*error_data, None);
6117                 },
6118                 _ => panic!("Unexpected event"),
6119         }
6120 }
6121
6122 // Test that if multiple HTLCs are released from the holding cell and one is
6123 // valid but the other is no longer valid upon release, the valid HTLC can be
6124 // successfully completed while the other one fails as expected.
6125 #[test]
6126 fn test_free_and_fail_holding_cell_htlcs() {
6127         let chanmon_cfgs = create_chanmon_cfgs(2);
6128         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6129         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6130         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6131         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6132         let logger = test_utils::TestLogger::new();
6133
6134         // First nodes[0] generates an update_fee, setting the channel's
6135         // pending_update_fee.
6136         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6137         check_added_monitors!(nodes[0], 1);
6138
6139         let events = nodes[0].node.get_and_clear_pending_msg_events();
6140         assert_eq!(events.len(), 1);
6141         let (update_msg, commitment_signed) = match events[0] {
6142                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6143                         (update_fee.as_ref(), commitment_signed)
6144                 },
6145                 _ => panic!("Unexpected event"),
6146         };
6147
6148         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6149
6150         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6151         let channel_reserve = chan_stat.channel_reserve_msat;
6152         let feerate = get_feerate!(nodes[0], chan.2);
6153
6154         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6155         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6156         let amt_1 = 20000;
6157         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6158         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6159         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6160         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6161         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6162
6163         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6164         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6165         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6166         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6167         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6168         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6169         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6170
6171         // Flush the pending fee update.
6172         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6173         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6174         check_added_monitors!(nodes[1], 1);
6175         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6176         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6177         check_added_monitors!(nodes[0], 2);
6178
6179         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6180         // but now that the fee has been raised the second payment will now fail, causing us
6181         // to surface its failure to the user. The first payment should succeed.
6182         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6183         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6184         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6185         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);
6186         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6187
6188         // Check that the second payment failed to be sent out.
6189         let events = nodes[0].node.get_and_clear_pending_events();
6190         assert_eq!(events.len(), 1);
6191         match &events[0] {
6192                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6193                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6194                         assert_eq!(*rejected_by_dest, false);
6195                         assert_eq!(*error_code, None);
6196                         assert_eq!(*error_data, None);
6197                 },
6198                 _ => panic!("Unexpected event"),
6199         }
6200
6201         // Complete the first payment and the RAA from the fee update.
6202         let (payment_event, send_raa_event) = {
6203                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6204                 assert_eq!(msgs.len(), 2);
6205                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6206         };
6207         let raa = match send_raa_event {
6208                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6209                 _ => panic!("Unexpected event"),
6210         };
6211         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6212         check_added_monitors!(nodes[1], 1);
6213         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6214         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6215         let events = nodes[1].node.get_and_clear_pending_events();
6216         assert_eq!(events.len(), 1);
6217         match events[0] {
6218                 Event::PendingHTLCsForwardable { .. } => {},
6219                 _ => panic!("Unexpected event"),
6220         }
6221         nodes[1].node.process_pending_htlc_forwards();
6222         let events = nodes[1].node.get_and_clear_pending_events();
6223         assert_eq!(events.len(), 1);
6224         match events[0] {
6225                 Event::PaymentReceived { .. } => {},
6226                 _ => panic!("Unexpected event"),
6227         }
6228         nodes[1].node.claim_funds(payment_preimage_1);
6229         check_added_monitors!(nodes[1], 1);
6230         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6231         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6232         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6233         let events = nodes[0].node.get_and_clear_pending_events();
6234         assert_eq!(events.len(), 1);
6235         match events[0] {
6236                 Event::PaymentSent { ref payment_preimage } => {
6237                         assert_eq!(*payment_preimage, payment_preimage_1);
6238                 }
6239                 _ => panic!("Unexpected event"),
6240         }
6241 }
6242
6243 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6244 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6245 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6246 // once it's freed.
6247 #[test]
6248 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6249         let chanmon_cfgs = create_chanmon_cfgs(3);
6250         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6251         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6252         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6253         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6254         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6255         let logger = test_utils::TestLogger::new();
6256
6257         // First nodes[1] generates an update_fee, setting the channel's
6258         // pending_update_fee.
6259         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6260         check_added_monitors!(nodes[1], 1);
6261
6262         let events = nodes[1].node.get_and_clear_pending_msg_events();
6263         assert_eq!(events.len(), 1);
6264         let (update_msg, commitment_signed) = match events[0] {
6265                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6266                         (update_fee.as_ref(), commitment_signed)
6267                 },
6268                 _ => panic!("Unexpected event"),
6269         };
6270
6271         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6272
6273         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6274         let channel_reserve = chan_stat.channel_reserve_msat;
6275         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6276
6277         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6278         let feemsat = 239;
6279         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6280         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6281         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6282         let payment_event = {
6283                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6284                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6285                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6286                 check_added_monitors!(nodes[0], 1);
6287
6288                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6289                 assert_eq!(events.len(), 1);
6290
6291                 SendEvent::from_event(events.remove(0))
6292         };
6293         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6294         check_added_monitors!(nodes[1], 0);
6295         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6296         expect_pending_htlcs_forwardable!(nodes[1]);
6297
6298         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6299         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6300
6301         // Flush the pending fee update.
6302         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6303         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6304         check_added_monitors!(nodes[2], 1);
6305         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6306         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6307         check_added_monitors!(nodes[1], 2);
6308
6309         // A final RAA message is generated to finalize the fee update.
6310         let events = nodes[1].node.get_and_clear_pending_msg_events();
6311         assert_eq!(events.len(), 1);
6312
6313         let raa_msg = match &events[0] {
6314                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6315                         msg.clone()
6316                 },
6317                 _ => panic!("Unexpected event"),
6318         };
6319
6320         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6321         check_added_monitors!(nodes[2], 1);
6322         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6323
6324         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6325         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6326         assert_eq!(process_htlc_forwards_event.len(), 1);
6327         match &process_htlc_forwards_event[0] {
6328                 &Event::PendingHTLCsForwardable { .. } => {},
6329                 _ => panic!("Unexpected event"),
6330         }
6331
6332         // In response, we call ChannelManager's process_pending_htlc_forwards
6333         nodes[1].node.process_pending_htlc_forwards();
6334         check_added_monitors!(nodes[1], 1);
6335
6336         // This causes the HTLC to be failed backwards.
6337         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6338         assert_eq!(fail_event.len(), 1);
6339         let (fail_msg, commitment_signed) = match &fail_event[0] {
6340                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6341                         assert_eq!(updates.update_add_htlcs.len(), 0);
6342                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6343                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6344                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6345                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6346                 },
6347                 _ => panic!("Unexpected event"),
6348         };
6349
6350         // Pass the failure messages back to nodes[0].
6351         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6352         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6353
6354         // Complete the HTLC failure+removal process.
6355         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6356         check_added_monitors!(nodes[0], 1);
6357         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6358         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6359         check_added_monitors!(nodes[1], 2);
6360         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6361         assert_eq!(final_raa_event.len(), 1);
6362         let raa = match &final_raa_event[0] {
6363                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6364                 _ => panic!("Unexpected event"),
6365         };
6366         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6367         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6368         assert_eq!(fail_msg_event.len(), 1);
6369         match &fail_msg_event[0] {
6370                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6371                 _ => panic!("Unexpected event"),
6372         }
6373         let failure_event = nodes[0].node.get_and_clear_pending_events();
6374         assert_eq!(failure_event.len(), 1);
6375         match &failure_event[0] {
6376                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6377                         assert!(!rejected_by_dest);
6378                 },
6379                 _ => panic!("Unexpected event"),
6380         }
6381         check_added_monitors!(nodes[0], 1);
6382 }
6383
6384 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6385 // 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.
6386 //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.
6387
6388 #[test]
6389 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6390         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6391         let chanmon_cfgs = create_chanmon_cfgs(2);
6392         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6393         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6394         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6395         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6396
6397         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6398         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6399         let logger = test_utils::TestLogger::new();
6400         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6401         route.paths[0][0].fee_msat = 100;
6402
6403         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6404                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6405         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6406         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6407 }
6408
6409 #[test]
6410 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6411         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6412         let chanmon_cfgs = create_chanmon_cfgs(2);
6413         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6414         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6415         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6416         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6417         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6418
6419         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6420         let logger = test_utils::TestLogger::new();
6421         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6422         route.paths[0][0].fee_msat = 0;
6423         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6424                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6425
6426         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6427         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6428 }
6429
6430 #[test]
6431 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6432         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6433         let chanmon_cfgs = create_chanmon_cfgs(2);
6434         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6435         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6436         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6437         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6438
6439         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6440         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6441         let logger = test_utils::TestLogger::new();
6442         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6443         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6444         check_added_monitors!(nodes[0], 1);
6445         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6446         updates.update_add_htlcs[0].amount_msat = 0;
6447
6448         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6449         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6450         check_closed_broadcast!(nodes[1], true).unwrap();
6451         check_added_monitors!(nodes[1], 1);
6452 }
6453
6454 #[test]
6455 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6456         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6457         //It is enforced when constructing a route.
6458         let chanmon_cfgs = create_chanmon_cfgs(2);
6459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6461         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6462         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6463         let logger = test_utils::TestLogger::new();
6464
6465         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6466
6467         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6468         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6469         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6470                 assert_eq!(err, &"Channel CLTV overflowed?"));
6471 }
6472
6473 #[test]
6474 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6475         //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.
6476         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6477         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6478         let chanmon_cfgs = create_chanmon_cfgs(2);
6479         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6480         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6481         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6482         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6483         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6484
6485         let logger = test_utils::TestLogger::new();
6486         for i in 0..max_accepted_htlcs {
6487                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6488                 let payment_event = {
6489                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6490                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6491                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6492                         check_added_monitors!(nodes[0], 1);
6493
6494                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6495                         assert_eq!(events.len(), 1);
6496                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6497                                 assert_eq!(htlcs[0].htlc_id, i);
6498                         } else {
6499                                 assert!(false);
6500                         }
6501                         SendEvent::from_event(events.remove(0))
6502                 };
6503                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6504                 check_added_monitors!(nodes[1], 0);
6505                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6506
6507                 expect_pending_htlcs_forwardable!(nodes[1]);
6508                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6509         }
6510         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6511         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6512         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6513         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6514                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6515
6516         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6517         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6518 }
6519
6520 #[test]
6521 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6522         //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.
6523         let chanmon_cfgs = create_chanmon_cfgs(2);
6524         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6525         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6526         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6527         let channel_value = 100000;
6528         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6529         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6530
6531         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6532
6533         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6534         // Manually create a route over our max in flight (which our router normally automatically
6535         // limits us to.
6536         let route = Route { paths: vec![vec![RouteHop {
6537            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6538            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6539            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6540         }]] };
6541         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6542                 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)));
6543
6544         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6545         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);
6546
6547         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6548 }
6549
6550 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6551 #[test]
6552 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6553         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6554         let chanmon_cfgs = create_chanmon_cfgs(2);
6555         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6557         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6558         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6559         let htlc_minimum_msat: u64;
6560         {
6561                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6562                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6563                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6564         }
6565
6566         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6567         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6568         let logger = test_utils::TestLogger::new();
6569         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6570         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6571         check_added_monitors!(nodes[0], 1);
6572         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6573         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6574         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6575         assert!(nodes[1].node.list_channels().is_empty());
6576         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6577         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()));
6578         check_added_monitors!(nodes[1], 1);
6579 }
6580
6581 #[test]
6582 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6583         //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
6584         let chanmon_cfgs = create_chanmon_cfgs(2);
6585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6587         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6588         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6589         let logger = test_utils::TestLogger::new();
6590
6591         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6592         let channel_reserve = chan_stat.channel_reserve_msat;
6593         let feerate = get_feerate!(nodes[0], chan.2);
6594         // The 2* and +1 are for the fee spike reserve.
6595         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6596
6597         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6598         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6599         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6600         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6601         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6602         check_added_monitors!(nodes[0], 1);
6603         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6604
6605         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6606         // at this time channel-initiatee receivers are not required to enforce that senders
6607         // respect the fee_spike_reserve.
6608         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6609         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6610
6611         assert!(nodes[1].node.list_channels().is_empty());
6612         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6613         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6614         check_added_monitors!(nodes[1], 1);
6615 }
6616
6617 #[test]
6618 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6619         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6620         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6621         let chanmon_cfgs = create_chanmon_cfgs(2);
6622         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6623         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6624         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6625         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6626         let logger = test_utils::TestLogger::new();
6627
6628         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6629         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6630
6631         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6632         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6633
6634         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6635         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6636         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6637         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6638
6639         let mut msg = msgs::UpdateAddHTLC {
6640                 channel_id: chan.2,
6641                 htlc_id: 0,
6642                 amount_msat: 1000,
6643                 payment_hash: our_payment_hash,
6644                 cltv_expiry: htlc_cltv,
6645                 onion_routing_packet: onion_packet.clone(),
6646         };
6647
6648         for i in 0..super::channel::OUR_MAX_HTLCS {
6649                 msg.htlc_id = i as u64;
6650                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6651         }
6652         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6653         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6654
6655         assert!(nodes[1].node.list_channels().is_empty());
6656         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6657         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6658         check_added_monitors!(nodes[1], 1);
6659 }
6660
6661 #[test]
6662 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6663         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6664         let chanmon_cfgs = create_chanmon_cfgs(2);
6665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6667         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6668         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6669         let logger = test_utils::TestLogger::new();
6670
6671         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6672         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6673         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6674         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6675         check_added_monitors!(nodes[0], 1);
6676         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6677         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6678         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6679
6680         assert!(nodes[1].node.list_channels().is_empty());
6681         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6682         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6683         check_added_monitors!(nodes[1], 1);
6684 }
6685
6686 #[test]
6687 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6688         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6689         let chanmon_cfgs = create_chanmon_cfgs(2);
6690         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6691         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6692         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6693         let logger = test_utils::TestLogger::new();
6694
6695         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6696         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6697         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6698         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6699         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6700         check_added_monitors!(nodes[0], 1);
6701         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6702         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6703         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6704
6705         assert!(nodes[1].node.list_channels().is_empty());
6706         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6707         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6708         check_added_monitors!(nodes[1], 1);
6709 }
6710
6711 #[test]
6712 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6713         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6714         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6715         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6716         let chanmon_cfgs = create_chanmon_cfgs(2);
6717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6719         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6720         let logger = test_utils::TestLogger::new();
6721
6722         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6723         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6724         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6725         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6726         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6727         check_added_monitors!(nodes[0], 1);
6728         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6729         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6730
6731         //Disconnect and Reconnect
6732         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6733         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6734         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6735         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6736         assert_eq!(reestablish_1.len(), 1);
6737         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6738         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6739         assert_eq!(reestablish_2.len(), 1);
6740         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6741         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6742         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6743         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6744
6745         //Resend HTLC
6746         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6747         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6748         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6749         check_added_monitors!(nodes[1], 1);
6750         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6751
6752         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6753
6754         assert!(nodes[1].node.list_channels().is_empty());
6755         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6756         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6757         check_added_monitors!(nodes[1], 1);
6758 }
6759
6760 #[test]
6761 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6762         //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.
6763
6764         let chanmon_cfgs = create_chanmon_cfgs(2);
6765         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6766         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6767         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6768         let logger = test_utils::TestLogger::new();
6769         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6770         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6771         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6772         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6773         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6774
6775         check_added_monitors!(nodes[0], 1);
6776         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6777         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6778
6779         let update_msg = msgs::UpdateFulfillHTLC{
6780                 channel_id: chan.2,
6781                 htlc_id: 0,
6782                 payment_preimage: our_payment_preimage,
6783         };
6784
6785         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6786
6787         assert!(nodes[0].node.list_channels().is_empty());
6788         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6789         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()));
6790         check_added_monitors!(nodes[0], 1);
6791 }
6792
6793 #[test]
6794 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6795         //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.
6796
6797         let chanmon_cfgs = create_chanmon_cfgs(2);
6798         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6799         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6800         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6801         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6802         let logger = test_utils::TestLogger::new();
6803
6804         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6805         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6806         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6807         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6808         check_added_monitors!(nodes[0], 1);
6809         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6810         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6811
6812         let update_msg = msgs::UpdateFailHTLC{
6813                 channel_id: chan.2,
6814                 htlc_id: 0,
6815                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6816         };
6817
6818         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6819
6820         assert!(nodes[0].node.list_channels().is_empty());
6821         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6822         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()));
6823         check_added_monitors!(nodes[0], 1);
6824 }
6825
6826 #[test]
6827 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6828         //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.
6829
6830         let chanmon_cfgs = create_chanmon_cfgs(2);
6831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6833         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6834         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6835         let logger = test_utils::TestLogger::new();
6836
6837         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6838         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6839         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6840         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6841         check_added_monitors!(nodes[0], 1);
6842         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6843         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6844         let update_msg = msgs::UpdateFailMalformedHTLC{
6845                 channel_id: chan.2,
6846                 htlc_id: 0,
6847                 sha256_of_onion: [1; 32],
6848                 failure_code: 0x8000,
6849         };
6850
6851         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6852
6853         assert!(nodes[0].node.list_channels().is_empty());
6854         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6855         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()));
6856         check_added_monitors!(nodes[0], 1);
6857 }
6858
6859 #[test]
6860 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6861         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6862
6863         let chanmon_cfgs = create_chanmon_cfgs(2);
6864         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6865         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6866         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6867         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6868
6869         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6870
6871         nodes[1].node.claim_funds(our_payment_preimage);
6872         check_added_monitors!(nodes[1], 1);
6873
6874         let events = nodes[1].node.get_and_clear_pending_msg_events();
6875         assert_eq!(events.len(), 1);
6876         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6877                 match events[0] {
6878                         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, .. } } => {
6879                                 assert!(update_add_htlcs.is_empty());
6880                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6881                                 assert!(update_fail_htlcs.is_empty());
6882                                 assert!(update_fail_malformed_htlcs.is_empty());
6883                                 assert!(update_fee.is_none());
6884                                 update_fulfill_htlcs[0].clone()
6885                         },
6886                         _ => panic!("Unexpected event"),
6887                 }
6888         };
6889
6890         update_fulfill_msg.htlc_id = 1;
6891
6892         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6893
6894         assert!(nodes[0].node.list_channels().is_empty());
6895         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6896         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6897         check_added_monitors!(nodes[0], 1);
6898 }
6899
6900 #[test]
6901 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6902         //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.
6903
6904         let chanmon_cfgs = create_chanmon_cfgs(2);
6905         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6906         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6907         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6908         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6909
6910         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6911
6912         nodes[1].node.claim_funds(our_payment_preimage);
6913         check_added_monitors!(nodes[1], 1);
6914
6915         let events = nodes[1].node.get_and_clear_pending_msg_events();
6916         assert_eq!(events.len(), 1);
6917         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6918                 match events[0] {
6919                         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, .. } } => {
6920                                 assert!(update_add_htlcs.is_empty());
6921                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6922                                 assert!(update_fail_htlcs.is_empty());
6923                                 assert!(update_fail_malformed_htlcs.is_empty());
6924                                 assert!(update_fee.is_none());
6925                                 update_fulfill_htlcs[0].clone()
6926                         },
6927                         _ => panic!("Unexpected event"),
6928                 }
6929         };
6930
6931         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6932
6933         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6934
6935         assert!(nodes[0].node.list_channels().is_empty());
6936         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6937         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6938         check_added_monitors!(nodes[0], 1);
6939 }
6940
6941 #[test]
6942 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6943         //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.
6944
6945         let chanmon_cfgs = create_chanmon_cfgs(2);
6946         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6947         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6948         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6949         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6950         let logger = test_utils::TestLogger::new();
6951
6952         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6953         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6954         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6955         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6956         check_added_monitors!(nodes[0], 1);
6957
6958         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6959         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6960
6961         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6962         check_added_monitors!(nodes[1], 0);
6963         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6964
6965         let events = nodes[1].node.get_and_clear_pending_msg_events();
6966
6967         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6968                 match events[0] {
6969                         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, .. } } => {
6970                                 assert!(update_add_htlcs.is_empty());
6971                                 assert!(update_fulfill_htlcs.is_empty());
6972                                 assert!(update_fail_htlcs.is_empty());
6973                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6974                                 assert!(update_fee.is_none());
6975                                 update_fail_malformed_htlcs[0].clone()
6976                         },
6977                         _ => panic!("Unexpected event"),
6978                 }
6979         };
6980         update_msg.failure_code &= !0x8000;
6981         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6982
6983         assert!(nodes[0].node.list_channels().is_empty());
6984         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6985         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6986         check_added_monitors!(nodes[0], 1);
6987 }
6988
6989 #[test]
6990 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6991         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6992         //    * 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.
6993
6994         let chanmon_cfgs = create_chanmon_cfgs(3);
6995         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6996         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6997         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6998         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6999         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7000         let logger = test_utils::TestLogger::new();
7001
7002         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7003
7004         //First hop
7005         let mut payment_event = {
7006                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7007                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7008                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7009                 check_added_monitors!(nodes[0], 1);
7010                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7011                 assert_eq!(events.len(), 1);
7012                 SendEvent::from_event(events.remove(0))
7013         };
7014         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7015         check_added_monitors!(nodes[1], 0);
7016         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7017         expect_pending_htlcs_forwardable!(nodes[1]);
7018         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7019         assert_eq!(events_2.len(), 1);
7020         check_added_monitors!(nodes[1], 1);
7021         payment_event = SendEvent::from_event(events_2.remove(0));
7022         assert_eq!(payment_event.msgs.len(), 1);
7023
7024         //Second Hop
7025         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7026         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7027         check_added_monitors!(nodes[2], 0);
7028         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7029
7030         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7031         assert_eq!(events_3.len(), 1);
7032         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7033                 match events_3[0] {
7034                         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 } } => {
7035                                 assert!(update_add_htlcs.is_empty());
7036                                 assert!(update_fulfill_htlcs.is_empty());
7037                                 assert!(update_fail_htlcs.is_empty());
7038                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7039                                 assert!(update_fee.is_none());
7040                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7041                         },
7042                         _ => panic!("Unexpected event"),
7043                 }
7044         };
7045
7046         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7047
7048         check_added_monitors!(nodes[1], 0);
7049         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7050         expect_pending_htlcs_forwardable!(nodes[1]);
7051         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7052         assert_eq!(events_4.len(), 1);
7053
7054         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7055         match events_4[0] {
7056                 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, .. } } => {
7057                         assert!(update_add_htlcs.is_empty());
7058                         assert!(update_fulfill_htlcs.is_empty());
7059                         assert_eq!(update_fail_htlcs.len(), 1);
7060                         assert!(update_fail_malformed_htlcs.is_empty());
7061                         assert!(update_fee.is_none());
7062                 },
7063                 _ => panic!("Unexpected event"),
7064         };
7065
7066         check_added_monitors!(nodes[1], 1);
7067 }
7068
7069 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7070         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7071         // 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
7072         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7073
7074         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7075         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7076         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7077         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7078         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7079         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7080
7081         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7082
7083         // We route 2 dust-HTLCs between A and B
7084         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7085         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7086         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7087
7088         // Cache one local commitment tx as previous
7089         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7090
7091         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7092         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7093         check_added_monitors!(nodes[1], 0);
7094         expect_pending_htlcs_forwardable!(nodes[1]);
7095         check_added_monitors!(nodes[1], 1);
7096
7097         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7098         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7099         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7100         check_added_monitors!(nodes[0], 1);
7101
7102         // Cache one local commitment tx as lastest
7103         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7104
7105         let events = nodes[0].node.get_and_clear_pending_msg_events();
7106         match events[0] {
7107                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7108                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7109                 },
7110                 _ => panic!("Unexpected event"),
7111         }
7112         match events[1] {
7113                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7114                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7115                 },
7116                 _ => panic!("Unexpected event"),
7117         }
7118
7119         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7120         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7121         if announce_latest {
7122                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7123         } else {
7124                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7125         }
7126
7127         check_closed_broadcast!(nodes[0], true);
7128         check_added_monitors!(nodes[0], 1);
7129
7130         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7131         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7132         let events = nodes[0].node.get_and_clear_pending_events();
7133         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7134         assert_eq!(events.len(), 2);
7135         let mut first_failed = false;
7136         for event in events {
7137                 match event {
7138                         Event::PaymentFailed { payment_hash, .. } => {
7139                                 if payment_hash == payment_hash_1 {
7140                                         assert!(!first_failed);
7141                                         first_failed = true;
7142                                 } else {
7143                                         assert_eq!(payment_hash, payment_hash_2);
7144                                 }
7145                         }
7146                         _ => panic!("Unexpected event"),
7147                 }
7148         }
7149 }
7150
7151 #[test]
7152 fn test_failure_delay_dust_htlc_local_commitment() {
7153         do_test_failure_delay_dust_htlc_local_commitment(true);
7154         do_test_failure_delay_dust_htlc_local_commitment(false);
7155 }
7156
7157 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7158         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7159         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7160         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7161         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7162         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7163         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7164
7165         let chanmon_cfgs = create_chanmon_cfgs(3);
7166         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7167         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7168         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7169         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7170
7171         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7172
7173         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7174         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7175
7176         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7177         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7178
7179         // We revoked bs_commitment_tx
7180         if revoked {
7181                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7182                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7183         }
7184
7185         let mut timeout_tx = Vec::new();
7186         if local {
7187                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7188                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7189                 check_closed_broadcast!(nodes[0], true);
7190                 check_added_monitors!(nodes[0], 1);
7191                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7192                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7193                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7194                 expect_payment_failed!(nodes[0], dust_hash, true);
7195                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7196                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7197                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7198                 mine_transaction(&nodes[0], &timeout_tx[0]);
7199                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7200                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7201         } else {
7202                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7203                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7204                 check_closed_broadcast!(nodes[0], true);
7205                 check_added_monitors!(nodes[0], 1);
7206                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7207                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7208                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7209                 if !revoked {
7210                         expect_payment_failed!(nodes[0], dust_hash, true);
7211                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7212                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7213                         mine_transaction(&nodes[0], &timeout_tx[0]);
7214                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7215                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7216                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7217                 } else {
7218                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7219                         // commitment tx
7220                         let events = nodes[0].node.get_and_clear_pending_events();
7221                         assert_eq!(events.len(), 2);
7222                         let first;
7223                         match events[0] {
7224                                 Event::PaymentFailed { payment_hash, .. } => {
7225                                         if payment_hash == dust_hash { first = true; }
7226                                         else { first = false; }
7227                                 },
7228                                 _ => panic!("Unexpected event"),
7229                         }
7230                         match events[1] {
7231                                 Event::PaymentFailed { payment_hash, .. } => {
7232                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7233                                         else { assert_eq!(payment_hash, dust_hash); }
7234                                 },
7235                                 _ => panic!("Unexpected event"),
7236                         }
7237                 }
7238         }
7239 }
7240
7241 #[test]
7242 fn test_sweep_outbound_htlc_failure_update() {
7243         do_test_sweep_outbound_htlc_failure_update(false, true);
7244         do_test_sweep_outbound_htlc_failure_update(false, false);
7245         do_test_sweep_outbound_htlc_failure_update(true, false);
7246 }
7247
7248 #[test]
7249 fn test_upfront_shutdown_script() {
7250         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7251         // enforce it at shutdown message
7252
7253         let mut config = UserConfig::default();
7254         config.channel_options.announced_channel = true;
7255         config.peer_channel_config_limits.force_announced_channel_preference = false;
7256         config.channel_options.commit_upfront_shutdown_pubkey = false;
7257         let user_cfgs = [None, Some(config), None];
7258         let chanmon_cfgs = create_chanmon_cfgs(3);
7259         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7260         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7261         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7262
7263         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7264         let flags = InitFeatures::known();
7265         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7266         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7267         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7268         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7269         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7270         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7271     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()));
7272         check_added_monitors!(nodes[2], 1);
7273
7274         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7275         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7276         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7277         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7278         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7279         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7280         let events = nodes[2].node.get_and_clear_pending_msg_events();
7281         assert_eq!(events.len(), 1);
7282         match events[0] {
7283                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7284                 _ => panic!("Unexpected event"),
7285         }
7286
7287         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7288         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7289         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7290         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7291         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7292         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7293         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7294         let events = nodes[1].node.get_and_clear_pending_msg_events();
7295         assert_eq!(events.len(), 1);
7296         match events[0] {
7297                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7298                 _ => panic!("Unexpected event"),
7299         }
7300
7301         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7302         // channel smoothly, opt-out is from channel initiator here
7303         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7304         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7305         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7306         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7307         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7308         let events = nodes[0].node.get_and_clear_pending_msg_events();
7309         assert_eq!(events.len(), 1);
7310         match events[0] {
7311                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7312                 _ => panic!("Unexpected event"),
7313         }
7314
7315         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7316         //// channel smoothly
7317         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7318         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7319         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7320         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7321         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7322         let events = nodes[0].node.get_and_clear_pending_msg_events();
7323         assert_eq!(events.len(), 2);
7324         match events[0] {
7325                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7326                 _ => panic!("Unexpected event"),
7327         }
7328         match events[1] {
7329                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7330                 _ => panic!("Unexpected event"),
7331         }
7332 }
7333
7334 #[test]
7335 fn test_upfront_shutdown_script_unsupport_segwit() {
7336         // We test that channel is closed early
7337         // if a segwit program is passed as upfront shutdown script,
7338         // but the peer does not support segwit.
7339         let chanmon_cfgs = create_chanmon_cfgs(2);
7340         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7341         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7342         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7343
7344         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7345
7346         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7347         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7348                 .push_slice(&[0, 0])
7349                 .into_script());
7350
7351         let features = InitFeatures::known().clear_shutdown_anysegwit();
7352         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7353
7354         let events = nodes[0].node.get_and_clear_pending_msg_events();
7355         assert_eq!(events.len(), 1);
7356         match events[0] {
7357                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7358                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7359                         assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7360                 },
7361                 _ => panic!("Unexpected event"),
7362         }
7363 }
7364
7365 #[test]
7366 fn test_shutdown_script_any_segwit_allowed() {
7367         let mut config = UserConfig::default();
7368         config.channel_options.announced_channel = true;
7369         config.peer_channel_config_limits.force_announced_channel_preference = false;
7370         config.channel_options.commit_upfront_shutdown_pubkey = false;
7371         let user_cfgs = [None, Some(config), None];
7372         let chanmon_cfgs = create_chanmon_cfgs(3);
7373         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7374         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7375         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7376
7377         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7378         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7379         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7380         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7381         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7382                 .push_slice(&[0, 0])
7383                 .into_script();
7384         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7385         let events = nodes[0].node.get_and_clear_pending_msg_events();
7386         assert_eq!(events.len(), 2);
7387         match events[0] {
7388                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7389                 _ => panic!("Unexpected event"),
7390         }
7391         match events[1] {
7392                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7393                 _ => panic!("Unexpected event"),
7394         }
7395 }
7396
7397 #[test]
7398 fn test_shutdown_script_any_segwit_not_allowed() {
7399         let mut config = UserConfig::default();
7400         config.channel_options.announced_channel = true;
7401         config.peer_channel_config_limits.force_announced_channel_preference = false;
7402         config.channel_options.commit_upfront_shutdown_pubkey = false;
7403         let user_cfgs = [None, Some(config), None];
7404         let chanmon_cfgs = create_chanmon_cfgs(3);
7405         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7406         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7407         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7408
7409         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7410         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7411         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7412         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7413         // Make an any segwit version script
7414         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7415                 .push_slice(&[0, 0])
7416                 .into_script();
7417         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7418         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7419         let events = nodes[0].node.get_and_clear_pending_msg_events();
7420         assert_eq!(events.len(), 2);
7421         match events[1] {
7422                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7423                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7424                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7425                 },
7426                 _ => panic!("Unexpected event"),
7427         }
7428         check_added_monitors!(nodes[0], 1);
7429 }
7430
7431 #[test]
7432 fn test_shutdown_script_segwit_but_not_anysegwit() {
7433         let mut config = UserConfig::default();
7434         config.channel_options.announced_channel = true;
7435         config.peer_channel_config_limits.force_announced_channel_preference = false;
7436         config.channel_options.commit_upfront_shutdown_pubkey = false;
7437         let user_cfgs = [None, Some(config), None];
7438         let chanmon_cfgs = create_chanmon_cfgs(3);
7439         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7440         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7441         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7442
7443         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7444         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7445         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7446         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7447         // Make a segwit script that is not a valid as any segwit
7448         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7449                 .push_slice(&[0, 0])
7450                 .into_script();
7451         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7452         let events = nodes[0].node.get_and_clear_pending_msg_events();
7453         assert_eq!(events.len(), 2);
7454         match events[1] {
7455                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7456                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7457                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7458                 },
7459                 _ => panic!("Unexpected event"),
7460         }
7461         check_added_monitors!(nodes[0], 1);
7462 }
7463
7464 #[test]
7465 fn test_user_configurable_csv_delay() {
7466         // We test our channel constructors yield errors when we pass them absurd csv delay
7467
7468         let mut low_our_to_self_config = UserConfig::default();
7469         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7470         let mut high_their_to_self_config = UserConfig::default();
7471         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7472         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7473         let chanmon_cfgs = create_chanmon_cfgs(2);
7474         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7475         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7476         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7477
7478         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7479         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7480                 match error {
7481                         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())); },
7482                         _ => panic!("Unexpected event"),
7483                 }
7484         } else { assert!(false) }
7485
7486         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7487         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7488         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7489         open_channel.to_self_delay = 200;
7490         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7491                 match error {
7492                         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()));  },
7493                         _ => panic!("Unexpected event"),
7494                 }
7495         } else { assert!(false); }
7496
7497         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7498         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7499         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()));
7500         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7501         accept_channel.to_self_delay = 200;
7502         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7503         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7504                 match action {
7505                         &ErrorAction::SendErrorMessage { ref msg } => {
7506                                 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()));
7507                         },
7508                         _ => { assert!(false); }
7509                 }
7510         } else { assert!(false); }
7511
7512         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7513         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7514         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7515         open_channel.to_self_delay = 200;
7516         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7517                 match error {
7518                         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())); },
7519                         _ => panic!("Unexpected event"),
7520                 }
7521         } else { assert!(false); }
7522 }
7523
7524 #[test]
7525 fn test_data_loss_protect() {
7526         // We want to be sure that :
7527         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7528         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7529         // * we close channel in case of detecting other being fallen behind
7530         // * we are able to claim our own outputs thanks to to_remote being static
7531         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7532         let persister;
7533         let logger;
7534         let fee_estimator;
7535         let tx_broadcaster;
7536         let chain_source;
7537         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7538         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7539         // during signing due to revoked tx
7540         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7541         let keys_manager = &chanmon_cfgs[0].keys_manager;
7542         let monitor;
7543         let node_state_0;
7544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7546         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7547
7548         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7549
7550         // Cache node A state before any channel update
7551         let previous_node_state = nodes[0].node.encode();
7552         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7553         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7554
7555         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7556         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7557
7558         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7559         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7560
7561         // Restore node A from previous state
7562         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7563         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7564         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7565         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7566         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7567         persister = test_utils::TestPersister::new();
7568         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7569         node_state_0 = {
7570                 let mut channel_monitors = HashMap::new();
7571                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7572                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7573                         keys_manager: keys_manager,
7574                         fee_estimator: &fee_estimator,
7575                         chain_monitor: &monitor,
7576                         logger: &logger,
7577                         tx_broadcaster: &tx_broadcaster,
7578                         default_config: UserConfig::default(),
7579                         channel_monitors,
7580                 }).unwrap().1
7581         };
7582         nodes[0].node = &node_state_0;
7583         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7584         nodes[0].chain_monitor = &monitor;
7585         nodes[0].chain_source = &chain_source;
7586
7587         check_added_monitors!(nodes[0], 1);
7588
7589         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7590         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7591
7592         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7593
7594         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7595         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7596         check_added_monitors!(nodes[0], 1);
7597
7598         {
7599                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7600                 assert_eq!(node_txn.len(), 0);
7601         }
7602
7603         let mut reestablish_1 = Vec::with_capacity(1);
7604         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7605                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7606                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7607                         reestablish_1.push(msg.clone());
7608                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7609                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7610                         match action {
7611                                 &ErrorAction::SendErrorMessage { ref msg } => {
7612                                         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");
7613                                 },
7614                                 _ => panic!("Unexpected event!"),
7615                         }
7616                 } else {
7617                         panic!("Unexpected event")
7618                 }
7619         }
7620
7621         // Check we close channel detecting A is fallen-behind
7622         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7623         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7624         check_added_monitors!(nodes[1], 1);
7625
7626
7627         // Check A is able to claim to_remote output
7628         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7629         assert_eq!(node_txn.len(), 1);
7630         check_spends!(node_txn[0], chan.3);
7631         assert_eq!(node_txn[0].output.len(), 2);
7632         mine_transaction(&nodes[0], &node_txn[0]);
7633         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7634         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7635         assert_eq!(spend_txn.len(), 1);
7636         check_spends!(spend_txn[0], node_txn[0]);
7637 }
7638
7639 #[test]
7640 fn test_check_htlc_underpaying() {
7641         // Send payment through A -> B but A is maliciously
7642         // sending a probe payment (i.e less than expected value0
7643         // to B, B should refuse payment.
7644
7645         let chanmon_cfgs = create_chanmon_cfgs(2);
7646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7648         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7649
7650         // Create some initial channels
7651         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7652
7653         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7654         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7655         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7656         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7657         check_added_monitors!(nodes[0], 1);
7658
7659         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7660         assert_eq!(events.len(), 1);
7661         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7662         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7663         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7664
7665         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7666         // and then will wait a second random delay before failing the HTLC back:
7667         expect_pending_htlcs_forwardable!(nodes[1]);
7668         expect_pending_htlcs_forwardable!(nodes[1]);
7669
7670         // Node 3 is expecting payment of 100_000 but received 10_000,
7671         // it should fail htlc like we didn't know the preimage.
7672         nodes[1].node.process_pending_htlc_forwards();
7673
7674         let events = nodes[1].node.get_and_clear_pending_msg_events();
7675         assert_eq!(events.len(), 1);
7676         let (update_fail_htlc, commitment_signed) = match events[0] {
7677                 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 } } => {
7678                         assert!(update_add_htlcs.is_empty());
7679                         assert!(update_fulfill_htlcs.is_empty());
7680                         assert_eq!(update_fail_htlcs.len(), 1);
7681                         assert!(update_fail_malformed_htlcs.is_empty());
7682                         assert!(update_fee.is_none());
7683                         (update_fail_htlcs[0].clone(), commitment_signed)
7684                 },
7685                 _ => panic!("Unexpected event"),
7686         };
7687         check_added_monitors!(nodes[1], 1);
7688
7689         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7690         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7691
7692         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7693         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7694         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7695         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7696 }
7697
7698 #[test]
7699 fn test_announce_disable_channels() {
7700         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7701         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7702
7703         let chanmon_cfgs = create_chanmon_cfgs(2);
7704         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7706         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7707
7708         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7709         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7710         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7711
7712         // Disconnect peers
7713         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7714         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7715
7716         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7717         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7718         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7719         assert_eq!(msg_events.len(), 3);
7720         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7721         for e in msg_events {
7722                 match e {
7723                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7724                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7725                                 // Check that each channel gets updated exactly once
7726                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7727                                         panic!("Generated ChannelUpdate for wrong chan!");
7728                                 }
7729                         },
7730                         _ => panic!("Unexpected event"),
7731                 }
7732         }
7733         // Reconnect peers
7734         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7735         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7736         assert_eq!(reestablish_1.len(), 3);
7737         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7738         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7739         assert_eq!(reestablish_2.len(), 3);
7740
7741         // Reestablish chan_1
7742         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7743         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7744         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7745         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7746         // Reestablish chan_2
7747         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7748         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7749         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7750         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7751         // Reestablish chan_3
7752         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7753         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7754         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7755         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7756
7757         nodes[0].node.timer_tick_occurred();
7758         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7759         nodes[0].node.timer_tick_occurred();
7760         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7761         assert_eq!(msg_events.len(), 3);
7762         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7763         for e in msg_events {
7764                 match e {
7765                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7766                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7767                                 // Check that each channel gets updated exactly once
7768                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7769                                         panic!("Generated ChannelUpdate for wrong chan!");
7770                                 }
7771                         },
7772                         _ => panic!("Unexpected event"),
7773                 }
7774         }
7775 }
7776
7777 #[test]
7778 fn test_bump_penalty_txn_on_revoked_commitment() {
7779         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7780         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7781
7782         let chanmon_cfgs = create_chanmon_cfgs(2);
7783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7785         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7786
7787         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7788         let logger = test_utils::TestLogger::new();
7789
7790         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7791         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7792         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7793         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7794
7795         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7796         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7797         assert_eq!(revoked_txn[0].output.len(), 4);
7798         assert_eq!(revoked_txn[0].input.len(), 1);
7799         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7800         let revoked_txid = revoked_txn[0].txid();
7801
7802         let mut penalty_sum = 0;
7803         for outp in revoked_txn[0].output.iter() {
7804                 if outp.script_pubkey.is_v0_p2wsh() {
7805                         penalty_sum += outp.value;
7806                 }
7807         }
7808
7809         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7810         let header_114 = connect_blocks(&nodes[1], 14);
7811
7812         // Actually revoke tx by claiming a HTLC
7813         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7814         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7815         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7816         check_added_monitors!(nodes[1], 1);
7817
7818         // One or more justice tx should have been broadcast, check it
7819         let penalty_1;
7820         let feerate_1;
7821         {
7822                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7823                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7824                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7825                 assert_eq!(node_txn[0].output.len(), 1);
7826                 check_spends!(node_txn[0], revoked_txn[0]);
7827                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7828                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7829                 penalty_1 = node_txn[0].txid();
7830                 node_txn.clear();
7831         };
7832
7833         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7834         connect_blocks(&nodes[1], 15);
7835         let mut penalty_2 = penalty_1;
7836         let mut feerate_2 = 0;
7837         {
7838                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7839                 assert_eq!(node_txn.len(), 1);
7840                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7841                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7842                         assert_eq!(node_txn[0].output.len(), 1);
7843                         check_spends!(node_txn[0], revoked_txn[0]);
7844                         penalty_2 = node_txn[0].txid();
7845                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7846                         assert_ne!(penalty_2, penalty_1);
7847                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7848                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7849                         // Verify 25% bump heuristic
7850                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7851                         node_txn.clear();
7852                 }
7853         }
7854         assert_ne!(feerate_2, 0);
7855
7856         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7857         connect_blocks(&nodes[1], 1);
7858         let penalty_3;
7859         let mut feerate_3 = 0;
7860         {
7861                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7862                 assert_eq!(node_txn.len(), 1);
7863                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7864                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7865                         assert_eq!(node_txn[0].output.len(), 1);
7866                         check_spends!(node_txn[0], revoked_txn[0]);
7867                         penalty_3 = node_txn[0].txid();
7868                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7869                         assert_ne!(penalty_3, penalty_2);
7870                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7871                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7872                         // Verify 25% bump heuristic
7873                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7874                         node_txn.clear();
7875                 }
7876         }
7877         assert_ne!(feerate_3, 0);
7878
7879         nodes[1].node.get_and_clear_pending_events();
7880         nodes[1].node.get_and_clear_pending_msg_events();
7881 }
7882
7883 #[test]
7884 fn test_bump_penalty_txn_on_revoked_htlcs() {
7885         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7886         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7887
7888         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7889         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7892         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7893
7894         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7895         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7896         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7897                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7898         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7899         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
7900                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7901         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7902
7903         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7904         assert_eq!(revoked_local_txn[0].input.len(), 1);
7905         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7906
7907         // Revoke local commitment tx
7908         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7909
7910         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7911         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7912         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7913         check_closed_broadcast!(nodes[1], true);
7914         check_added_monitors!(nodes[1], 1);
7915
7916         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7917         assert_eq!(revoked_htlc_txn.len(), 4);
7918         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7919                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7920                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7921                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7922                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7923                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7924                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7925         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7926                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7927                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7928                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7929                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7930                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7931                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7932         }
7933
7934         // Broadcast set of revoked txn on A
7935         let hash_128 = connect_blocks(&nodes[0], 40);
7936         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7937         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7938         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7939         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7940         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7941         let first;
7942         let feerate_1;
7943         let penalty_txn;
7944         {
7945                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7946                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7947                 // Verify claim tx are spending revoked HTLC txn
7948
7949                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7950                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7951                 // which are included in the same block (they are broadcasted because we scan the
7952                 // transactions linearly and generate claims as we go, they likely should be removed in the
7953                 // future).
7954                 assert_eq!(node_txn[0].input.len(), 1);
7955                 check_spends!(node_txn[0], revoked_local_txn[0]);
7956                 assert_eq!(node_txn[1].input.len(), 1);
7957                 check_spends!(node_txn[1], revoked_local_txn[0]);
7958                 assert_eq!(node_txn[2].input.len(), 1);
7959                 check_spends!(node_txn[2], revoked_local_txn[0]);
7960
7961                 // Each of the three justice transactions claim a separate (single) output of the three
7962                 // available, which we check here:
7963                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7964                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7965                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7966
7967                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7968                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7969
7970                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7971                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7972                 // a remote commitment tx has already been confirmed).
7973                 check_spends!(node_txn[3], chan.3);
7974
7975                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7976                 // output, checked above).
7977                 assert_eq!(node_txn[4].input.len(), 2);
7978                 assert_eq!(node_txn[4].output.len(), 1);
7979                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7980
7981                 first = node_txn[4].txid();
7982                 // Store both feerates for later comparison
7983                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7984                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7985                 penalty_txn = vec![node_txn[2].clone()];
7986                 node_txn.clear();
7987         }
7988
7989         // Connect one more block to see if bumped penalty are issued for HTLC txn
7990         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7991         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7992         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7993         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7994         {
7995                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7996                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7997
7998                 check_spends!(node_txn[0], revoked_local_txn[0]);
7999                 check_spends!(node_txn[1], revoked_local_txn[0]);
8000                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8001                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8002                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8003                 } else {
8004                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8005                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8006                 }
8007
8008                 node_txn.clear();
8009         };
8010
8011         // Few more blocks to confirm penalty txn
8012         connect_blocks(&nodes[0], 4);
8013         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8014         let header_144 = connect_blocks(&nodes[0], 9);
8015         let node_txn = {
8016                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8017                 assert_eq!(node_txn.len(), 1);
8018
8019                 assert_eq!(node_txn[0].input.len(), 2);
8020                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8021                 // Verify bumped tx is different and 25% bump heuristic
8022                 assert_ne!(first, node_txn[0].txid());
8023                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8024                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8025                 assert!(feerate_2 * 100 > feerate_1 * 125);
8026                 let txn = vec![node_txn[0].clone()];
8027                 node_txn.clear();
8028                 txn
8029         };
8030         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8031         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8032         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8033         connect_blocks(&nodes[0], 20);
8034         {
8035                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8036                 // We verify than no new transaction has been broadcast because previously
8037                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8038                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8039                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8040                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8041                 // up bumped justice generation.
8042                 assert_eq!(node_txn.len(), 0);
8043                 node_txn.clear();
8044         }
8045         check_closed_broadcast!(nodes[0], true);
8046         check_added_monitors!(nodes[0], 1);
8047 }
8048
8049 #[test]
8050 fn test_bump_penalty_txn_on_remote_commitment() {
8051         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8052         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8053
8054         // Create 2 HTLCs
8055         // Provide preimage for one
8056         // Check aggregation
8057
8058         let chanmon_cfgs = create_chanmon_cfgs(2);
8059         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8060         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8061         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8062
8063         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8064         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8065         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8066
8067         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8068         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8069         assert_eq!(remote_txn[0].output.len(), 4);
8070         assert_eq!(remote_txn[0].input.len(), 1);
8071         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8072
8073         // Claim a HTLC without revocation (provide B monitor with preimage)
8074         nodes[1].node.claim_funds(payment_preimage);
8075         mine_transaction(&nodes[1], &remote_txn[0]);
8076         check_added_monitors!(nodes[1], 2);
8077
8078         // One or more claim tx should have been broadcast, check it
8079         let timeout;
8080         let preimage;
8081         let feerate_timeout;
8082         let feerate_preimage;
8083         {
8084                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8085                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8086                 assert_eq!(node_txn[0].input.len(), 1);
8087                 assert_eq!(node_txn[1].input.len(), 1);
8088                 check_spends!(node_txn[0], remote_txn[0]);
8089                 check_spends!(node_txn[1], remote_txn[0]);
8090                 check_spends!(node_txn[2], chan.3);
8091                 check_spends!(node_txn[3], node_txn[2]);
8092                 check_spends!(node_txn[4], node_txn[2]);
8093                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8094                         timeout = node_txn[0].txid();
8095                         let index = node_txn[0].input[0].previous_output.vout;
8096                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8097                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8098
8099                         preimage = node_txn[1].txid();
8100                         let index = node_txn[1].input[0].previous_output.vout;
8101                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8102                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8103                 } else {
8104                         timeout = node_txn[1].txid();
8105                         let index = node_txn[1].input[0].previous_output.vout;
8106                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8107                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8108
8109                         preimage = node_txn[0].txid();
8110                         let index = node_txn[0].input[0].previous_output.vout;
8111                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8112                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8113                 }
8114                 node_txn.clear();
8115         };
8116         assert_ne!(feerate_timeout, 0);
8117         assert_ne!(feerate_preimage, 0);
8118
8119         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8120         connect_blocks(&nodes[1], 15);
8121         {
8122                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8123                 assert_eq!(node_txn.len(), 2);
8124                 assert_eq!(node_txn[0].input.len(), 1);
8125                 assert_eq!(node_txn[1].input.len(), 1);
8126                 check_spends!(node_txn[0], remote_txn[0]);
8127                 check_spends!(node_txn[1], remote_txn[0]);
8128                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8129                         let index = node_txn[0].input[0].previous_output.vout;
8130                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8131                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8132                         assert!(new_feerate * 100 > feerate_timeout * 125);
8133                         assert_ne!(timeout, node_txn[0].txid());
8134
8135                         let index = node_txn[1].input[0].previous_output.vout;
8136                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8137                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8138                         assert!(new_feerate * 100 > feerate_preimage * 125);
8139                         assert_ne!(preimage, node_txn[1].txid());
8140                 } else {
8141                         let index = node_txn[1].input[0].previous_output.vout;
8142                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8143                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8144                         assert!(new_feerate * 100 > feerate_timeout * 125);
8145                         assert_ne!(timeout, node_txn[1].txid());
8146
8147                         let index = node_txn[0].input[0].previous_output.vout;
8148                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8149                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8150                         assert!(new_feerate * 100 > feerate_preimage * 125);
8151                         assert_ne!(preimage, node_txn[0].txid());
8152                 }
8153                 node_txn.clear();
8154         }
8155
8156         nodes[1].node.get_and_clear_pending_events();
8157         nodes[1].node.get_and_clear_pending_msg_events();
8158 }
8159
8160 #[test]
8161 fn test_counterparty_raa_skip_no_crash() {
8162         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8163         // commitment transaction, we would have happily carried on and provided them the next
8164         // commitment transaction based on one RAA forward. This would probably eventually have led to
8165         // channel closure, but it would not have resulted in funds loss. Still, our
8166         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8167         // check simply that the channel is closed in response to such an RAA, but don't check whether
8168         // we decide to punish our counterparty for revoking their funds (as we don't currently
8169         // implement that).
8170         let chanmon_cfgs = create_chanmon_cfgs(2);
8171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8174         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8175
8176         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8177         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8178         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8179         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8180         // Must revoke without gaps
8181         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8182         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8183                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
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);
8212
8213         // Broadcast set of revoked txn on A
8214         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8215         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8216         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8217
8218         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8219         check_closed_broadcast!(nodes[0], true);
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: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8232         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8233         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8234         {
8235                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8236                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8237                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8238                         assert!(monitor.inner.lock().unwrap().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_mpp() {
8282         // Simple test of sending a multi-path payment.
8283         let chanmon_cfgs = create_chanmon_cfgs(4);
8284         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8285         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8286         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8287
8288         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8289         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8290         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8291         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8292         let logger = test_utils::TestLogger::new();
8293
8294         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8295         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8296         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8297         let path = route.paths[0].clone();
8298         route.paths.push(path);
8299         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8300         route.paths[0][0].short_channel_id = chan_1_id;
8301         route.paths[0][1].short_channel_id = chan_3_id;
8302         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8303         route.paths[1][0].short_channel_id = chan_2_id;
8304         route.paths[1][1].short_channel_id = chan_4_id;
8305         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8306         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8307 }
8308
8309 #[test]
8310 fn test_preimage_storage() {
8311         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8312         let chanmon_cfgs = create_chanmon_cfgs(2);
8313         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8314         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8315         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8316
8317         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8318
8319         {
8320                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8321
8322                 let logger = test_utils::TestLogger::new();
8323                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8324                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8325                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8326                 check_added_monitors!(nodes[0], 1);
8327                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8328                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8329                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8330                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8331         }
8332         // Note that after leaving the above scope we have no knowledge of any arguments or return
8333         // values from previous calls.
8334         expect_pending_htlcs_forwardable!(nodes[1]);
8335         let events = nodes[1].node.get_and_clear_pending_events();
8336         assert_eq!(events.len(), 1);
8337         match events[0] {
8338                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8339                         assert_eq!(user_payment_id, 42);
8340                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8341                 },
8342                 _ => panic!("Unexpected event"),
8343         }
8344 }
8345
8346 #[test]
8347 fn test_secret_timeout() {
8348         // Simple test of payment secret storage time outs
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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8353
8354         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8355
8356         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8357
8358         // We should fail to register the same payment hash twice, at least until we've connected a
8359         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8360         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8361                 assert_eq!(err, "Duplicate payment hash");
8362         } else { panic!(); }
8363         let mut block = Block {
8364                 header: BlockHeader {
8365                         version: 0x2000000,
8366                         prev_blockhash: nodes[1].blocks.borrow().last().unwrap().0.block_hash(),
8367                         merkle_root: Default::default(),
8368                         time: nodes[1].blocks.borrow().len() as u32 + 7200, bits: 42, nonce: 42 },
8369                 txdata: vec![],
8370         };
8371         connect_block(&nodes[1], &block);
8372         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8373                 assert_eq!(err, "Duplicate payment hash");
8374         } else { panic!(); }
8375
8376         // If we then connect the second block, we should be able to register the same payment hash
8377         // again with a different user_payment_id (this time getting a new payment secret).
8378         block.header.prev_blockhash = block.header.block_hash();
8379         block.header.time += 1;
8380         connect_block(&nodes[1], &block);
8381         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8382         assert_ne!(payment_secret_1, our_payment_secret);
8383
8384         {
8385                 let logger = test_utils::TestLogger::new();
8386                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8387                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8388                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8389                 check_added_monitors!(nodes[0], 1);
8390                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8391                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8392                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8393                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8394         }
8395         // Note that after leaving the above scope we have no knowledge of any arguments or return
8396         // values from previous calls.
8397         expect_pending_htlcs_forwardable!(nodes[1]);
8398         let events = nodes[1].node.get_and_clear_pending_events();
8399         assert_eq!(events.len(), 1);
8400         match events[0] {
8401                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8402                         assert!(payment_preimage.is_none());
8403                         assert_eq!(user_payment_id, 42);
8404                         assert_eq!(payment_secret, our_payment_secret);
8405                         // We don't actually have the payment preimage with which to claim this payment!
8406                 },
8407                 _ => panic!("Unexpected event"),
8408         }
8409 }
8410
8411 #[test]
8412 fn test_bad_secret_hash() {
8413         // Simple test of unregistered payment hash/invalid payment secret handling
8414         let chanmon_cfgs = create_chanmon_cfgs(2);
8415         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8416         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8417         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8418
8419         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8420
8421         let random_payment_hash = PaymentHash([42; 32]);
8422         let random_payment_secret = PaymentSecret([43; 32]);
8423         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8424
8425         let logger = test_utils::TestLogger::new();
8426         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8427         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8428
8429         // All the below cases should end up being handled exactly identically, so we macro the
8430         // resulting events.
8431         macro_rules! handle_unknown_invalid_payment_data {
8432                 () => {
8433                         check_added_monitors!(nodes[0], 1);
8434                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8435                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8436                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8437                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8438
8439                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8440                         // again to process the pending backwards-failure of the HTLC
8441                         expect_pending_htlcs_forwardable!(nodes[1]);
8442                         expect_pending_htlcs_forwardable!(nodes[1]);
8443                         check_added_monitors!(nodes[1], 1);
8444
8445                         // We should fail the payment back
8446                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8447                         match events.pop().unwrap() {
8448                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8449                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8450                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8451                                 },
8452                                 _ => panic!("Unexpected event"),
8453                         }
8454                 }
8455         }
8456
8457         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8458         // Error data is the HTLC value (100,000) and current block height
8459         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8460
8461         // Send a payment with the right payment hash but the wrong payment secret
8462         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8463         handle_unknown_invalid_payment_data!();
8464         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8465
8466         // Send a payment with a random payment hash, but the right payment secret
8467         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8468         handle_unknown_invalid_payment_data!();
8469         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8470
8471         // Send a payment with a random payment hash and random payment secret
8472         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8473         handle_unknown_invalid_payment_data!();
8474         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8475 }
8476
8477 #[test]
8478 fn test_update_err_monitor_lockdown() {
8479         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8480         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8481         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8482         //
8483         // This scenario may happen in a watchtower setup, where watchtower process a block height
8484         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8485         // commitment at same time.
8486
8487         let chanmon_cfgs = create_chanmon_cfgs(2);
8488         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8489         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8490         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8491
8492         // Create some initial channel
8493         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8494         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8495
8496         // Rebalance the network to generate htlc in the two directions
8497         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8498
8499         // Route a HTLC from node 0 to node 1 (but don't settle)
8500         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8501
8502         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8503         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8504         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8505         let persister = test_utils::TestPersister::new();
8506         let watchtower = {
8507                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8508                 let monitor = monitors.get(&outpoint).unwrap();
8509                 let mut w = test_utils::TestVecWriter(Vec::new());
8510                 monitor.write(&mut w).unwrap();
8511                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8512                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8513                 assert!(new_monitor == *monitor);
8514                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8515                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8516                 watchtower
8517         };
8518         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8519         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8520
8521         // Try to update ChannelMonitor
8522         assert!(nodes[1].node.claim_funds(preimage));
8523         check_added_monitors!(nodes[1], 1);
8524         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8525         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8526         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8527         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8528                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8529                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8530                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8531                 } else { assert!(false); }
8532         } else { assert!(false); };
8533         // Our local monitor is in-sync and hasn't processed yet timeout
8534         check_added_monitors!(nodes[0], 1);
8535         let events = nodes[0].node.get_and_clear_pending_events();
8536         assert_eq!(events.len(), 1);
8537 }
8538
8539 #[test]
8540 fn test_concurrent_monitor_claim() {
8541         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8542         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8543         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8544         // state N+1 confirms. Alice claims output from state N+1.
8545
8546         let chanmon_cfgs = create_chanmon_cfgs(2);
8547         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8548         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8549         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8550
8551         // Create some initial channel
8552         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8553         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8554
8555         // Rebalance the network to generate htlc in the two directions
8556         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8557
8558         // Route a HTLC from node 0 to node 1 (but don't settle)
8559         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8560
8561         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8562         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8563         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8564         let persister = test_utils::TestPersister::new();
8565         let watchtower_alice = {
8566                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8567                 let monitor = monitors.get(&outpoint).unwrap();
8568                 let mut w = test_utils::TestVecWriter(Vec::new());
8569                 monitor.write(&mut w).unwrap();
8570                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8571                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8572                 assert!(new_monitor == *monitor);
8573                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8574                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8575                 watchtower
8576         };
8577         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8578         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8579
8580         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8581         {
8582                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8583                 assert_eq!(txn.len(), 2);
8584                 txn.clear();
8585         }
8586
8587         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8588         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8589         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8590         let persister = test_utils::TestPersister::new();
8591         let watchtower_bob = {
8592                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8593                 let monitor = monitors.get(&outpoint).unwrap();
8594                 let mut w = test_utils::TestVecWriter(Vec::new());
8595                 monitor.write(&mut w).unwrap();
8596                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8597                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8598                 assert!(new_monitor == *monitor);
8599                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8600                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8601                 watchtower
8602         };
8603         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8604         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8605
8606         // Route another payment to generate another update with still previous HTLC pending
8607         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8608         {
8609                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8610                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8611                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8612         }
8613         check_added_monitors!(nodes[1], 1);
8614
8615         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8616         assert_eq!(updates.update_add_htlcs.len(), 1);
8617         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8618         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8619                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8620                         // Watchtower Alice should already have seen the block and reject the update
8621                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8622                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8623                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8624                 } else { assert!(false); }
8625         } else { assert!(false); };
8626         // Our local monitor is in-sync and hasn't processed yet timeout
8627         check_added_monitors!(nodes[0], 1);
8628
8629         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8630         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8631         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8632
8633         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8634         let bob_state_y;
8635         {
8636                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8637                 assert_eq!(txn.len(), 2);
8638                 bob_state_y = txn[0].clone();
8639                 txn.clear();
8640         };
8641
8642         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8643         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8644         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![bob_state_y.clone()] }, CHAN_CONFIRM_DEPTH + 2 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8645         {
8646                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8647                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8648                 // the onchain detection of the HTLC output
8649                 assert_eq!(htlc_txn.len(), 2);
8650                 check_spends!(htlc_txn[0], bob_state_y);
8651                 check_spends!(htlc_txn[1], bob_state_y);
8652         }
8653 }
8654
8655 #[test]
8656 fn test_pre_lockin_no_chan_closed_update() {
8657         // Test that if a peer closes a channel in response to a funding_created message we don't
8658         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8659         // message).
8660         //
8661         // Doing so would imply a channel monitor update before the initial channel monitor
8662         // registration, violating our API guarantees.
8663         //
8664         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8665         // then opening a second channel with the same funding output as the first (which is not
8666         // rejected because the first channel does not exist in the ChannelManager) and closing it
8667         // before receiving funding_signed.
8668         let chanmon_cfgs = create_chanmon_cfgs(2);
8669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8671         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8672
8673         // Create an initial channel
8674         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8675         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8676         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8677         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8678         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8679
8680         // Move the first channel through the funding flow...
8681         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8682
8683         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8684         check_added_monitors!(nodes[0], 0);
8685
8686         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8687         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8688         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8689         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8690 }
8691
8692 #[test]
8693 fn test_htlc_no_detection() {
8694         // This test is a mutation to underscore the detection logic bug we had
8695         // before #653. HTLC value routed is above the remaining balance, thus
8696         // inverting HTLC and `to_remote` output. HTLC will come second and
8697         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8698         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8699         // outputs order detection for correct spending children filtring.
8700
8701         let chanmon_cfgs = create_chanmon_cfgs(2);
8702         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8703         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8704         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8705
8706         // Create some initial channels
8707         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8708
8709         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8710         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8711         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8712         assert_eq!(local_txn[0].input.len(), 1);
8713         assert_eq!(local_txn[0].output.len(), 3);
8714         check_spends!(local_txn[0], chan_1.3);
8715
8716         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8717         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8718         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8719         // We deliberately connect the local tx twice as this should provoke a failure calling
8720         // this test before #653 fix.
8721         chain::Listen::block_connected(&nodes[0].chain_monitor.chain_monitor, &Block { header, txdata: vec![local_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
8722         check_closed_broadcast!(nodes[0], true);
8723         check_added_monitors!(nodes[0], 1);
8724
8725         let htlc_timeout = {
8726                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8727                 assert_eq!(node_txn[0].input.len(), 1);
8728                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8729                 check_spends!(node_txn[0], local_txn[0]);
8730                 node_txn[0].clone()
8731         };
8732
8733         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8734         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8735         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8736         expect_payment_failed!(nodes[0], our_payment_hash, true);
8737 }
8738
8739 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8740         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8741         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8742         // Carol, Alice would be the upstream node, and Carol the downstream.)
8743         //
8744         // Steps of the test:
8745         // 1) Alice sends a HTLC to Carol through Bob.
8746         // 2) Carol doesn't settle the HTLC.
8747         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8748         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8749         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8750         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8751         // 5) Carol release the preimage to Bob off-chain.
8752         // 6) Bob claims the offered output on the broadcasted commitment.
8753         let chanmon_cfgs = create_chanmon_cfgs(3);
8754         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8755         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8756         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8757
8758         // Create some initial channels
8759         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8760         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8761
8762         // Steps (1) and (2):
8763         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8764         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8765
8766         // Check that Alice's commitment transaction now contains an output for this HTLC.
8767         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8768         check_spends!(alice_txn[0], chan_ab.3);
8769         assert_eq!(alice_txn[0].output.len(), 2);
8770         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8771         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8772         assert_eq!(alice_txn.len(), 2);
8773
8774         // Steps (3) and (4):
8775         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8776         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8777         let mut force_closing_node = 0; // Alice force-closes
8778         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8779         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8780         check_closed_broadcast!(nodes[force_closing_node], true);
8781         check_added_monitors!(nodes[force_closing_node], 1);
8782         if go_onchain_before_fulfill {
8783                 let txn_to_broadcast = match broadcast_alice {
8784                         true => alice_txn.clone(),
8785                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8786                 };
8787                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8788                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8789                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8790                 if broadcast_alice {
8791                         check_closed_broadcast!(nodes[1], true);
8792                         check_added_monitors!(nodes[1], 1);
8793                 }
8794                 assert_eq!(bob_txn.len(), 1);
8795                 check_spends!(bob_txn[0], chan_ab.3);
8796         }
8797
8798         // Step (5):
8799         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8800         // process of removing the HTLC from their commitment transactions.
8801         assert!(nodes[2].node.claim_funds(payment_preimage));
8802         check_added_monitors!(nodes[2], 1);
8803         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8804         assert!(carol_updates.update_add_htlcs.is_empty());
8805         assert!(carol_updates.update_fail_htlcs.is_empty());
8806         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8807         assert!(carol_updates.update_fee.is_none());
8808         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8809
8810         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8811         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8812         if !go_onchain_before_fulfill && broadcast_alice {
8813                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8814                 assert_eq!(events.len(), 1);
8815                 match events[0] {
8816                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8817                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8818                         },
8819                         _ => panic!("Unexpected event"),
8820                 };
8821         }
8822         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8823         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8824         // Carol<->Bob's updated commitment transaction info.
8825         check_added_monitors!(nodes[1], 2);
8826
8827         let events = nodes[1].node.get_and_clear_pending_msg_events();
8828         assert_eq!(events.len(), 2);
8829         let bob_revocation = match events[0] {
8830                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8831                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8832                         (*msg).clone()
8833                 },
8834                 _ => panic!("Unexpected event"),
8835         };
8836         let bob_updates = match events[1] {
8837                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8838                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8839                         (*updates).clone()
8840                 },
8841                 _ => panic!("Unexpected event"),
8842         };
8843
8844         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8845         check_added_monitors!(nodes[2], 1);
8846         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8847         check_added_monitors!(nodes[2], 1);
8848
8849         let events = nodes[2].node.get_and_clear_pending_msg_events();
8850         assert_eq!(events.len(), 1);
8851         let carol_revocation = match events[0] {
8852                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8853                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8854                         (*msg).clone()
8855                 },
8856                 _ => panic!("Unexpected event"),
8857         };
8858         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8859         check_added_monitors!(nodes[1], 1);
8860
8861         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8862         // here's where we put said channel's commitment tx on-chain.
8863         let mut txn_to_broadcast = alice_txn.clone();
8864         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8865         if !go_onchain_before_fulfill {
8866                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8867                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8868                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8869                 if broadcast_alice {
8870                         check_closed_broadcast!(nodes[1], true);
8871                         check_added_monitors!(nodes[1], 1);
8872                 }
8873                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8874                 if broadcast_alice {
8875                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8876                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8877                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8878                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8879                         // broadcasted.
8880                         assert_eq!(bob_txn.len(), 3);
8881                         check_spends!(bob_txn[1], chan_ab.3);
8882                 } else {
8883                         assert_eq!(bob_txn.len(), 2);
8884                         check_spends!(bob_txn[0], chan_ab.3);
8885                 }
8886         }
8887
8888         // Step (6):
8889         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8890         // broadcasted commitment transaction.
8891         {
8892                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8893                 if go_onchain_before_fulfill {
8894                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8895                         assert_eq!(bob_txn.len(), 2);
8896                 }
8897                 let script_weight = match broadcast_alice {
8898                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8899                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8900                 };
8901                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8902                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8903                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8904                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8905                 if broadcast_alice && !go_onchain_before_fulfill {
8906                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8907                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8908                 } else {
8909                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8910                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8911                 }
8912         }
8913 }
8914
8915 #[test]
8916 fn test_onchain_htlc_settlement_after_close() {
8917         do_test_onchain_htlc_settlement_after_close(true, true);
8918         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8919         do_test_onchain_htlc_settlement_after_close(true, false);
8920         do_test_onchain_htlc_settlement_after_close(false, false);
8921 }
8922
8923 #[test]
8924 fn test_duplicate_chan_id() {
8925         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8926         // already open we reject it and keep the old channel.
8927         //
8928         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8929         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8930         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8931         // updating logic for the existing channel.
8932         let chanmon_cfgs = create_chanmon_cfgs(2);
8933         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8934         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8935         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8936
8937         // Create an initial channel
8938         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8939         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8940         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8941         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8942
8943         // Try to create a second channel with the same temporary_channel_id as the first and check
8944         // that it is rejected.
8945         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8946         {
8947                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8948                 assert_eq!(events.len(), 1);
8949                 match events[0] {
8950                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8951                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8952                                 // first (valid) and second (invalid) channels are closed, given they both have
8953                                 // the same non-temporary channel_id. However, currently we do not, so we just
8954                                 // move forward with it.
8955                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8956                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8957                         },
8958                         _ => panic!("Unexpected event"),
8959                 }
8960         }
8961
8962         // Move the first channel through the funding flow...
8963         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8964
8965         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8966         check_added_monitors!(nodes[0], 0);
8967
8968         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8969         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8970         {
8971                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8972                 assert_eq!(added_monitors.len(), 1);
8973                 assert_eq!(added_monitors[0].0, funding_output);
8974                 added_monitors.clear();
8975         }
8976         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8977
8978         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8979         let channel_id = funding_outpoint.to_channel_id();
8980
8981         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8982         // temporary one).
8983
8984         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8985         // Technically this is allowed by the spec, but we don't support it and there's little reason
8986         // to. Still, it shouldn't cause any other issues.
8987         open_chan_msg.temporary_channel_id = channel_id;
8988         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8989         {
8990                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8991                 assert_eq!(events.len(), 1);
8992                 match events[0] {
8993                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8994                                 // Technically, at this point, nodes[1] would be justified in thinking both
8995                                 // channels are closed, but currently we do not, so we just move forward with it.
8996                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8997                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8998                         },
8999                         _ => panic!("Unexpected event"),
9000                 }
9001         }
9002
9003         // Now try to create a second channel which has a duplicate funding output.
9004         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9005         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9006         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9007         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9008         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9009
9010         let funding_created = {
9011                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9012                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9013                 let logger = test_utils::TestLogger::new();
9014                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9015         };
9016         check_added_monitors!(nodes[0], 0);
9017         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9018         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9019         // still needs to be cleared here.
9020         check_added_monitors!(nodes[1], 1);
9021
9022         // ...still, nodes[1] will reject the duplicate channel.
9023         {
9024                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9025                 assert_eq!(events.len(), 1);
9026                 match events[0] {
9027                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9028                                 // Technically, at this point, nodes[1] would be justified in thinking both
9029                                 // channels are closed, but currently we do not, so we just move forward with it.
9030                                 assert_eq!(msg.channel_id, channel_id);
9031                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9032                         },
9033                         _ => panic!("Unexpected event"),
9034                 }
9035         }
9036
9037         // finally, finish creating the original channel and send a payment over it to make sure
9038         // everything is functional.
9039         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9040         {
9041                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9042                 assert_eq!(added_monitors.len(), 1);
9043                 assert_eq!(added_monitors[0].0, funding_output);
9044                 added_monitors.clear();
9045         }
9046
9047         let events_4 = nodes[0].node.get_and_clear_pending_events();
9048         assert_eq!(events_4.len(), 0);
9049         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9050         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9051
9052         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9053         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9054         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9055         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9056 }
9057
9058 #[test]
9059 fn test_error_chans_closed() {
9060         // Test that we properly handle error messages, closing appropriate channels.
9061         //
9062         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9063         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9064         // we can test various edge cases around it to ensure we don't regress.
9065         let chanmon_cfgs = create_chanmon_cfgs(3);
9066         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9067         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9068         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9069
9070         // Create some initial channels
9071         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9072         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9073         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9074
9075         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9076         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9077         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9078
9079         // Closing a channel from a different peer has no effect
9080         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9081         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9082
9083         // Closing one channel doesn't impact others
9084         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9085         check_added_monitors!(nodes[0], 1);
9086         check_closed_broadcast!(nodes[0], false);
9087         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9088         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9089         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_1.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_1.2);
9090         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_3.2);
9091
9092         // A null channel ID should close all channels
9093         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9094         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9095         check_added_monitors!(nodes[0], 2);
9096         let events = nodes[0].node.get_and_clear_pending_msg_events();
9097         assert_eq!(events.len(), 2);
9098         match events[0] {
9099                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9100                         assert_eq!(msg.contents.flags & 2, 2);
9101                 },
9102                 _ => panic!("Unexpected event"),
9103         }
9104         match events[1] {
9105                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9106                         assert_eq!(msg.contents.flags & 2, 2);
9107                 },
9108                 _ => panic!("Unexpected event"),
9109         }
9110         // Note that at this point users of a standard PeerHandler will end up calling
9111         // peer_disconnected with no_connection_possible set to false, duplicating the
9112         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9113         // users with their own peer handling logic. We duplicate the call here, however.
9114         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9115         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9116
9117         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9118         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9119         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9120 }
9121
9122 #[test]
9123 fn test_invalid_funding_tx() {
9124         // Test that we properly handle invalid funding transactions sent to us from a peer.
9125         //
9126         // Previously, all other major lightning implementations had failed to properly sanitize
9127         // funding transactions from their counterparties, leading to a multi-implementation critical
9128         // security vulnerability (though we always sanitized properly, we've previously had
9129         // un-released crashes in the sanitization process).
9130         let chanmon_cfgs = create_chanmon_cfgs(2);
9131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9133         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9134
9135         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9136         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()));
9137         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9138
9139         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9140         for output in tx.output.iter_mut() {
9141                 // Make the confirmed funding transaction have a bogus script_pubkey
9142                 output.script_pubkey = bitcoin::Script::new();
9143         }
9144
9145         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9146         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
9147         check_added_monitors!(nodes[1], 1);
9148
9149         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
9150         check_added_monitors!(nodes[0], 1);
9151
9152         let events_1 = nodes[0].node.get_and_clear_pending_events();
9153         assert_eq!(events_1.len(), 0);
9154
9155         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9156         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9157         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9158
9159         confirm_transaction_at(&nodes[1], &tx, 1);
9160         check_added_monitors!(nodes[1], 1);
9161         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9162         assert_eq!(events_2.len(), 1);
9163         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9164                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9165                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9166                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9167                 } else { panic!(); }
9168         } else { panic!(); }
9169         assert_eq!(nodes[1].node.list_channels().len(), 0);
9170 }