_ 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_simple_peer_disconnect() {
3501         // Test that we can reconnect when there are no lost messages
3502         let chanmon_cfgs = create_chanmon_cfgs(3);
3503         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3504         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3505         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3506         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3507         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3508
3509         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3510         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3511         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3512
3513         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3514         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3515         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3516         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3517
3518         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3519         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3520         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3521
3522         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3523         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3524         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3525         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3526
3527         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3528         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3529
3530         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3531         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3532
3533         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3534         {
3535                 let events = nodes[0].node.get_and_clear_pending_events();
3536                 assert_eq!(events.len(), 2);
3537                 match events[0] {
3538                         Event::PaymentSent { payment_preimage } => {
3539                                 assert_eq!(payment_preimage, payment_preimage_3);
3540                         },
3541                         _ => panic!("Unexpected event"),
3542                 }
3543                 match events[1] {
3544                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3545                                 assert_eq!(payment_hash, payment_hash_5);
3546                                 assert!(rejected_by_dest);
3547                         },
3548                         _ => panic!("Unexpected event"),
3549                 }
3550         }
3551
3552         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3553         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3554 }
3555
3556 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3557         // Test that we can reconnect when in-flight HTLC updates get dropped
3558         let chanmon_cfgs = create_chanmon_cfgs(2);
3559         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3560         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3561         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3562         if messages_delivered == 0 {
3563                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3564                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3565         } else {
3566                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3567         }
3568
3569         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3570
3571         let logger = test_utils::TestLogger::new();
3572         let payment_event = {
3573                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3574                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3575                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3576                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3577                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3578                 check_added_monitors!(nodes[0], 1);
3579
3580                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3581                 assert_eq!(events.len(), 1);
3582                 SendEvent::from_event(events.remove(0))
3583         };
3584         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3585
3586         if messages_delivered < 2 {
3587                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3588         } else {
3589                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3590                 if messages_delivered >= 3 {
3591                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3592                         check_added_monitors!(nodes[1], 1);
3593                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3594
3595                         if messages_delivered >= 4 {
3596                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3597                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3598                                 check_added_monitors!(nodes[0], 1);
3599
3600                                 if messages_delivered >= 5 {
3601                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3602                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3603                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3604                                         check_added_monitors!(nodes[0], 1);
3605
3606                                         if messages_delivered >= 6 {
3607                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3608                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3609                                                 check_added_monitors!(nodes[1], 1);
3610                                         }
3611                                 }
3612                         }
3613                 }
3614         }
3615
3616         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3617         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3618         if messages_delivered < 3 {
3619                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3620                 // received on either side, both sides will need to resend them.
3621                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3622         } else if messages_delivered == 3 {
3623                 // nodes[0] still wants its RAA + commitment_signed
3624                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3625         } else if messages_delivered == 4 {
3626                 // nodes[0] still wants its commitment_signed
3627                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3628         } else if messages_delivered == 5 {
3629                 // nodes[1] still wants its final RAA
3630                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3631         } else if messages_delivered == 6 {
3632                 // Everything was delivered...
3633                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3634         }
3635
3636         let events_1 = nodes[1].node.get_and_clear_pending_events();
3637         assert_eq!(events_1.len(), 1);
3638         match events_1[0] {
3639                 Event::PendingHTLCsForwardable { .. } => { },
3640                 _ => panic!("Unexpected event"),
3641         };
3642
3643         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3644         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3645         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3646
3647         nodes[1].node.process_pending_htlc_forwards();
3648
3649         let events_2 = nodes[1].node.get_and_clear_pending_events();
3650         assert_eq!(events_2.len(), 1);
3651         match events_2[0] {
3652                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3653                         assert_eq!(payment_hash_1, *payment_hash);
3654                         assert!(payment_preimage.is_none());
3655                         assert_eq!(payment_secret_1, *payment_secret);
3656                         assert_eq!(amt, 1000000);
3657                 },
3658                 _ => panic!("Unexpected event"),
3659         }
3660
3661         nodes[1].node.claim_funds(payment_preimage_1);
3662         check_added_monitors!(nodes[1], 1);
3663
3664         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3665         assert_eq!(events_3.len(), 1);
3666         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3667                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3668                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3669                         assert!(updates.update_add_htlcs.is_empty());
3670                         assert!(updates.update_fail_htlcs.is_empty());
3671                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3672                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3673                         assert!(updates.update_fee.is_none());
3674                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3675                 },
3676                 _ => panic!("Unexpected event"),
3677         };
3678
3679         if messages_delivered >= 1 {
3680                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3681
3682                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3683                 assert_eq!(events_4.len(), 1);
3684                 match events_4[0] {
3685                         Event::PaymentSent { ref payment_preimage } => {
3686                                 assert_eq!(payment_preimage_1, *payment_preimage);
3687                         },
3688                         _ => panic!("Unexpected event"),
3689                 }
3690
3691                 if messages_delivered >= 2 {
3692                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3693                         check_added_monitors!(nodes[0], 1);
3694                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3695
3696                         if messages_delivered >= 3 {
3697                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3698                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3699                                 check_added_monitors!(nodes[1], 1);
3700
3701                                 if messages_delivered >= 4 {
3702                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3703                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3704                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3705                                         check_added_monitors!(nodes[1], 1);
3706
3707                                         if messages_delivered >= 5 {
3708                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3709                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3710                                                 check_added_monitors!(nodes[0], 1);
3711                                         }
3712                                 }
3713                         }
3714                 }
3715         }
3716
3717         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3718         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3719         if messages_delivered < 2 {
3720                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3721                 //TODO: Deduplicate PaymentSent events, then enable this if:
3722                 //if messages_delivered < 1 {
3723                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3724                         assert_eq!(events_4.len(), 1);
3725                         match events_4[0] {
3726                                 Event::PaymentSent { ref payment_preimage } => {
3727                                         assert_eq!(payment_preimage_1, *payment_preimage);
3728                                 },
3729                                 _ => panic!("Unexpected event"),
3730                         }
3731                 //}
3732         } else if messages_delivered == 2 {
3733                 // nodes[0] still wants its RAA + commitment_signed
3734                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3735         } else if messages_delivered == 3 {
3736                 // nodes[0] still wants its commitment_signed
3737                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3738         } else if messages_delivered == 4 {
3739                 // nodes[1] still wants its final RAA
3740                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3741         } else if messages_delivered == 5 {
3742                 // Everything was delivered...
3743                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3744         }
3745
3746         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3747         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3748         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3749
3750         // Channel should still work fine...
3751         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3752         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3753                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3754                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3755         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3756         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3757 }
3758
3759 #[test]
3760 fn test_drop_messages_peer_disconnect_a() {
3761         do_test_drop_messages_peer_disconnect(0);
3762         do_test_drop_messages_peer_disconnect(1);
3763         do_test_drop_messages_peer_disconnect(2);
3764         do_test_drop_messages_peer_disconnect(3);
3765 }
3766
3767 #[test]
3768 fn test_drop_messages_peer_disconnect_b() {
3769         do_test_drop_messages_peer_disconnect(4);
3770         do_test_drop_messages_peer_disconnect(5);
3771         do_test_drop_messages_peer_disconnect(6);
3772 }
3773
3774 #[test]
3775 fn test_funding_peer_disconnect() {
3776         // Test that we can lock in our funding tx while disconnected
3777         let chanmon_cfgs = create_chanmon_cfgs(2);
3778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3780         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3781         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3782
3783         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3784         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3785
3786         confirm_transaction(&nodes[0], &tx);
3787         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3788         assert_eq!(events_1.len(), 1);
3789         match events_1[0] {
3790                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3791                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3792                 },
3793                 _ => panic!("Unexpected event"),
3794         }
3795
3796         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3797
3798         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3799         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3800
3801         confirm_transaction(&nodes[1], &tx);
3802         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3803         assert_eq!(events_2.len(), 2);
3804         let funding_locked = match events_2[0] {
3805                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3806                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3807                         msg.clone()
3808                 },
3809                 _ => panic!("Unexpected event"),
3810         };
3811         let bs_announcement_sigs = match events_2[1] {
3812                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3813                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3814                         msg.clone()
3815                 },
3816                 _ => panic!("Unexpected event"),
3817         };
3818
3819         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3820
3821         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3822         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3823         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3824         assert_eq!(events_3.len(), 2);
3825         let as_announcement_sigs = match events_3[0] {
3826                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3827                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3828                         msg.clone()
3829                 },
3830                 _ => panic!("Unexpected event"),
3831         };
3832         let (as_announcement, as_update) = match events_3[1] {
3833                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3834                         (msg.clone(), update_msg.clone())
3835                 },
3836                 _ => panic!("Unexpected event"),
3837         };
3838
3839         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3840         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3841         assert_eq!(events_4.len(), 1);
3842         let (_, bs_update) = match events_4[0] {
3843                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3844                         (msg.clone(), update_msg.clone())
3845                 },
3846                 _ => panic!("Unexpected event"),
3847         };
3848
3849         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3850         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3851         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3852
3853         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3854         let logger = test_utils::TestLogger::new();
3855         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();
3856         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3857         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3858 }
3859
3860 #[test]
3861 fn test_drop_messages_peer_disconnect_dual_htlc() {
3862         // Test that we can handle reconnecting when both sides of a channel have pending
3863         // commitment_updates when we disconnect.
3864         let chanmon_cfgs = create_chanmon_cfgs(2);
3865         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3866         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3867         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3868         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3869         let logger = test_utils::TestLogger::new();
3870
3871         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3872
3873         // Now try to send a second payment which will fail to send
3874         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3875         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3876         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();
3877         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3878         check_added_monitors!(nodes[0], 1);
3879
3880         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3881         assert_eq!(events_1.len(), 1);
3882         match events_1[0] {
3883                 MessageSendEvent::UpdateHTLCs { .. } => {},
3884                 _ => panic!("Unexpected event"),
3885         }
3886
3887         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3888         check_added_monitors!(nodes[1], 1);
3889
3890         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3891         assert_eq!(events_2.len(), 1);
3892         match events_2[0] {
3893                 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 } } => {
3894                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3895                         assert!(update_add_htlcs.is_empty());
3896                         assert_eq!(update_fulfill_htlcs.len(), 1);
3897                         assert!(update_fail_htlcs.is_empty());
3898                         assert!(update_fail_malformed_htlcs.is_empty());
3899                         assert!(update_fee.is_none());
3900
3901                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3902                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3903                         assert_eq!(events_3.len(), 1);
3904                         match events_3[0] {
3905                                 Event::PaymentSent { ref payment_preimage } => {
3906                                         assert_eq!(*payment_preimage, payment_preimage_1);
3907                                 },
3908                                 _ => panic!("Unexpected event"),
3909                         }
3910
3911                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3912                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3913                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3914                         check_added_monitors!(nodes[0], 1);
3915                 },
3916                 _ => panic!("Unexpected event"),
3917         }
3918
3919         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3920         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3921
3922         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3923         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3924         assert_eq!(reestablish_1.len(), 1);
3925         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3926         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3927         assert_eq!(reestablish_2.len(), 1);
3928
3929         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3930         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3931         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3932         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3933
3934         assert!(as_resp.0.is_none());
3935         assert!(bs_resp.0.is_none());
3936
3937         assert!(bs_resp.1.is_none());
3938         assert!(bs_resp.2.is_none());
3939
3940         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3941
3942         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3943         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3944         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3945         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3946         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3947         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3948         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3949         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3950         // No commitment_signed so get_event_msg's assert(len == 1) passes
3951         check_added_monitors!(nodes[1], 1);
3952
3953         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3954         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3955         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3956         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3957         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3958         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3959         assert!(bs_second_commitment_signed.update_fee.is_none());
3960         check_added_monitors!(nodes[1], 1);
3961
3962         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3963         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3964         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3965         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3966         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3967         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3968         assert!(as_commitment_signed.update_fee.is_none());
3969         check_added_monitors!(nodes[0], 1);
3970
3971         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3972         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3973         // No commitment_signed so get_event_msg's assert(len == 1) passes
3974         check_added_monitors!(nodes[0], 1);
3975
3976         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3977         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3978         // No commitment_signed so get_event_msg's assert(len == 1) passes
3979         check_added_monitors!(nodes[1], 1);
3980
3981         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3982         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3983         check_added_monitors!(nodes[1], 1);
3984
3985         expect_pending_htlcs_forwardable!(nodes[1]);
3986
3987         let events_5 = nodes[1].node.get_and_clear_pending_events();
3988         assert_eq!(events_5.len(), 1);
3989         match events_5[0] {
3990                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
3991                         assert_eq!(payment_hash_2, *payment_hash);
3992                         assert!(payment_preimage.is_none());
3993                         assert_eq!(payment_secret_2, *payment_secret);
3994                 },
3995                 _ => panic!("Unexpected event"),
3996         }
3997
3998         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3999         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4000         check_added_monitors!(nodes[0], 1);
4001
4002         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4003 }
4004
4005 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4006         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4007         // to avoid our counterparty failing the channel.
4008         let chanmon_cfgs = create_chanmon_cfgs(2);
4009         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4010         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4011         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4012
4013         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4014         let logger = test_utils::TestLogger::new();
4015
4016         let our_payment_hash = if send_partial_mpp {
4017                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4018                 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();
4019                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4020                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4021                 // indicates there are more HTLCs coming.
4022                 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.
4023                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4024                 check_added_monitors!(nodes[0], 1);
4025                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4026                 assert_eq!(events.len(), 1);
4027                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4028                 // hop should *not* yet generate any PaymentReceived event(s).
4029                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4030                 our_payment_hash
4031         } else {
4032                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4033         };
4034
4035         let mut block = Block {
4036                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4037                 txdata: vec![],
4038         };
4039         connect_block(&nodes[0], &block);
4040         connect_block(&nodes[1], &block);
4041         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4042         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4043                 block.header.prev_blockhash = block.block_hash();
4044                 connect_block(&nodes[0], &block);
4045                 connect_block(&nodes[1], &block);
4046         }
4047
4048         expect_pending_htlcs_forwardable!(nodes[1]);
4049
4050         check_added_monitors!(nodes[1], 1);
4051         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4052         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4053         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4054         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4055         assert!(htlc_timeout_updates.update_fee.is_none());
4056
4057         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4058         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4059         // 100_000 msat as u64, followed by the height at which we failed back above
4060         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4061         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4062         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4063 }
4064
4065 #[test]
4066 fn test_htlc_timeout() {
4067         do_test_htlc_timeout(true);
4068         do_test_htlc_timeout(false);
4069 }
4070
4071 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4072         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4073         let chanmon_cfgs = create_chanmon_cfgs(3);
4074         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4075         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4076         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4077         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4078         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4079
4080         // Make sure all nodes are at the same starting height
4081         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4082         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4083         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4084
4085         let logger = test_utils::TestLogger::new();
4086
4087         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4088         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4089         {
4090                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4091                 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();
4092                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4093         }
4094         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4095         check_added_monitors!(nodes[1], 1);
4096
4097         // Now attempt to route a second payment, which should be placed in the holding cell
4098         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4099         if forwarded_htlc {
4100                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4101                 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();
4102                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4103                 check_added_monitors!(nodes[0], 1);
4104                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4105                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4106                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4107                 expect_pending_htlcs_forwardable!(nodes[1]);
4108                 check_added_monitors!(nodes[1], 0);
4109         } else {
4110                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4111                 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();
4112                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4113                 check_added_monitors!(nodes[1], 0);
4114         }
4115
4116         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4117         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4118         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4119         connect_blocks(&nodes[1], 1);
4120
4121         if forwarded_htlc {
4122                 expect_pending_htlcs_forwardable!(nodes[1]);
4123                 check_added_monitors!(nodes[1], 1);
4124                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4125                 assert_eq!(fail_commit.len(), 1);
4126                 match fail_commit[0] {
4127                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4128                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4129                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4130                         },
4131                         _ => unreachable!(),
4132                 }
4133                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4134                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4135                         match update {
4136                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4137                                 _ => panic!("Unexpected event"),
4138                         }
4139                 } else {
4140                         panic!("Unexpected event");
4141                 }
4142         } else {
4143                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4144         }
4145 }
4146
4147 #[test]
4148 fn test_holding_cell_htlc_add_timeouts() {
4149         do_test_holding_cell_htlc_add_timeouts(false);
4150         do_test_holding_cell_htlc_add_timeouts(true);
4151 }
4152
4153 #[test]
4154 fn test_invalid_channel_announcement() {
4155         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4156         let secp_ctx = Secp256k1::new();
4157         let chanmon_cfgs = create_chanmon_cfgs(2);
4158         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4159         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4160         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4161
4162         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4163
4164         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4165         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4166         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4167         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4168
4169         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 } );
4170
4171         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4172         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4173
4174         let as_network_key = nodes[0].node.get_our_node_id();
4175         let bs_network_key = nodes[1].node.get_our_node_id();
4176
4177         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4178
4179         let mut chan_announcement;
4180
4181         macro_rules! dummy_unsigned_msg {
4182                 () => {
4183                         msgs::UnsignedChannelAnnouncement {
4184                                 features: ChannelFeatures::known(),
4185                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4186                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4187                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4188                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4189                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4190                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4191                                 excess_data: Vec::new(),
4192                         };
4193                 }
4194         }
4195
4196         macro_rules! sign_msg {
4197                 ($unsigned_msg: expr) => {
4198                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4199                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4200                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4201                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4202                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4203                         chan_announcement = msgs::ChannelAnnouncement {
4204                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4205                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4206                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4207                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4208                                 contents: $unsigned_msg
4209                         }
4210                 }
4211         }
4212
4213         let unsigned_msg = dummy_unsigned_msg!();
4214         sign_msg!(unsigned_msg);
4215         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4216         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 } );
4217
4218         // Configured with Network::Testnet
4219         let mut unsigned_msg = dummy_unsigned_msg!();
4220         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4221         sign_msg!(unsigned_msg);
4222         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4223
4224         let mut unsigned_msg = dummy_unsigned_msg!();
4225         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4226         sign_msg!(unsigned_msg);
4227         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4228 }
4229
4230 #[test]
4231 fn test_no_txn_manager_serialize_deserialize() {
4232         let chanmon_cfgs = create_chanmon_cfgs(2);
4233         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4234         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4235         let logger: test_utils::TestLogger;
4236         let fee_estimator: test_utils::TestFeeEstimator;
4237         let persister: test_utils::TestPersister;
4238         let new_chain_monitor: test_utils::TestChainMonitor;
4239         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4240         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4241
4242         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4243
4244         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4245
4246         let nodes_0_serialized = nodes[0].node.encode();
4247         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4248         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4249
4250         logger = test_utils::TestLogger::new();
4251         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4252         persister = test_utils::TestPersister::new();
4253         let keys_manager = &chanmon_cfgs[0].keys_manager;
4254         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4255         nodes[0].chain_monitor = &new_chain_monitor;
4256         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4257         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4258                 &mut chan_0_monitor_read, keys_manager).unwrap();
4259         assert!(chan_0_monitor_read.is_empty());
4260
4261         let mut nodes_0_read = &nodes_0_serialized[..];
4262         let config = UserConfig::default();
4263         let (_, nodes_0_deserialized_tmp) = {
4264                 let mut channel_monitors = HashMap::new();
4265                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4266                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4267                         default_config: config,
4268                         keys_manager,
4269                         fee_estimator: &fee_estimator,
4270                         chain_monitor: nodes[0].chain_monitor,
4271                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4272                         logger: &logger,
4273                         channel_monitors,
4274                 }).unwrap()
4275         };
4276         nodes_0_deserialized = nodes_0_deserialized_tmp;
4277         assert!(nodes_0_read.is_empty());
4278
4279         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4280         nodes[0].node = &nodes_0_deserialized;
4281         assert_eq!(nodes[0].node.list_channels().len(), 1);
4282         check_added_monitors!(nodes[0], 1);
4283
4284         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4285         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4286         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4287         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4288
4289         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4290         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4291         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4292         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4293
4294         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4295         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4296         for node in nodes.iter() {
4297                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4298                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4299                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4300         }
4301
4302         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4303 }
4304
4305 #[test]
4306 fn test_dup_htlc_onchain_fails_on_reload() {
4307         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4308         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4309         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4310         // the ChannelMonitor tells it to.
4311         //
4312         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4313         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4314         // PaymentFailed event appearing). However, because we may not serialize the relevant
4315         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4316         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4317         // and de-duplicates ChannelMonitor events.
4318         //
4319         // This tests that explicit tracking behavior.
4320         let chanmon_cfgs = create_chanmon_cfgs(2);
4321         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4322         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4323         let persister: test_utils::TestPersister;
4324         let new_chain_monitor: test_utils::TestChainMonitor;
4325         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4326         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4327
4328         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4329
4330         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4331         // nodes[0].
4332         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4333         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4334         check_closed_broadcast!(nodes[0], true);
4335         check_added_monitors!(nodes[0], 1);
4336
4337         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4338         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4339
4340         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4341         assert_eq!(node_txn.len(), 2);
4342
4343         assert!(nodes[1].node.claim_funds(payment_preimage));
4344         check_added_monitors!(nodes[1], 1);
4345
4346         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4347         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
4348         check_closed_broadcast!(nodes[1], true);
4349         check_added_monitors!(nodes[1], 1);
4350         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4351
4352         connect_block(&nodes[0], &Block { header, txdata: node_txn});
4353
4354         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4355         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4356         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4357         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4358         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4359
4360         header.prev_blockhash = header.block_hash();
4361         let claim_block = Block { header, txdata: claim_txn};
4362         connect_block(&nodes[0], &claim_block);
4363         expect_payment_sent!(nodes[0], payment_preimage);
4364
4365         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4366         // connected a highly-relevant block, it likely gets serialized out now.
4367         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4368         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4369
4370         // Now reload nodes[0]...
4371         persister = test_utils::TestPersister::new();
4372         let keys_manager = &chanmon_cfgs[0].keys_manager;
4373         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);
4374         nodes[0].chain_monitor = &new_chain_monitor;
4375         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4376         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4377                 &mut chan_0_monitor_read, keys_manager).unwrap();
4378         assert!(chan_0_monitor_read.is_empty());
4379
4380         let (_, nodes_0_deserialized_tmp) = {
4381                 let mut channel_monitors = HashMap::new();
4382                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4383                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4384                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4385                                 default_config: Default::default(),
4386                                 keys_manager,
4387                                 fee_estimator: node_cfgs[0].fee_estimator,
4388                                 chain_monitor: nodes[0].chain_monitor,
4389                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4390                                 logger: nodes[0].logger,
4391                                 channel_monitors,
4392                         }).unwrap()
4393         };
4394         nodes_0_deserialized = nodes_0_deserialized_tmp;
4395
4396         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4397         check_added_monitors!(nodes[0], 1);
4398         nodes[0].node = &nodes_0_deserialized;
4399
4400         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4401         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4402         // payment events should kick in, leaving us with no pending events here.
4403         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, nodes[0].blocks.borrow().len() as u32 - 1);
4404         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4405 }
4406
4407 #[test]
4408 fn test_manager_serialize_deserialize_events() {
4409         // This test makes sure the events field in ChannelManager survives de/serialization
4410         let chanmon_cfgs = create_chanmon_cfgs(2);
4411         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4412         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4413         let fee_estimator: test_utils::TestFeeEstimator;
4414         let persister: test_utils::TestPersister;
4415         let logger: test_utils::TestLogger;
4416         let new_chain_monitor: test_utils::TestChainMonitor;
4417         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4418         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4419
4420         // Start creating a channel, but stop right before broadcasting the funding transaction
4421         let channel_value = 100000;
4422         let push_msat = 10001;
4423         let a_flags = InitFeatures::known();
4424         let b_flags = InitFeatures::known();
4425         let node_a = nodes.remove(0);
4426         let node_b = nodes.remove(0);
4427         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4428         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()));
4429         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()));
4430
4431         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4432
4433         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4434         check_added_monitors!(node_a, 0);
4435
4436         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()));
4437         {
4438                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4439                 assert_eq!(added_monitors.len(), 1);
4440                 assert_eq!(added_monitors[0].0, funding_output);
4441                 added_monitors.clear();
4442         }
4443
4444         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()));
4445         {
4446                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4447                 assert_eq!(added_monitors.len(), 1);
4448                 assert_eq!(added_monitors[0].0, funding_output);
4449                 added_monitors.clear();
4450         }
4451         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4452
4453         nodes.push(node_a);
4454         nodes.push(node_b);
4455
4456         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4457         let nodes_0_serialized = nodes[0].node.encode();
4458         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4459         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4460
4461         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4462         logger = test_utils::TestLogger::new();
4463         persister = test_utils::TestPersister::new();
4464         let keys_manager = &chanmon_cfgs[0].keys_manager;
4465         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4466         nodes[0].chain_monitor = &new_chain_monitor;
4467         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4468         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4469                 &mut chan_0_monitor_read, keys_manager).unwrap();
4470         assert!(chan_0_monitor_read.is_empty());
4471
4472         let mut nodes_0_read = &nodes_0_serialized[..];
4473         let config = UserConfig::default();
4474         let (_, nodes_0_deserialized_tmp) = {
4475                 let mut channel_monitors = HashMap::new();
4476                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4477                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4478                         default_config: config,
4479                         keys_manager,
4480                         fee_estimator: &fee_estimator,
4481                         chain_monitor: nodes[0].chain_monitor,
4482                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4483                         logger: &logger,
4484                         channel_monitors,
4485                 }).unwrap()
4486         };
4487         nodes_0_deserialized = nodes_0_deserialized_tmp;
4488         assert!(nodes_0_read.is_empty());
4489
4490         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4491
4492         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4493         nodes[0].node = &nodes_0_deserialized;
4494
4495         // After deserializing, make sure the funding_transaction is still held by the channel manager
4496         let events_4 = nodes[0].node.get_and_clear_pending_events();
4497         assert_eq!(events_4.len(), 0);
4498         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4499         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4500
4501         // Make sure the channel is functioning as though the de/serialization never happened
4502         assert_eq!(nodes[0].node.list_channels().len(), 1);
4503         check_added_monitors!(nodes[0], 1);
4504
4505         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4506         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4507         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4508         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4509
4510         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4511         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4512         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4513         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4514
4515         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4516         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4517         for node in nodes.iter() {
4518                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4519                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4520                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4521         }
4522
4523         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4524 }
4525
4526 #[test]
4527 fn test_simple_manager_serialize_deserialize() {
4528         let chanmon_cfgs = create_chanmon_cfgs(2);
4529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4531         let logger: test_utils::TestLogger;
4532         let fee_estimator: test_utils::TestFeeEstimator;
4533         let persister: test_utils::TestPersister;
4534         let new_chain_monitor: test_utils::TestChainMonitor;
4535         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4537         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4538
4539         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4540         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4541
4542         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4543
4544         let nodes_0_serialized = nodes[0].node.encode();
4545         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4546         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4547
4548         logger = test_utils::TestLogger::new();
4549         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4550         persister = test_utils::TestPersister::new();
4551         let keys_manager = &chanmon_cfgs[0].keys_manager;
4552         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4553         nodes[0].chain_monitor = &new_chain_monitor;
4554         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4555         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4556                 &mut chan_0_monitor_read, keys_manager).unwrap();
4557         assert!(chan_0_monitor_read.is_empty());
4558
4559         let mut nodes_0_read = &nodes_0_serialized[..];
4560         let (_, nodes_0_deserialized_tmp) = {
4561                 let mut channel_monitors = HashMap::new();
4562                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4563                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4564                         default_config: UserConfig::default(),
4565                         keys_manager,
4566                         fee_estimator: &fee_estimator,
4567                         chain_monitor: nodes[0].chain_monitor,
4568                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4569                         logger: &logger,
4570                         channel_monitors,
4571                 }).unwrap()
4572         };
4573         nodes_0_deserialized = nodes_0_deserialized_tmp;
4574         assert!(nodes_0_read.is_empty());
4575
4576         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4577         nodes[0].node = &nodes_0_deserialized;
4578         check_added_monitors!(nodes[0], 1);
4579
4580         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4581
4582         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4583         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4584 }
4585
4586 #[test]
4587 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4588         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4589         let chanmon_cfgs = create_chanmon_cfgs(4);
4590         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4591         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4592         let logger: test_utils::TestLogger;
4593         let fee_estimator: test_utils::TestFeeEstimator;
4594         let persister: test_utils::TestPersister;
4595         let new_chain_monitor: test_utils::TestChainMonitor;
4596         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4597         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4598         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4599         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4600         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4601
4602         let mut node_0_stale_monitors_serialized = Vec::new();
4603         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4604                 let mut writer = test_utils::TestVecWriter(Vec::new());
4605                 monitor.1.write(&mut writer).unwrap();
4606                 node_0_stale_monitors_serialized.push(writer.0);
4607         }
4608
4609         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4610
4611         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4612         let nodes_0_serialized = nodes[0].node.encode();
4613
4614         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4615         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4616         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4617         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4618
4619         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4620         // nodes[3])
4621         let mut node_0_monitors_serialized = Vec::new();
4622         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4623                 let mut writer = test_utils::TestVecWriter(Vec::new());
4624                 monitor.1.write(&mut writer).unwrap();
4625                 node_0_monitors_serialized.push(writer.0);
4626         }
4627
4628         logger = test_utils::TestLogger::new();
4629         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4630         persister = test_utils::TestPersister::new();
4631         let keys_manager = &chanmon_cfgs[0].keys_manager;
4632         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4633         nodes[0].chain_monitor = &new_chain_monitor;
4634
4635
4636         let mut node_0_stale_monitors = Vec::new();
4637         for serialized in node_0_stale_monitors_serialized.iter() {
4638                 let mut read = &serialized[..];
4639                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4640                 assert!(read.is_empty());
4641                 node_0_stale_monitors.push(monitor);
4642         }
4643
4644         let mut node_0_monitors = Vec::new();
4645         for serialized in node_0_monitors_serialized.iter() {
4646                 let mut read = &serialized[..];
4647                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4648                 assert!(read.is_empty());
4649                 node_0_monitors.push(monitor);
4650         }
4651
4652         let mut nodes_0_read = &nodes_0_serialized[..];
4653         if let Err(msgs::DecodeError::InvalidValue) =
4654                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4655                 default_config: UserConfig::default(),
4656                 keys_manager,
4657                 fee_estimator: &fee_estimator,
4658                 chain_monitor: nodes[0].chain_monitor,
4659                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4660                 logger: &logger,
4661                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4662         }) { } else {
4663                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4664         };
4665
4666         let mut nodes_0_read = &nodes_0_serialized[..];
4667         let (_, nodes_0_deserialized_tmp) =
4668                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4669                 default_config: UserConfig::default(),
4670                 keys_manager,
4671                 fee_estimator: &fee_estimator,
4672                 chain_monitor: nodes[0].chain_monitor,
4673                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4674                 logger: &logger,
4675                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4676         }).unwrap();
4677         nodes_0_deserialized = nodes_0_deserialized_tmp;
4678         assert!(nodes_0_read.is_empty());
4679
4680         { // Channel close should result in a commitment tx and an HTLC tx
4681                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4682                 assert_eq!(txn.len(), 2);
4683                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4684                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4685         }
4686
4687         for monitor in node_0_monitors.drain(..) {
4688                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4689                 check_added_monitors!(nodes[0], 1);
4690         }
4691         nodes[0].node = &nodes_0_deserialized;
4692
4693         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4694         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4695         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4696         //... and we can even still claim the payment!
4697         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4698
4699         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4700         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4701         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4702         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4703         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4704         assert_eq!(msg_events.len(), 1);
4705         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4706                 match action {
4707                         &ErrorAction::SendErrorMessage { ref msg } => {
4708                                 assert_eq!(msg.channel_id, channel_id);
4709                         },
4710                         _ => panic!("Unexpected event!"),
4711                 }
4712         }
4713 }
4714
4715 macro_rules! check_spendable_outputs {
4716         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4717                 {
4718                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4719                         let mut txn = Vec::new();
4720                         let mut all_outputs = Vec::new();
4721                         let secp_ctx = Secp256k1::new();
4722                         for event in events.drain(..) {
4723                                 match event {
4724                                         Event::SpendableOutputs { mut outputs } => {
4725                                                 for outp in outputs.drain(..) {
4726                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4727                                                         all_outputs.push(outp);
4728                                                 }
4729                                         },
4730                                         _ => panic!("Unexpected event"),
4731                                 };
4732                         }
4733                         if all_outputs.len() > 1 {
4734                                 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) {
4735                                         txn.push(tx);
4736                                 }
4737                         }
4738                         txn
4739                 }
4740         }
4741 }
4742
4743 #[test]
4744 fn test_claim_sizeable_push_msat() {
4745         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4746         let chanmon_cfgs = create_chanmon_cfgs(2);
4747         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4748         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4749         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4750
4751         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4752         nodes[1].node.force_close_channel(&chan.2).unwrap();
4753         check_closed_broadcast!(nodes[1], true);
4754         check_added_monitors!(nodes[1], 1);
4755         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4756         assert_eq!(node_txn.len(), 1);
4757         check_spends!(node_txn[0], chan.3);
4758         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
4759
4760         mine_transaction(&nodes[1], &node_txn[0]);
4761         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4762
4763         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4764         assert_eq!(spend_txn.len(), 1);
4765         check_spends!(spend_txn[0], node_txn[0]);
4766 }
4767
4768 #[test]
4769 fn test_claim_on_remote_sizeable_push_msat() {
4770         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4771         // to_remote output is encumbered by a P2WPKH
4772         let chanmon_cfgs = create_chanmon_cfgs(2);
4773         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4774         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4775         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4776
4777         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4778         nodes[0].node.force_close_channel(&chan.2).unwrap();
4779         check_closed_broadcast!(nodes[0], true);
4780         check_added_monitors!(nodes[0], 1);
4781
4782         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4783         assert_eq!(node_txn.len(), 1);
4784         check_spends!(node_txn[0], chan.3);
4785         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
4786
4787         mine_transaction(&nodes[1], &node_txn[0]);
4788         check_closed_broadcast!(nodes[1], true);
4789         check_added_monitors!(nodes[1], 1);
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_revoked_sizeable_push_msat() {
4799         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4800         // to_remote output is encumbered by a P2WPKH
4801
4802         let chanmon_cfgs = create_chanmon_cfgs(2);
4803         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4804         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4805         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4806
4807         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4808         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4809         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4810         assert_eq!(revoked_local_txn[0].input.len(), 1);
4811         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4812
4813         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4814         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4815         check_closed_broadcast!(nodes[1], true);
4816         check_added_monitors!(nodes[1], 1);
4817
4818         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4819         mine_transaction(&nodes[1], &node_txn[0]);
4820         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4821
4822         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4823         assert_eq!(spend_txn.len(), 3);
4824         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4825         check_spends!(spend_txn[1], node_txn[0]);
4826         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4827 }
4828
4829 #[test]
4830 fn test_static_spendable_outputs_preimage_tx() {
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         // Create some initial channels
4837         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4838
4839         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4840
4841         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4842         assert_eq!(commitment_tx[0].input.len(), 1);
4843         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4844
4845         // Settle A's commitment tx on B's chain
4846         assert!(nodes[1].node.claim_funds(payment_preimage));
4847         check_added_monitors!(nodes[1], 1);
4848         mine_transaction(&nodes[1], &commitment_tx[0]);
4849         check_added_monitors!(nodes[1], 1);
4850         let events = nodes[1].node.get_and_clear_pending_msg_events();
4851         match events[0] {
4852                 MessageSendEvent::UpdateHTLCs { .. } => {},
4853                 _ => panic!("Unexpected event"),
4854         }
4855         match events[1] {
4856                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4857                 _ => panic!("Unexepected event"),
4858         }
4859
4860         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4861         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4862         assert_eq!(node_txn.len(), 3);
4863         check_spends!(node_txn[0], commitment_tx[0]);
4864         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4865         check_spends!(node_txn[1], chan_1.3);
4866         check_spends!(node_txn[2], node_txn[1]);
4867
4868         mine_transaction(&nodes[1], &node_txn[0]);
4869         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4870
4871         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4872         assert_eq!(spend_txn.len(), 1);
4873         check_spends!(spend_txn[0], node_txn[0]);
4874 }
4875
4876 #[test]
4877 fn test_static_spendable_outputs_timeout_tx() {
4878         let chanmon_cfgs = create_chanmon_cfgs(2);
4879         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4880         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4881         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4882
4883         // Create some initial channels
4884         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4885
4886         // Rebalance the network a bit by relaying one payment through all the channels ...
4887         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4888
4889         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4890
4891         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4892         assert_eq!(commitment_tx[0].input.len(), 1);
4893         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4894
4895         // Settle A's commitment tx on B' chain
4896         mine_transaction(&nodes[1], &commitment_tx[0]);
4897         check_added_monitors!(nodes[1], 1);
4898         let events = nodes[1].node.get_and_clear_pending_msg_events();
4899         match events[0] {
4900                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4901                 _ => panic!("Unexpected event"),
4902         }
4903
4904         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4905         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4906         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4907         check_spends!(node_txn[0],  commitment_tx[0].clone());
4908         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4909         check_spends!(node_txn[1], chan_1.3.clone());
4910         check_spends!(node_txn[2], node_txn[1]);
4911
4912         mine_transaction(&nodes[1], &node_txn[0]);
4913         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4914         expect_payment_failed!(nodes[1], our_payment_hash, true);
4915
4916         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4917         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4918         check_spends!(spend_txn[0], commitment_tx[0]);
4919         check_spends!(spend_txn[1], node_txn[0]);
4920         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4921 }
4922
4923 #[test]
4924 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4925         let chanmon_cfgs = create_chanmon_cfgs(2);
4926         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4927         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4928         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4929
4930         // Create some initial channels
4931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4932
4933         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4934         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4935         assert_eq!(revoked_local_txn[0].input.len(), 1);
4936         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4937
4938         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4939
4940         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4941         check_closed_broadcast!(nodes[1], true);
4942         check_added_monitors!(nodes[1], 1);
4943
4944         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4945         assert_eq!(node_txn.len(), 2);
4946         assert_eq!(node_txn[0].input.len(), 2);
4947         check_spends!(node_txn[0], revoked_local_txn[0]);
4948
4949         mine_transaction(&nodes[1], &node_txn[0]);
4950         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4951
4952         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4953         assert_eq!(spend_txn.len(), 1);
4954         check_spends!(spend_txn[0], node_txn[0]);
4955 }
4956
4957 #[test]
4958 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4959         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4960         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4961         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4962         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4963         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4964
4965         // Create some initial channels
4966         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4967
4968         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4969         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4970         assert_eq!(revoked_local_txn[0].input.len(), 1);
4971         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4972
4973         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4974
4975         // A will generate HTLC-Timeout from revoked commitment tx
4976         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4977         check_closed_broadcast!(nodes[0], true);
4978         check_added_monitors!(nodes[0], 1);
4979
4980         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4981         assert_eq!(revoked_htlc_txn.len(), 2);
4982         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4983         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4984         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4985         check_spends!(revoked_htlc_txn[1], chan_1.3);
4986
4987         // B will generate justice tx from A's revoked commitment/HTLC tx
4988         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4989         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4990         check_closed_broadcast!(nodes[1], true);
4991         check_added_monitors!(nodes[1], 1);
4992
4993         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4994         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4995         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4996         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4997         // transactions next...
4998         assert_eq!(node_txn[0].input.len(), 3);
4999         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5000
5001         assert_eq!(node_txn[1].input.len(), 2);
5002         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5003         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5004                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5005         } else {
5006                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5007                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5008         }
5009
5010         assert_eq!(node_txn[2].input.len(), 1);
5011         check_spends!(node_txn[2], chan_1.3);
5012
5013         mine_transaction(&nodes[1], &node_txn[1]);
5014         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5015
5016         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5017         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5018         assert_eq!(spend_txn.len(), 1);
5019         assert_eq!(spend_txn[0].input.len(), 1);
5020         check_spends!(spend_txn[0], node_txn[1]);
5021 }
5022
5023 #[test]
5024 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5025         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5026         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5027         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5028         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5029         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5030
5031         // Create some initial channels
5032         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5033
5034         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5035         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5036         assert_eq!(revoked_local_txn[0].input.len(), 1);
5037         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5038
5039         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5040         assert_eq!(revoked_local_txn[0].output.len(), 2);
5041
5042         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5043
5044         // B will generate HTLC-Success from revoked commitment tx
5045         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5046         check_closed_broadcast!(nodes[1], true);
5047         check_added_monitors!(nodes[1], 1);
5048         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5049
5050         assert_eq!(revoked_htlc_txn.len(), 2);
5051         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5052         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5053         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5054
5055         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5056         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5057         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5058
5059         // A will generate justice tx from B's revoked commitment/HTLC tx
5060         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5061         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5062         check_closed_broadcast!(nodes[0], true);
5063         check_added_monitors!(nodes[0], 1);
5064
5065         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5066         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5067
5068         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5069         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5070         // transactions next...
5071         assert_eq!(node_txn[0].input.len(), 2);
5072         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5073         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5074                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5075         } else {
5076                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5077                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5078         }
5079
5080         assert_eq!(node_txn[1].input.len(), 1);
5081         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5082
5083         check_spends!(node_txn[2], chan_1.3);
5084
5085         mine_transaction(&nodes[0], &node_txn[1]);
5086         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5087
5088         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5089         // didn't try to generate any new transactions.
5090
5091         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5092         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5093         assert_eq!(spend_txn.len(), 3);
5094         assert_eq!(spend_txn[0].input.len(), 1);
5095         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5096         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5097         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5098         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5099 }
5100
5101 #[test]
5102 fn test_onchain_to_onchain_claim() {
5103         // Test that in case of channel closure, we detect the state of output and claim HTLC
5104         // on downstream peer's remote commitment tx.
5105         // First, have C claim an HTLC against its own latest commitment transaction.
5106         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5107         // channel.
5108         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5109         // gets broadcast.
5110
5111         let chanmon_cfgs = create_chanmon_cfgs(3);
5112         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5113         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5114         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5115
5116         // Create some initial channels
5117         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5118         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5119
5120         // Rebalance the network a bit by relaying one payment through all the channels ...
5121         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5122         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5123
5124         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5125         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5126         check_spends!(commitment_tx[0], chan_2.3);
5127         nodes[2].node.claim_funds(payment_preimage);
5128         check_added_monitors!(nodes[2], 1);
5129         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5130         assert!(updates.update_add_htlcs.is_empty());
5131         assert!(updates.update_fail_htlcs.is_empty());
5132         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5133         assert!(updates.update_fail_malformed_htlcs.is_empty());
5134
5135         mine_transaction(&nodes[2], &commitment_tx[0]);
5136         check_closed_broadcast!(nodes[2], true);
5137         check_added_monitors!(nodes[2], 1);
5138
5139         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5140         assert_eq!(c_txn.len(), 3);
5141         assert_eq!(c_txn[0], c_txn[2]);
5142         assert_eq!(commitment_tx[0], c_txn[1]);
5143         check_spends!(c_txn[1], chan_2.3);
5144         check_spends!(c_txn[2], c_txn[1]);
5145         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5146         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5147         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5148         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5149
5150         // 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
5151         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5152         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5153         {
5154                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5155                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5156                 assert_eq!(b_txn.len(), 3);
5157                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5158                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5159                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5160                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5161                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5162                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5163                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5164                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5165                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5166                 b_txn.clear();
5167         }
5168         check_added_monitors!(nodes[1], 1);
5169         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5170         assert_eq!(msg_events.len(), 3);
5171         check_added_monitors!(nodes[1], 1);
5172         match msg_events[0] {
5173                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5174                 _ => panic!("Unexpected event"),
5175         }
5176         match msg_events[1] {
5177                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5178                 _ => panic!("Unexpected event"),
5179         }
5180         match msg_events[2] {
5181                 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, .. } } => {
5182                         assert!(update_add_htlcs.is_empty());
5183                         assert!(update_fail_htlcs.is_empty());
5184                         assert_eq!(update_fulfill_htlcs.len(), 1);
5185                         assert!(update_fail_malformed_htlcs.is_empty());
5186                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5187                 },
5188                 _ => panic!("Unexpected event"),
5189         };
5190         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5191         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5192         mine_transaction(&nodes[1], &commitment_tx[0]);
5193         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5194         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5195         assert_eq!(b_txn.len(), 3);
5196         check_spends!(b_txn[1], chan_1.3);
5197         check_spends!(b_txn[2], b_txn[1]);
5198         check_spends!(b_txn[0], commitment_tx[0]);
5199         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5200         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5201         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5202
5203         check_closed_broadcast!(nodes[1], true);
5204         check_added_monitors!(nodes[1], 1);
5205 }
5206
5207 #[test]
5208 fn test_duplicate_payment_hash_one_failure_one_success() {
5209         // Topology : A --> B --> C --> D
5210         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5211         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5212         // we forward one of the payments onwards to D.
5213         let chanmon_cfgs = create_chanmon_cfgs(4);
5214         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5215         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5216         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5217
5218         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5219         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5220         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5221
5222         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5223
5224         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5225         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5226                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5227         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5228
5229         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5230         assert_eq!(commitment_txn[0].input.len(), 1);
5231         check_spends!(commitment_txn[0], chan_2.3);
5232
5233         mine_transaction(&nodes[1], &commitment_txn[0]);
5234         check_closed_broadcast!(nodes[1], true);
5235         check_added_monitors!(nodes[1], 1);
5236
5237         let htlc_timeout_tx;
5238         { // Extract one of the two HTLC-Timeout transaction
5239                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5240                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5241                 assert_eq!(node_txn.len(), 5);
5242                 check_spends!(node_txn[0], commitment_txn[0]);
5243                 assert_eq!(node_txn[0].input.len(), 1);
5244                 check_spends!(node_txn[1], commitment_txn[0]);
5245                 assert_eq!(node_txn[1].input.len(), 1);
5246                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5247                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5248                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5249                 check_spends!(node_txn[2], chan_2.3);
5250                 check_spends!(node_txn[3], node_txn[2]);
5251                 check_spends!(node_txn[4], node_txn[2]);
5252                 htlc_timeout_tx = node_txn[1].clone();
5253         }
5254
5255         nodes[2].node.claim_funds(our_payment_preimage);
5256         mine_transaction(&nodes[2], &commitment_txn[0]);
5257         check_added_monitors!(nodes[2], 2);
5258         let events = nodes[2].node.get_and_clear_pending_msg_events();
5259         match events[0] {
5260                 MessageSendEvent::UpdateHTLCs { .. } => {},
5261                 _ => panic!("Unexpected event"),
5262         }
5263         match events[1] {
5264                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5265                 _ => panic!("Unexepected event"),
5266         }
5267         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5268         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)
5269         check_spends!(htlc_success_txn[2], chan_2.3);
5270         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5271         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5272         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5273         assert_eq!(htlc_success_txn[0].input.len(), 1);
5274         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5275         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5276         assert_eq!(htlc_success_txn[1].input.len(), 1);
5277         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5278         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5279         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5280         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5281
5282         mine_transaction(&nodes[1], &htlc_timeout_tx);
5283         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5284         expect_pending_htlcs_forwardable!(nodes[1]);
5285         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5286         assert!(htlc_updates.update_add_htlcs.is_empty());
5287         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5288         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5289         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5290         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5291         check_added_monitors!(nodes[1], 1);
5292
5293         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5294         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5295         {
5296                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5297                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5298                 assert_eq!(events.len(), 1);
5299                 match events[0] {
5300                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5301                         },
5302                         _ => { panic!("Unexpected event"); }
5303                 }
5304         }
5305         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5306
5307         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5308         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5309         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5310         assert!(updates.update_add_htlcs.is_empty());
5311         assert!(updates.update_fail_htlcs.is_empty());
5312         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5313         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5314         assert!(updates.update_fail_malformed_htlcs.is_empty());
5315         check_added_monitors!(nodes[1], 1);
5316
5317         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5318         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5319
5320         let events = nodes[0].node.get_and_clear_pending_events();
5321         match events[0] {
5322                 Event::PaymentSent { ref payment_preimage } => {
5323                         assert_eq!(*payment_preimage, our_payment_preimage);
5324                 }
5325                 _ => panic!("Unexpected event"),
5326         }
5327 }
5328
5329 #[test]
5330 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5331         let chanmon_cfgs = create_chanmon_cfgs(2);
5332         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5333         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5334         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5335
5336         // Create some initial channels
5337         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5338
5339         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5340         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5341         assert_eq!(local_txn.len(), 1);
5342         assert_eq!(local_txn[0].input.len(), 1);
5343         check_spends!(local_txn[0], chan_1.3);
5344
5345         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5346         nodes[1].node.claim_funds(payment_preimage);
5347         check_added_monitors!(nodes[1], 1);
5348         mine_transaction(&nodes[1], &local_txn[0]);
5349         check_added_monitors!(nodes[1], 1);
5350         let events = nodes[1].node.get_and_clear_pending_msg_events();
5351         match events[0] {
5352                 MessageSendEvent::UpdateHTLCs { .. } => {},
5353                 _ => panic!("Unexpected event"),
5354         }
5355         match events[1] {
5356                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5357                 _ => panic!("Unexepected event"),
5358         }
5359         let node_tx = {
5360                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5361                 assert_eq!(node_txn.len(), 3);
5362                 assert_eq!(node_txn[0], node_txn[2]);
5363                 assert_eq!(node_txn[1], local_txn[0]);
5364                 assert_eq!(node_txn[0].input.len(), 1);
5365                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5366                 check_spends!(node_txn[0], local_txn[0]);
5367                 node_txn[0].clone()
5368         };
5369
5370         mine_transaction(&nodes[1], &node_tx);
5371         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5372
5373         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5374         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5375         assert_eq!(spend_txn.len(), 1);
5376         check_spends!(spend_txn[0], node_tx);
5377 }
5378
5379 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5380         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5381         // unrevoked commitment transaction.
5382         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5383         // a remote RAA before they could be failed backwards (and combinations thereof).
5384         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5385         // use the same payment hashes.
5386         // Thus, we use a six-node network:
5387         //
5388         // A \         / E
5389         //    - C - D -
5390         // B /         \ F
5391         // And test where C fails back to A/B when D announces its latest commitment transaction
5392         let chanmon_cfgs = create_chanmon_cfgs(6);
5393         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5394         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5395         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5396         let logger = test_utils::TestLogger::new();
5397
5398         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5399         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5400         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5401         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5402         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5403
5404         // Rebalance and check output sanity...
5405         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5406         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5407         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5408
5409         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5410         // 0th HTLC:
5411         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
5412         // 1st HTLC:
5413         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
5414         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5415         let our_node_id = &nodes[1].node.get_our_node_id();
5416         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();
5417         // 2nd HTLC:
5418         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
5419         // 3rd HTLC:
5420         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
5421         // 4th HTLC:
5422         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5423         // 5th HTLC:
5424         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5425         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();
5426         // 6th HTLC:
5427         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());
5428         // 7th HTLC:
5429         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());
5430
5431         // 8th HTLC:
5432         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5433         // 9th HTLC:
5434         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();
5435         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
5436
5437         // 10th HTLC:
5438         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
5439         // 11th HTLC:
5440         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();
5441         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());
5442
5443         // Double-check that six of the new HTLC were added
5444         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5445         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5446         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5447         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5448
5449         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5450         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5451         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5452         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5453         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5454         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5455         check_added_monitors!(nodes[4], 0);
5456         expect_pending_htlcs_forwardable!(nodes[4]);
5457         check_added_monitors!(nodes[4], 1);
5458
5459         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5460         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5461         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5462         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5463         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5464         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5465
5466         // Fail 3rd below-dust and 7th above-dust HTLCs
5467         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5468         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5469         check_added_monitors!(nodes[5], 0);
5470         expect_pending_htlcs_forwardable!(nodes[5]);
5471         check_added_monitors!(nodes[5], 1);
5472
5473         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5474         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5475         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5476         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5477
5478         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5479
5480         expect_pending_htlcs_forwardable!(nodes[3]);
5481         check_added_monitors!(nodes[3], 1);
5482         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5483         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5484         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5485         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5486         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5487         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5488         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5489         if deliver_last_raa {
5490                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5491         } else {
5492                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5493         }
5494
5495         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5496         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5497         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5498         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5499         //
5500         // We now broadcast the latest commitment transaction, which *should* result in failures for
5501         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5502         // the non-broadcast above-dust HTLCs.
5503         //
5504         // Alternatively, we may broadcast the previous commitment transaction, which should only
5505         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5506         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5507
5508         if announce_latest {
5509                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5510         } else {
5511                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5512         }
5513         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5514         check_closed_broadcast!(nodes[2], true);
5515         expect_pending_htlcs_forwardable!(nodes[2]);
5516         check_added_monitors!(nodes[2], 3);
5517
5518         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5519         assert_eq!(cs_msgs.len(), 2);
5520         let mut a_done = false;
5521         for msg in cs_msgs {
5522                 match msg {
5523                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5524                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5525                                 // should be failed-backwards here.
5526                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5527                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5528                                         for htlc in &updates.update_fail_htlcs {
5529                                                 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 });
5530                                         }
5531                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5532                                         assert!(!a_done);
5533                                         a_done = true;
5534                                         &nodes[0]
5535                                 } else {
5536                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5537                                         for htlc in &updates.update_fail_htlcs {
5538                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5539                                         }
5540                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5541                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5542                                         &nodes[1]
5543                                 };
5544                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5545                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5546                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5547                                 if announce_latest {
5548                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5549                                         if *node_id == nodes[0].node.get_our_node_id() {
5550                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5551                                         }
5552                                 }
5553                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5554                         },
5555                         _ => panic!("Unexpected event"),
5556                 }
5557         }
5558
5559         let as_events = nodes[0].node.get_and_clear_pending_events();
5560         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5561         let mut as_failds = HashSet::new();
5562         for event in as_events.iter() {
5563                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5564                         assert!(as_failds.insert(*payment_hash));
5565                         if *payment_hash != payment_hash_2 {
5566                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5567                         } else {
5568                                 assert!(!rejected_by_dest);
5569                         }
5570                 } else { panic!("Unexpected event"); }
5571         }
5572         assert!(as_failds.contains(&payment_hash_1));
5573         assert!(as_failds.contains(&payment_hash_2));
5574         if announce_latest {
5575                 assert!(as_failds.contains(&payment_hash_3));
5576                 assert!(as_failds.contains(&payment_hash_5));
5577         }
5578         assert!(as_failds.contains(&payment_hash_6));
5579
5580         let bs_events = nodes[1].node.get_and_clear_pending_events();
5581         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5582         let mut bs_failds = HashSet::new();
5583         for event in bs_events.iter() {
5584                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5585                         assert!(bs_failds.insert(*payment_hash));
5586                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5587                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5588                         } else {
5589                                 assert!(!rejected_by_dest);
5590                         }
5591                 } else { panic!("Unexpected event"); }
5592         }
5593         assert!(bs_failds.contains(&payment_hash_1));
5594         assert!(bs_failds.contains(&payment_hash_2));
5595         if announce_latest {
5596                 assert!(bs_failds.contains(&payment_hash_4));
5597         }
5598         assert!(bs_failds.contains(&payment_hash_5));
5599
5600         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5601         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5602         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5603         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5604         // PaymentFailureNetworkUpdates.
5605         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5606         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5607         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5608         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5609         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5610                 match event {
5611                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5612                         _ => panic!("Unexpected event"),
5613                 }
5614         }
5615 }
5616
5617 #[test]
5618 fn test_fail_backwards_latest_remote_announce_a() {
5619         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5620 }
5621
5622 #[test]
5623 fn test_fail_backwards_latest_remote_announce_b() {
5624         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5625 }
5626
5627 #[test]
5628 fn test_fail_backwards_previous_remote_announce() {
5629         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5630         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5631         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5632 }
5633
5634 #[test]
5635 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5636         let chanmon_cfgs = create_chanmon_cfgs(2);
5637         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5638         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5639         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5640
5641         // Create some initial channels
5642         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5643
5644         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5645         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5646         assert_eq!(local_txn[0].input.len(), 1);
5647         check_spends!(local_txn[0], chan_1.3);
5648
5649         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5650         mine_transaction(&nodes[0], &local_txn[0]);
5651         check_closed_broadcast!(nodes[0], true);
5652         check_added_monitors!(nodes[0], 1);
5653
5654         let htlc_timeout = {
5655                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5656                 assert_eq!(node_txn[0].input.len(), 1);
5657                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5658                 check_spends!(node_txn[0], local_txn[0]);
5659                 node_txn[0].clone()
5660         };
5661
5662         mine_transaction(&nodes[0], &htlc_timeout);
5663         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5664         expect_payment_failed!(nodes[0], our_payment_hash, true);
5665
5666         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5667         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5668         assert_eq!(spend_txn.len(), 3);
5669         check_spends!(spend_txn[0], local_txn[0]);
5670         check_spends!(spend_txn[1], htlc_timeout);
5671         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5672 }
5673
5674 #[test]
5675 fn test_key_derivation_params() {
5676         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5677         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5678         // let us re-derive the channel key set to then derive a delayed_payment_key.
5679
5680         let chanmon_cfgs = create_chanmon_cfgs(3);
5681
5682         // We manually create the node configuration to backup the seed.
5683         let seed = [42; 32];
5684         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5685         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);
5686         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 };
5687         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5688         node_cfgs.remove(0);
5689         node_cfgs.insert(0, node);
5690
5691         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5692         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5693
5694         // Create some initial channels
5695         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5696         // for node 0
5697         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5698         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5699         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5700
5701         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5702         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5703         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5704         assert_eq!(local_txn_1[0].input.len(), 1);
5705         check_spends!(local_txn_1[0], chan_1.3);
5706
5707         // We check funding pubkey are unique
5708         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]));
5709         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]));
5710         if from_0_funding_key_0 == from_1_funding_key_0
5711             || from_0_funding_key_0 == from_1_funding_key_1
5712             || from_0_funding_key_1 == from_1_funding_key_0
5713             || from_0_funding_key_1 == from_1_funding_key_1 {
5714                 panic!("Funding pubkeys aren't unique");
5715         }
5716
5717         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5718         mine_transaction(&nodes[0], &local_txn_1[0]);
5719         check_closed_broadcast!(nodes[0], true);
5720         check_added_monitors!(nodes[0], 1);
5721
5722         let htlc_timeout = {
5723                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5724                 assert_eq!(node_txn[0].input.len(), 1);
5725                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5726                 check_spends!(node_txn[0], local_txn_1[0]);
5727                 node_txn[0].clone()
5728         };
5729
5730         mine_transaction(&nodes[0], &htlc_timeout);
5731         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5732         expect_payment_failed!(nodes[0], our_payment_hash, true);
5733
5734         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5735         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5736         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5737         assert_eq!(spend_txn.len(), 3);
5738         check_spends!(spend_txn[0], local_txn_1[0]);
5739         check_spends!(spend_txn[1], htlc_timeout);
5740         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5741 }
5742
5743 #[test]
5744 fn test_static_output_closing_tx() {
5745         let chanmon_cfgs = create_chanmon_cfgs(2);
5746         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5747         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5748         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5749
5750         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5751
5752         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5753         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5754
5755         mine_transaction(&nodes[0], &closing_tx);
5756         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5757
5758         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5759         assert_eq!(spend_txn.len(), 1);
5760         check_spends!(spend_txn[0], closing_tx);
5761
5762         mine_transaction(&nodes[1], &closing_tx);
5763         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5764
5765         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5766         assert_eq!(spend_txn.len(), 1);
5767         check_spends!(spend_txn[0], closing_tx);
5768 }
5769
5770 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5771         let chanmon_cfgs = create_chanmon_cfgs(2);
5772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5774         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5775         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5776
5777         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5778
5779         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5780         // present in B's local commitment transaction, but none of A's commitment transactions.
5781         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5782         check_added_monitors!(nodes[1], 1);
5783
5784         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5785         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5786         let events = nodes[0].node.get_and_clear_pending_events();
5787         assert_eq!(events.len(), 1);
5788         match events[0] {
5789                 Event::PaymentSent { payment_preimage } => {
5790                         assert_eq!(payment_preimage, our_payment_preimage);
5791                 },
5792                 _ => panic!("Unexpected event"),
5793         }
5794
5795         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5796         check_added_monitors!(nodes[0], 1);
5797         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5798         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5799         check_added_monitors!(nodes[1], 1);
5800
5801         let starting_block = nodes[1].best_block_info();
5802         let mut block = Block {
5803                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5804                 txdata: vec![],
5805         };
5806         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5807                 connect_block(&nodes[1], &block);
5808                 block.header.prev_blockhash = block.block_hash();
5809         }
5810         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5811         check_closed_broadcast!(nodes[1], true);
5812         check_added_monitors!(nodes[1], 1);
5813 }
5814
5815 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5816         let chanmon_cfgs = create_chanmon_cfgs(2);
5817         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5818         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5819         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5820         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5821         let logger = test_utils::TestLogger::new();
5822
5823         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5824         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5825         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();
5826         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5827         check_added_monitors!(nodes[0], 1);
5828
5829         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5830
5831         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5832         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5833         // to "time out" the HTLC.
5834
5835         let starting_block = nodes[1].best_block_info();
5836         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5837
5838         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5839                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5840                 header.prev_blockhash = header.block_hash();
5841         }
5842         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5843         check_closed_broadcast!(nodes[0], true);
5844         check_added_monitors!(nodes[0], 1);
5845 }
5846
5847 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5848         let chanmon_cfgs = create_chanmon_cfgs(3);
5849         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5850         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5851         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5852         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5853
5854         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5855         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5856         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5857         // actually revoked.
5858         let htlc_value = if use_dust { 50000 } else { 3000000 };
5859         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5860         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5861         expect_pending_htlcs_forwardable!(nodes[1]);
5862         check_added_monitors!(nodes[1], 1);
5863
5864         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5865         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5866         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5867         check_added_monitors!(nodes[0], 1);
5868         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5869         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5870         check_added_monitors!(nodes[1], 1);
5871         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5872         check_added_monitors!(nodes[1], 1);
5873         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5874
5875         if check_revoke_no_close {
5876                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5877                 check_added_monitors!(nodes[0], 1);
5878         }
5879
5880         let starting_block = nodes[1].best_block_info();
5881         let mut block = Block {
5882                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5883                 txdata: vec![],
5884         };
5885         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5886                 connect_block(&nodes[0], &block);
5887                 block.header.prev_blockhash = block.block_hash();
5888         }
5889         if !check_revoke_no_close {
5890                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5891                 check_closed_broadcast!(nodes[0], true);
5892                 check_added_monitors!(nodes[0], 1);
5893         } else {
5894                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5895         }
5896 }
5897
5898 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5899 // There are only a few cases to test here:
5900 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5901 //    broadcastable commitment transactions result in channel closure,
5902 //  * its included in an unrevoked-but-previous remote commitment transaction,
5903 //  * its included in the latest remote or local commitment transactions.
5904 // We test each of the three possible commitment transactions individually and use both dust and
5905 // non-dust HTLCs.
5906 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5907 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5908 // tested for at least one of the cases in other tests.
5909 #[test]
5910 fn htlc_claim_single_commitment_only_a() {
5911         do_htlc_claim_local_commitment_only(true);
5912         do_htlc_claim_local_commitment_only(false);
5913
5914         do_htlc_claim_current_remote_commitment_only(true);
5915         do_htlc_claim_current_remote_commitment_only(false);
5916 }
5917
5918 #[test]
5919 fn htlc_claim_single_commitment_only_b() {
5920         do_htlc_claim_previous_remote_commitment_only(true, false);
5921         do_htlc_claim_previous_remote_commitment_only(false, false);
5922         do_htlc_claim_previous_remote_commitment_only(true, true);
5923         do_htlc_claim_previous_remote_commitment_only(false, true);
5924 }
5925
5926 #[test]
5927 #[should_panic]
5928 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5929         let chanmon_cfgs = create_chanmon_cfgs(2);
5930         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5931         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5932         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5933         //Force duplicate channel ids
5934         for node in nodes.iter() {
5935                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5936         }
5937
5938         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5939         let channel_value_satoshis=10000;
5940         let push_msat=10001;
5941         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5942         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5943         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5944
5945         //Create a second channel with a channel_id collision
5946         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5947 }
5948
5949 #[test]
5950 fn bolt2_open_channel_sending_node_checks_part2() {
5951         let chanmon_cfgs = create_chanmon_cfgs(2);
5952         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5953         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5954         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5955
5956         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5957         let channel_value_satoshis=2^24;
5958         let push_msat=10001;
5959         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5960
5961         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5962         let channel_value_satoshis=10000;
5963         // Test when push_msat is equal to 1000 * funding_satoshis.
5964         let push_msat=1000*channel_value_satoshis+1;
5965         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5966
5967         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5968         let channel_value_satoshis=10000;
5969         let push_msat=10001;
5970         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
5971         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5972         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5973
5974         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5975         // 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
5976         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5977
5978         // 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.
5979         assert!(BREAKDOWN_TIMEOUT>0);
5980         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5981
5982         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5983         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5984         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5985
5986         // 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.
5987         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5988         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5989         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5990         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5991         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5992 }
5993
5994 #[test]
5995 fn bolt2_open_channel_sane_dust_limit() {
5996         let chanmon_cfgs = create_chanmon_cfgs(2);
5997         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5998         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5999         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6000
6001         let channel_value_satoshis=1000000;
6002         let push_msat=10001;
6003         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6004         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6005         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6006         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6007
6008         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6009         let events = nodes[1].node.get_and_clear_pending_msg_events();
6010         let err_msg = match events[0] {
6011                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6012                         msg.clone()
6013                 },
6014                 _ => panic!("Unexpected event"),
6015         };
6016         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6017 }
6018
6019 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6020 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6021 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6022 // is no longer affordable once it's freed.
6023 #[test]
6024 fn test_fail_holding_cell_htlc_upon_free() {
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 mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6029         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6030         let logger = test_utils::TestLogger::new();
6031
6032         // First nodes[0] generates an update_fee, setting the channel's
6033         // pending_update_fee.
6034         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6035         check_added_monitors!(nodes[0], 1);
6036
6037         let events = nodes[0].node.get_and_clear_pending_msg_events();
6038         assert_eq!(events.len(), 1);
6039         let (update_msg, commitment_signed) = match events[0] {
6040                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6041                         (update_fee.as_ref(), commitment_signed)
6042                 },
6043                 _ => panic!("Unexpected event"),
6044         };
6045
6046         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6047
6048         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6049         let channel_reserve = chan_stat.channel_reserve_msat;
6050         let feerate = get_feerate!(nodes[0], chan.2);
6051
6052         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6053         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6054         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6055         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6056         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();
6057
6058         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6059         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6060         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6061         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6062
6063         // Flush the pending fee update.
6064         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6065         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6066         check_added_monitors!(nodes[1], 1);
6067         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6068         check_added_monitors!(nodes[0], 1);
6069
6070         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6071         // HTLC, but now that the fee has been raised the payment will now fail, causing
6072         // us to surface its failure to the user.
6073         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6074         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6075         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6076         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);
6077         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6078
6079         // Check that the payment failed to be sent out.
6080         let events = nodes[0].node.get_and_clear_pending_events();
6081         assert_eq!(events.len(), 1);
6082         match &events[0] {
6083                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6084                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6085                         assert_eq!(*rejected_by_dest, false);
6086                         assert_eq!(*error_code, None);
6087                         assert_eq!(*error_data, None);
6088                 },
6089                 _ => panic!("Unexpected event"),
6090         }
6091 }
6092
6093 // Test that if multiple HTLCs are released from the holding cell and one is
6094 // valid but the other is no longer valid upon release, the valid HTLC can be
6095 // successfully completed while the other one fails as expected.
6096 #[test]
6097 fn test_free_and_fail_holding_cell_htlcs() {
6098         let chanmon_cfgs = create_chanmon_cfgs(2);
6099         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6100         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6101         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6102         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6103         let logger = test_utils::TestLogger::new();
6104
6105         // First nodes[0] generates an update_fee, setting the channel's
6106         // pending_update_fee.
6107         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6108         check_added_monitors!(nodes[0], 1);
6109
6110         let events = nodes[0].node.get_and_clear_pending_msg_events();
6111         assert_eq!(events.len(), 1);
6112         let (update_msg, commitment_signed) = match events[0] {
6113                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6114                         (update_fee.as_ref(), commitment_signed)
6115                 },
6116                 _ => panic!("Unexpected event"),
6117         };
6118
6119         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6120
6121         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6122         let channel_reserve = chan_stat.channel_reserve_msat;
6123         let feerate = get_feerate!(nodes[0], chan.2);
6124
6125         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6126         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6127         let amt_1 = 20000;
6128         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6129         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6130         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6131         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();
6132         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();
6133
6134         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6135         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6136         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6137         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6138         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6139         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6140         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6141
6142         // Flush the pending fee update.
6143         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6144         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6145         check_added_monitors!(nodes[1], 1);
6146         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6147         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6148         check_added_monitors!(nodes[0], 2);
6149
6150         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6151         // but now that the fee has been raised the second payment will now fail, causing us
6152         // to surface its failure to the user. The first payment should succeed.
6153         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6154         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6155         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6156         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);
6157         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6158
6159         // Check that the second payment failed to be sent out.
6160         let events = nodes[0].node.get_and_clear_pending_events();
6161         assert_eq!(events.len(), 1);
6162         match &events[0] {
6163                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6164                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6165                         assert_eq!(*rejected_by_dest, false);
6166                         assert_eq!(*error_code, None);
6167                         assert_eq!(*error_data, None);
6168                 },
6169                 _ => panic!("Unexpected event"),
6170         }
6171
6172         // Complete the first payment and the RAA from the fee update.
6173         let (payment_event, send_raa_event) = {
6174                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6175                 assert_eq!(msgs.len(), 2);
6176                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6177         };
6178         let raa = match send_raa_event {
6179                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6180                 _ => panic!("Unexpected event"),
6181         };
6182         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6183         check_added_monitors!(nodes[1], 1);
6184         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6185         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6186         let events = nodes[1].node.get_and_clear_pending_events();
6187         assert_eq!(events.len(), 1);
6188         match events[0] {
6189                 Event::PendingHTLCsForwardable { .. } => {},
6190                 _ => panic!("Unexpected event"),
6191         }
6192         nodes[1].node.process_pending_htlc_forwards();
6193         let events = nodes[1].node.get_and_clear_pending_events();
6194         assert_eq!(events.len(), 1);
6195         match events[0] {
6196                 Event::PaymentReceived { .. } => {},
6197                 _ => panic!("Unexpected event"),
6198         }
6199         nodes[1].node.claim_funds(payment_preimage_1);
6200         check_added_monitors!(nodes[1], 1);
6201         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6202         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6203         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6204         let events = nodes[0].node.get_and_clear_pending_events();
6205         assert_eq!(events.len(), 1);
6206         match events[0] {
6207                 Event::PaymentSent { ref payment_preimage } => {
6208                         assert_eq!(*payment_preimage, payment_preimage_1);
6209                 }
6210                 _ => panic!("Unexpected event"),
6211         }
6212 }
6213
6214 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6215 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6216 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6217 // once it's freed.
6218 #[test]
6219 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6220         let chanmon_cfgs = create_chanmon_cfgs(3);
6221         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6222         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6223         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6224         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6225         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6226         let logger = test_utils::TestLogger::new();
6227
6228         // First nodes[1] generates an update_fee, setting the channel's
6229         // pending_update_fee.
6230         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6231         check_added_monitors!(nodes[1], 1);
6232
6233         let events = nodes[1].node.get_and_clear_pending_msg_events();
6234         assert_eq!(events.len(), 1);
6235         let (update_msg, commitment_signed) = match events[0] {
6236                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6237                         (update_fee.as_ref(), commitment_signed)
6238                 },
6239                 _ => panic!("Unexpected event"),
6240         };
6241
6242         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6243
6244         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6245         let channel_reserve = chan_stat.channel_reserve_msat;
6246         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6247
6248         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6249         let feemsat = 239;
6250         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6251         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6252         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6253         let payment_event = {
6254                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6255                 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();
6256                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6257                 check_added_monitors!(nodes[0], 1);
6258
6259                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6260                 assert_eq!(events.len(), 1);
6261
6262                 SendEvent::from_event(events.remove(0))
6263         };
6264         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6265         check_added_monitors!(nodes[1], 0);
6266         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6267         expect_pending_htlcs_forwardable!(nodes[1]);
6268
6269         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6270         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6271
6272         // Flush the pending fee update.
6273         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6274         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6275         check_added_monitors!(nodes[2], 1);
6276         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6277         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6278         check_added_monitors!(nodes[1], 2);
6279
6280         // A final RAA message is generated to finalize the fee update.
6281         let events = nodes[1].node.get_and_clear_pending_msg_events();
6282         assert_eq!(events.len(), 1);
6283
6284         let raa_msg = match &events[0] {
6285                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6286                         msg.clone()
6287                 },
6288                 _ => panic!("Unexpected event"),
6289         };
6290
6291         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6292         check_added_monitors!(nodes[2], 1);
6293         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6294
6295         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6296         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6297         assert_eq!(process_htlc_forwards_event.len(), 1);
6298         match &process_htlc_forwards_event[0] {
6299                 &Event::PendingHTLCsForwardable { .. } => {},
6300                 _ => panic!("Unexpected event"),
6301         }
6302
6303         // In response, we call ChannelManager's process_pending_htlc_forwards
6304         nodes[1].node.process_pending_htlc_forwards();
6305         check_added_monitors!(nodes[1], 1);
6306
6307         // This causes the HTLC to be failed backwards.
6308         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6309         assert_eq!(fail_event.len(), 1);
6310         let (fail_msg, commitment_signed) = match &fail_event[0] {
6311                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6312                         assert_eq!(updates.update_add_htlcs.len(), 0);
6313                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6314                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6315                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6316                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6317                 },
6318                 _ => panic!("Unexpected event"),
6319         };
6320
6321         // Pass the failure messages back to nodes[0].
6322         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6323         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6324
6325         // Complete the HTLC failure+removal process.
6326         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6327         check_added_monitors!(nodes[0], 1);
6328         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6329         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6330         check_added_monitors!(nodes[1], 2);
6331         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6332         assert_eq!(final_raa_event.len(), 1);
6333         let raa = match &final_raa_event[0] {
6334                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6335                 _ => panic!("Unexpected event"),
6336         };
6337         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6338         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6339         assert_eq!(fail_msg_event.len(), 1);
6340         match &fail_msg_event[0] {
6341                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6342                 _ => panic!("Unexpected event"),
6343         }
6344         let failure_event = nodes[0].node.get_and_clear_pending_events();
6345         assert_eq!(failure_event.len(), 1);
6346         match &failure_event[0] {
6347                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6348                         assert!(!rejected_by_dest);
6349                 },
6350                 _ => panic!("Unexpected event"),
6351         }
6352         check_added_monitors!(nodes[0], 1);
6353 }
6354
6355 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6356 // 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.
6357 //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.
6358
6359 #[test]
6360 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6361         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6362         let chanmon_cfgs = create_chanmon_cfgs(2);
6363         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6364         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6365         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6366         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6367
6368         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6369         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6370         let logger = test_utils::TestLogger::new();
6371         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();
6372         route.paths[0][0].fee_msat = 100;
6373
6374         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6375                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6376         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6377         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6378 }
6379
6380 #[test]
6381 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6382         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6383         let chanmon_cfgs = create_chanmon_cfgs(2);
6384         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6385         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6386         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6387         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6388         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6389
6390         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6391         let logger = test_utils::TestLogger::new();
6392         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();
6393         route.paths[0][0].fee_msat = 0;
6394         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6395                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6396
6397         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6398         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6399 }
6400
6401 #[test]
6402 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6403         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6404         let chanmon_cfgs = create_chanmon_cfgs(2);
6405         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6406         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6407         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6408         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6409
6410         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6411         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6412         let logger = test_utils::TestLogger::new();
6413         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();
6414         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6415         check_added_monitors!(nodes[0], 1);
6416         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6417         updates.update_add_htlcs[0].amount_msat = 0;
6418
6419         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6420         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6421         check_closed_broadcast!(nodes[1], true).unwrap();
6422         check_added_monitors!(nodes[1], 1);
6423 }
6424
6425 #[test]
6426 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6427         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6428         //It is enforced when constructing a route.
6429         let chanmon_cfgs = create_chanmon_cfgs(2);
6430         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6431         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6432         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6433         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6434         let logger = test_utils::TestLogger::new();
6435
6436         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6437
6438         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6439         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();
6440         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6441                 assert_eq!(err, &"Channel CLTV overflowed?"));
6442 }
6443
6444 #[test]
6445 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6446         //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.
6447         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6448         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6449         let chanmon_cfgs = create_chanmon_cfgs(2);
6450         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6451         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6452         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6453         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6454         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6455
6456         let logger = test_utils::TestLogger::new();
6457         for i in 0..max_accepted_htlcs {
6458                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6459                 let payment_event = {
6460                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6461                         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();
6462                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6463                         check_added_monitors!(nodes[0], 1);
6464
6465                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6466                         assert_eq!(events.len(), 1);
6467                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6468                                 assert_eq!(htlcs[0].htlc_id, i);
6469                         } else {
6470                                 assert!(false);
6471                         }
6472                         SendEvent::from_event(events.remove(0))
6473                 };
6474                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6475                 check_added_monitors!(nodes[1], 0);
6476                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6477
6478                 expect_pending_htlcs_forwardable!(nodes[1]);
6479                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6480         }
6481         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6482         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6483         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();
6484         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6485                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6486
6487         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6488         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6489 }
6490
6491 #[test]
6492 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6493         //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.
6494         let chanmon_cfgs = create_chanmon_cfgs(2);
6495         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6496         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6497         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6498         let channel_value = 100000;
6499         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6500         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6501
6502         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6503
6504         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6505         // Manually create a route over our max in flight (which our router normally automatically
6506         // limits us to.
6507         let route = Route { paths: vec![vec![RouteHop {
6508            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6509            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6510            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6511         }]] };
6512         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6513                 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)));
6514
6515         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6516         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);
6517
6518         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6519 }
6520
6521 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6522 #[test]
6523 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6524         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6525         let chanmon_cfgs = create_chanmon_cfgs(2);
6526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6528         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6529         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6530         let htlc_minimum_msat: u64;
6531         {
6532                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6533                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6534                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6535         }
6536
6537         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6538         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6539         let logger = test_utils::TestLogger::new();
6540         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6541         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6542         check_added_monitors!(nodes[0], 1);
6543         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6544         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6545         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6546         assert!(nodes[1].node.list_channels().is_empty());
6547         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6548         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()));
6549         check_added_monitors!(nodes[1], 1);
6550 }
6551
6552 #[test]
6553 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6554         //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
6555         let chanmon_cfgs = create_chanmon_cfgs(2);
6556         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6557         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6558         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6559         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6560         let logger = test_utils::TestLogger::new();
6561
6562         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6563         let channel_reserve = chan_stat.channel_reserve_msat;
6564         let feerate = get_feerate!(nodes[0], chan.2);
6565         // The 2* and +1 are for the fee spike reserve.
6566         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6567
6568         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6569         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6570         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6571         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();
6572         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6573         check_added_monitors!(nodes[0], 1);
6574         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6575
6576         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6577         // at this time channel-initiatee receivers are not required to enforce that senders
6578         // respect the fee_spike_reserve.
6579         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6580         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6581
6582         assert!(nodes[1].node.list_channels().is_empty());
6583         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6584         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6585         check_added_monitors!(nodes[1], 1);
6586 }
6587
6588 #[test]
6589 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6590         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6591         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6592         let chanmon_cfgs = create_chanmon_cfgs(2);
6593         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6594         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6595         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6596         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6597         let logger = test_utils::TestLogger::new();
6598
6599         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6600         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6601
6602         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6603         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();
6604
6605         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6606         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6607         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6608         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6609
6610         let mut msg = msgs::UpdateAddHTLC {
6611                 channel_id: chan.2,
6612                 htlc_id: 0,
6613                 amount_msat: 1000,
6614                 payment_hash: our_payment_hash,
6615                 cltv_expiry: htlc_cltv,
6616                 onion_routing_packet: onion_packet.clone(),
6617         };
6618
6619         for i in 0..super::channel::OUR_MAX_HTLCS {
6620                 msg.htlc_id = i as u64;
6621                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6622         }
6623         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6624         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6625
6626         assert!(nodes[1].node.list_channels().is_empty());
6627         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6628         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6629         check_added_monitors!(nodes[1], 1);
6630 }
6631
6632 #[test]
6633 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6634         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6635         let chanmon_cfgs = create_chanmon_cfgs(2);
6636         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6637         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6638         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6639         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6640         let logger = test_utils::TestLogger::new();
6641
6642         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6643         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6644         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6645         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6646         check_added_monitors!(nodes[0], 1);
6647         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6648         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6649         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6650
6651         assert!(nodes[1].node.list_channels().is_empty());
6652         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6653         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6654         check_added_monitors!(nodes[1], 1);
6655 }
6656
6657 #[test]
6658 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6659         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6660         let chanmon_cfgs = create_chanmon_cfgs(2);
6661         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6662         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6663         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6664         let logger = test_utils::TestLogger::new();
6665
6666         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6667         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6668         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6669         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();
6670         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6671         check_added_monitors!(nodes[0], 1);
6672         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6673         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6674         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6675
6676         assert!(nodes[1].node.list_channels().is_empty());
6677         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6678         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6679         check_added_monitors!(nodes[1], 1);
6680 }
6681
6682 #[test]
6683 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6684         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6685         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6686         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6687         let chanmon_cfgs = create_chanmon_cfgs(2);
6688         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6690         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6691         let logger = test_utils::TestLogger::new();
6692
6693         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6694         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6695         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6696         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();
6697         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6698         check_added_monitors!(nodes[0], 1);
6699         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6700         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6701
6702         //Disconnect and Reconnect
6703         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6704         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6705         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6706         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6707         assert_eq!(reestablish_1.len(), 1);
6708         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6709         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6710         assert_eq!(reestablish_2.len(), 1);
6711         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6712         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6713         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6714         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6715
6716         //Resend HTLC
6717         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6718         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6719         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6720         check_added_monitors!(nodes[1], 1);
6721         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6722
6723         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6724
6725         assert!(nodes[1].node.list_channels().is_empty());
6726         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6727         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6728         check_added_monitors!(nodes[1], 1);
6729 }
6730
6731 #[test]
6732 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6733         //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.
6734
6735         let chanmon_cfgs = create_chanmon_cfgs(2);
6736         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6737         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6738         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6739         let logger = test_utils::TestLogger::new();
6740         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6741         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6742         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6743         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();
6744         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6745
6746         check_added_monitors!(nodes[0], 1);
6747         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6748         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6749
6750         let update_msg = msgs::UpdateFulfillHTLC{
6751                 channel_id: chan.2,
6752                 htlc_id: 0,
6753                 payment_preimage: our_payment_preimage,
6754         };
6755
6756         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6757
6758         assert!(nodes[0].node.list_channels().is_empty());
6759         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6760         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()));
6761         check_added_monitors!(nodes[0], 1);
6762 }
6763
6764 #[test]
6765 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6766         //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.
6767
6768         let chanmon_cfgs = create_chanmon_cfgs(2);
6769         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6770         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6771         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6772         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6773         let logger = test_utils::TestLogger::new();
6774
6775         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6776         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6777         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();
6778         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6779         check_added_monitors!(nodes[0], 1);
6780         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6781         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6782
6783         let update_msg = msgs::UpdateFailHTLC{
6784                 channel_id: chan.2,
6785                 htlc_id: 0,
6786                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6787         };
6788
6789         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6790
6791         assert!(nodes[0].node.list_channels().is_empty());
6792         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6793         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()));
6794         check_added_monitors!(nodes[0], 1);
6795 }
6796
6797 #[test]
6798 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6799         //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.
6800
6801         let chanmon_cfgs = create_chanmon_cfgs(2);
6802         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6803         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6804         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6805         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6806         let logger = test_utils::TestLogger::new();
6807
6808         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6809         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6810         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();
6811         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6812         check_added_monitors!(nodes[0], 1);
6813         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6814         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6815         let update_msg = msgs::UpdateFailMalformedHTLC{
6816                 channel_id: chan.2,
6817                 htlc_id: 0,
6818                 sha256_of_onion: [1; 32],
6819                 failure_code: 0x8000,
6820         };
6821
6822         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6823
6824         assert!(nodes[0].node.list_channels().is_empty());
6825         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6826         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()));
6827         check_added_monitors!(nodes[0], 1);
6828 }
6829
6830 #[test]
6831 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6832         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6833
6834         let chanmon_cfgs = create_chanmon_cfgs(2);
6835         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6836         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6837         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6838         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6839
6840         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6841
6842         nodes[1].node.claim_funds(our_payment_preimage);
6843         check_added_monitors!(nodes[1], 1);
6844
6845         let events = nodes[1].node.get_and_clear_pending_msg_events();
6846         assert_eq!(events.len(), 1);
6847         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6848                 match events[0] {
6849                         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, .. } } => {
6850                                 assert!(update_add_htlcs.is_empty());
6851                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6852                                 assert!(update_fail_htlcs.is_empty());
6853                                 assert!(update_fail_malformed_htlcs.is_empty());
6854                                 assert!(update_fee.is_none());
6855                                 update_fulfill_htlcs[0].clone()
6856                         },
6857                         _ => panic!("Unexpected event"),
6858                 }
6859         };
6860
6861         update_fulfill_msg.htlc_id = 1;
6862
6863         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6864
6865         assert!(nodes[0].node.list_channels().is_empty());
6866         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6867         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6868         check_added_monitors!(nodes[0], 1);
6869 }
6870
6871 #[test]
6872 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6873         //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.
6874
6875         let chanmon_cfgs = create_chanmon_cfgs(2);
6876         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6877         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6878         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6879         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6880
6881         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6882
6883         nodes[1].node.claim_funds(our_payment_preimage);
6884         check_added_monitors!(nodes[1], 1);
6885
6886         let events = nodes[1].node.get_and_clear_pending_msg_events();
6887         assert_eq!(events.len(), 1);
6888         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6889                 match events[0] {
6890                         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, .. } } => {
6891                                 assert!(update_add_htlcs.is_empty());
6892                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6893                                 assert!(update_fail_htlcs.is_empty());
6894                                 assert!(update_fail_malformed_htlcs.is_empty());
6895                                 assert!(update_fee.is_none());
6896                                 update_fulfill_htlcs[0].clone()
6897                         },
6898                         _ => panic!("Unexpected event"),
6899                 }
6900         };
6901
6902         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6903
6904         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6905
6906         assert!(nodes[0].node.list_channels().is_empty());
6907         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6908         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6909         check_added_monitors!(nodes[0], 1);
6910 }
6911
6912 #[test]
6913 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6914         //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.
6915
6916         let chanmon_cfgs = create_chanmon_cfgs(2);
6917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6919         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6920         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6921         let logger = test_utils::TestLogger::new();
6922
6923         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6924         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6925         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();
6926         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6927         check_added_monitors!(nodes[0], 1);
6928
6929         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6930         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6931
6932         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6933         check_added_monitors!(nodes[1], 0);
6934         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6935
6936         let events = nodes[1].node.get_and_clear_pending_msg_events();
6937
6938         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6939                 match events[0] {
6940                         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, .. } } => {
6941                                 assert!(update_add_htlcs.is_empty());
6942                                 assert!(update_fulfill_htlcs.is_empty());
6943                                 assert!(update_fail_htlcs.is_empty());
6944                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6945                                 assert!(update_fee.is_none());
6946                                 update_fail_malformed_htlcs[0].clone()
6947                         },
6948                         _ => panic!("Unexpected event"),
6949                 }
6950         };
6951         update_msg.failure_code &= !0x8000;
6952         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6953
6954         assert!(nodes[0].node.list_channels().is_empty());
6955         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6956         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6957         check_added_monitors!(nodes[0], 1);
6958 }
6959
6960 #[test]
6961 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6962         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6963         //    * 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.
6964
6965         let chanmon_cfgs = create_chanmon_cfgs(3);
6966         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6967         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6968         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6969         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6970         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6971         let logger = test_utils::TestLogger::new();
6972
6973         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6974
6975         //First hop
6976         let mut payment_event = {
6977                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6978                 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();
6979                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6980                 check_added_monitors!(nodes[0], 1);
6981                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6982                 assert_eq!(events.len(), 1);
6983                 SendEvent::from_event(events.remove(0))
6984         };
6985         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6986         check_added_monitors!(nodes[1], 0);
6987         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6988         expect_pending_htlcs_forwardable!(nodes[1]);
6989         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6990         assert_eq!(events_2.len(), 1);
6991         check_added_monitors!(nodes[1], 1);
6992         payment_event = SendEvent::from_event(events_2.remove(0));
6993         assert_eq!(payment_event.msgs.len(), 1);
6994
6995         //Second Hop
6996         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6997         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6998         check_added_monitors!(nodes[2], 0);
6999         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7000
7001         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7002         assert_eq!(events_3.len(), 1);
7003         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7004                 match events_3[0] {
7005                         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 } } => {
7006                                 assert!(update_add_htlcs.is_empty());
7007                                 assert!(update_fulfill_htlcs.is_empty());
7008                                 assert!(update_fail_htlcs.is_empty());
7009                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7010                                 assert!(update_fee.is_none());
7011                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7012                         },
7013                         _ => panic!("Unexpected event"),
7014                 }
7015         };
7016
7017         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7018
7019         check_added_monitors!(nodes[1], 0);
7020         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7021         expect_pending_htlcs_forwardable!(nodes[1]);
7022         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7023         assert_eq!(events_4.len(), 1);
7024
7025         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7026         match events_4[0] {
7027                 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, .. } } => {
7028                         assert!(update_add_htlcs.is_empty());
7029                         assert!(update_fulfill_htlcs.is_empty());
7030                         assert_eq!(update_fail_htlcs.len(), 1);
7031                         assert!(update_fail_malformed_htlcs.is_empty());
7032                         assert!(update_fee.is_none());
7033                 },
7034                 _ => panic!("Unexpected event"),
7035         };
7036
7037         check_added_monitors!(nodes[1], 1);
7038 }
7039
7040 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7041         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7042         // 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
7043         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7044
7045         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7046         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7047         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7048         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7049         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7050         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7051
7052         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7053
7054         // We route 2 dust-HTLCs between A and B
7055         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7056         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7057         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7058
7059         // Cache one local commitment tx as previous
7060         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7061
7062         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7063         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7064         check_added_monitors!(nodes[1], 0);
7065         expect_pending_htlcs_forwardable!(nodes[1]);
7066         check_added_monitors!(nodes[1], 1);
7067
7068         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7069         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7070         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7071         check_added_monitors!(nodes[0], 1);
7072
7073         // Cache one local commitment tx as lastest
7074         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7075
7076         let events = nodes[0].node.get_and_clear_pending_msg_events();
7077         match events[0] {
7078                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7079                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7080                 },
7081                 _ => panic!("Unexpected event"),
7082         }
7083         match events[1] {
7084                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7085                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7086                 },
7087                 _ => panic!("Unexpected event"),
7088         }
7089
7090         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7091         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7092         if announce_latest {
7093                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7094         } else {
7095                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7096         }
7097
7098         check_closed_broadcast!(nodes[0], true);
7099         check_added_monitors!(nodes[0], 1);
7100
7101         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7102         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7103         let events = nodes[0].node.get_and_clear_pending_events();
7104         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7105         assert_eq!(events.len(), 2);
7106         let mut first_failed = false;
7107         for event in events {
7108                 match event {
7109                         Event::PaymentFailed { payment_hash, .. } => {
7110                                 if payment_hash == payment_hash_1 {
7111                                         assert!(!first_failed);
7112                                         first_failed = true;
7113                                 } else {
7114                                         assert_eq!(payment_hash, payment_hash_2);
7115                                 }
7116                         }
7117                         _ => panic!("Unexpected event"),
7118                 }
7119         }
7120 }
7121
7122 #[test]
7123 fn test_failure_delay_dust_htlc_local_commitment() {
7124         do_test_failure_delay_dust_htlc_local_commitment(true);
7125         do_test_failure_delay_dust_htlc_local_commitment(false);
7126 }
7127
7128 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7129         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7130         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7131         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7132         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7133         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7134         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7135
7136         let chanmon_cfgs = create_chanmon_cfgs(3);
7137         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7138         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7139         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7140         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7141
7142         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7143
7144         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7145         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7146
7147         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7148         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7149
7150         // We revoked bs_commitment_tx
7151         if revoked {
7152                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7153                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7154         }
7155
7156         let mut timeout_tx = Vec::new();
7157         if local {
7158                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7159                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7160                 check_closed_broadcast!(nodes[0], true);
7161                 check_added_monitors!(nodes[0], 1);
7162                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7163                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7164                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7165                 expect_payment_failed!(nodes[0], dust_hash, true);
7166                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7167                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7168                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7169                 mine_transaction(&nodes[0], &timeout_tx[0]);
7170                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7171                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7172         } else {
7173                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7174                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7175                 check_closed_broadcast!(nodes[0], true);
7176                 check_added_monitors!(nodes[0], 1);
7177                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7178                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7179                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7180                 if !revoked {
7181                         expect_payment_failed!(nodes[0], dust_hash, true);
7182                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7183                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7184                         mine_transaction(&nodes[0], &timeout_tx[0]);
7185                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7186                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7187                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7188                 } else {
7189                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7190                         // commitment tx
7191                         let events = nodes[0].node.get_and_clear_pending_events();
7192                         assert_eq!(events.len(), 2);
7193                         let first;
7194                         match events[0] {
7195                                 Event::PaymentFailed { payment_hash, .. } => {
7196                                         if payment_hash == dust_hash { first = true; }
7197                                         else { first = false; }
7198                                 },
7199                                 _ => panic!("Unexpected event"),
7200                         }
7201                         match events[1] {
7202                                 Event::PaymentFailed { payment_hash, .. } => {
7203                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7204                                         else { assert_eq!(payment_hash, dust_hash); }
7205                                 },
7206                                 _ => panic!("Unexpected event"),
7207                         }
7208                 }
7209         }
7210 }
7211
7212 #[test]
7213 fn test_sweep_outbound_htlc_failure_update() {
7214         do_test_sweep_outbound_htlc_failure_update(false, true);
7215         do_test_sweep_outbound_htlc_failure_update(false, false);
7216         do_test_sweep_outbound_htlc_failure_update(true, false);
7217 }
7218
7219 #[test]
7220 fn test_upfront_shutdown_script() {
7221         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7222         // enforce it at shutdown message
7223
7224         let mut config = UserConfig::default();
7225         config.channel_options.announced_channel = true;
7226         config.peer_channel_config_limits.force_announced_channel_preference = false;
7227         config.channel_options.commit_upfront_shutdown_pubkey = false;
7228         let user_cfgs = [None, Some(config), None];
7229         let chanmon_cfgs = create_chanmon_cfgs(3);
7230         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7231         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7232         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7233
7234         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7235         let flags = InitFeatures::known();
7236         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7237         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7238         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7239         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7240         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7241         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7242     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()));
7243         check_added_monitors!(nodes[2], 1);
7244
7245         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7246         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7247         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7248         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7249         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7250         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7251         let events = nodes[2].node.get_and_clear_pending_msg_events();
7252         assert_eq!(events.len(), 1);
7253         match events[0] {
7254                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7255                 _ => panic!("Unexpected event"),
7256         }
7257
7258         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7259         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7260         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7261         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7262         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7263         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7264         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7265         let events = nodes[1].node.get_and_clear_pending_msg_events();
7266         assert_eq!(events.len(), 1);
7267         match events[0] {
7268                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7269                 _ => panic!("Unexpected event"),
7270         }
7271
7272         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7273         // channel smoothly, opt-out is from channel initiator here
7274         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7275         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7276         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7277         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7278         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7279         let events = nodes[0].node.get_and_clear_pending_msg_events();
7280         assert_eq!(events.len(), 1);
7281         match events[0] {
7282                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7283                 _ => panic!("Unexpected event"),
7284         }
7285
7286         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7287         //// channel smoothly
7288         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7289         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7290         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7291         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7292         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7293         let events = nodes[0].node.get_and_clear_pending_msg_events();
7294         assert_eq!(events.len(), 2);
7295         match events[0] {
7296                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7297                 _ => panic!("Unexpected event"),
7298         }
7299         match events[1] {
7300                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7301                 _ => panic!("Unexpected event"),
7302         }
7303 }
7304
7305 #[test]
7306 fn test_upfront_shutdown_script_unsupport_segwit() {
7307         // We test that channel is closed early
7308         // if a segwit program is passed as upfront shutdown script,
7309         // but the peer does not support segwit.
7310         let chanmon_cfgs = create_chanmon_cfgs(2);
7311         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7312         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7313         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7314
7315         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7316
7317         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7318         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7319                 .push_slice(&[0, 0])
7320                 .into_script());
7321
7322         let features = InitFeatures::known().clear_shutdown_anysegwit();
7323         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7324
7325         let events = nodes[0].node.get_and_clear_pending_msg_events();
7326         assert_eq!(events.len(), 1);
7327         match events[0] {
7328                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7329                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7330                         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));
7331                 },
7332                 _ => panic!("Unexpected event"),
7333         }
7334 }
7335
7336 #[test]
7337 fn test_shutdown_script_any_segwit_allowed() {
7338         let mut config = UserConfig::default();
7339         config.channel_options.announced_channel = true;
7340         config.peer_channel_config_limits.force_announced_channel_preference = false;
7341         config.channel_options.commit_upfront_shutdown_pubkey = false;
7342         let user_cfgs = [None, Some(config), None];
7343         let chanmon_cfgs = create_chanmon_cfgs(3);
7344         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7345         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7346         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7347
7348         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7349         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7350         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7351         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7352         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7353                 .push_slice(&[0, 0])
7354                 .into_script();
7355         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7356         let events = nodes[0].node.get_and_clear_pending_msg_events();
7357         assert_eq!(events.len(), 2);
7358         match events[0] {
7359                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7360                 _ => panic!("Unexpected event"),
7361         }
7362         match events[1] {
7363                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7364                 _ => panic!("Unexpected event"),
7365         }
7366 }
7367
7368 #[test]
7369 fn test_shutdown_script_any_segwit_not_allowed() {
7370         let mut config = UserConfig::default();
7371         config.channel_options.announced_channel = true;
7372         config.peer_channel_config_limits.force_announced_channel_preference = false;
7373         config.channel_options.commit_upfront_shutdown_pubkey = false;
7374         let user_cfgs = [None, Some(config), None];
7375         let chanmon_cfgs = create_chanmon_cfgs(3);
7376         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7377         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7378         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7379
7380         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7381         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7382         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7383         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7384         // Make an any segwit version script
7385         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7386                 .push_slice(&[0, 0])
7387                 .into_script();
7388         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7389         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7390         let events = nodes[0].node.get_and_clear_pending_msg_events();
7391         assert_eq!(events.len(), 2);
7392         match events[1] {
7393                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7394                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7395                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7396                 },
7397                 _ => panic!("Unexpected event"),
7398         }
7399         check_added_monitors!(nodes[0], 1);
7400 }
7401
7402 #[test]
7403 fn test_shutdown_script_segwit_but_not_anysegwit() {
7404         let mut config = UserConfig::default();
7405         config.channel_options.announced_channel = true;
7406         config.peer_channel_config_limits.force_announced_channel_preference = false;
7407         config.channel_options.commit_upfront_shutdown_pubkey = false;
7408         let user_cfgs = [None, Some(config), None];
7409         let chanmon_cfgs = create_chanmon_cfgs(3);
7410         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7411         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7412         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7413
7414         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7415         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7416         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7417         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7418         // Make a segwit script that is not a valid as any segwit
7419         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7420                 .push_slice(&[0, 0])
7421                 .into_script();
7422         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7423         let events = nodes[0].node.get_and_clear_pending_msg_events();
7424         assert_eq!(events.len(), 2);
7425         match events[1] {
7426                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7427                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7428                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7429                 },
7430                 _ => panic!("Unexpected event"),
7431         }
7432         check_added_monitors!(nodes[0], 1);
7433 }
7434
7435 #[test]
7436 fn test_user_configurable_csv_delay() {
7437         // We test our channel constructors yield errors when we pass them absurd csv delay
7438
7439         let mut low_our_to_self_config = UserConfig::default();
7440         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7441         let mut high_their_to_self_config = UserConfig::default();
7442         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7443         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7444         let chanmon_cfgs = create_chanmon_cfgs(2);
7445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7448
7449         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7450         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) {
7451                 match error {
7452                         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())); },
7453                         _ => panic!("Unexpected event"),
7454                 }
7455         } else { assert!(false) }
7456
7457         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7458         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7459         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7460         open_channel.to_self_delay = 200;
7461         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) {
7462                 match error {
7463                         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()));  },
7464                         _ => panic!("Unexpected event"),
7465                 }
7466         } else { assert!(false); }
7467
7468         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7469         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7470         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()));
7471         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7472         accept_channel.to_self_delay = 200;
7473         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7474         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7475                 match action {
7476                         &ErrorAction::SendErrorMessage { ref msg } => {
7477                                 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()));
7478                         },
7479                         _ => { assert!(false); }
7480                 }
7481         } else { assert!(false); }
7482
7483         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7484         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7485         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7486         open_channel.to_self_delay = 200;
7487         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) {
7488                 match error {
7489                         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())); },
7490                         _ => panic!("Unexpected event"),
7491                 }
7492         } else { assert!(false); }
7493 }
7494
7495 #[test]
7496 fn test_data_loss_protect() {
7497         // We want to be sure that :
7498         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7499         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7500         // * we close channel in case of detecting other being fallen behind
7501         // * we are able to claim our own outputs thanks to to_remote being static
7502         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7503         let persister;
7504         let logger;
7505         let fee_estimator;
7506         let tx_broadcaster;
7507         let chain_source;
7508         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7509         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7510         // during signing due to revoked tx
7511         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7512         let keys_manager = &chanmon_cfgs[0].keys_manager;
7513         let monitor;
7514         let node_state_0;
7515         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7516         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7517         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7518
7519         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7520
7521         // Cache node A state before any channel update
7522         let previous_node_state = nodes[0].node.encode();
7523         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7524         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7525
7526         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7527         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7528
7529         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7530         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7531
7532         // Restore node A from previous state
7533         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7534         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7535         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7536         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7537         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7538         persister = test_utils::TestPersister::new();
7539         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7540         node_state_0 = {
7541                 let mut channel_monitors = HashMap::new();
7542                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7543                 <(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 {
7544                         keys_manager: keys_manager,
7545                         fee_estimator: &fee_estimator,
7546                         chain_monitor: &monitor,
7547                         logger: &logger,
7548                         tx_broadcaster: &tx_broadcaster,
7549                         default_config: UserConfig::default(),
7550                         channel_monitors,
7551                 }).unwrap().1
7552         };
7553         nodes[0].node = &node_state_0;
7554         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7555         nodes[0].chain_monitor = &monitor;
7556         nodes[0].chain_source = &chain_source;
7557
7558         check_added_monitors!(nodes[0], 1);
7559
7560         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7561         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7562
7563         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7564
7565         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7566         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7567         check_added_monitors!(nodes[0], 1);
7568
7569         {
7570                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7571                 assert_eq!(node_txn.len(), 0);
7572         }
7573
7574         let mut reestablish_1 = Vec::with_capacity(1);
7575         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7576                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7577                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7578                         reestablish_1.push(msg.clone());
7579                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7580                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7581                         match action {
7582                                 &ErrorAction::SendErrorMessage { ref msg } => {
7583                                         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");
7584                                 },
7585                                 _ => panic!("Unexpected event!"),
7586                         }
7587                 } else {
7588                         panic!("Unexpected event")
7589                 }
7590         }
7591
7592         // Check we close channel detecting A is fallen-behind
7593         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7594         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7595         check_added_monitors!(nodes[1], 1);
7596
7597
7598         // Check A is able to claim to_remote output
7599         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7600         assert_eq!(node_txn.len(), 1);
7601         check_spends!(node_txn[0], chan.3);
7602         assert_eq!(node_txn[0].output.len(), 2);
7603         mine_transaction(&nodes[0], &node_txn[0]);
7604         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7605         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7606         assert_eq!(spend_txn.len(), 1);
7607         check_spends!(spend_txn[0], node_txn[0]);
7608 }
7609
7610 #[test]
7611 fn test_check_htlc_underpaying() {
7612         // Send payment through A -> B but A is maliciously
7613         // sending a probe payment (i.e less than expected value0
7614         // to B, B should refuse payment.
7615
7616         let chanmon_cfgs = create_chanmon_cfgs(2);
7617         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7618         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7619         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7620
7621         // Create some initial channels
7622         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7623
7624         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();
7625         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7626         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7627         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7628         check_added_monitors!(nodes[0], 1);
7629
7630         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7631         assert_eq!(events.len(), 1);
7632         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7633         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7634         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7635
7636         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7637         // and then will wait a second random delay before failing the HTLC back:
7638         expect_pending_htlcs_forwardable!(nodes[1]);
7639         expect_pending_htlcs_forwardable!(nodes[1]);
7640
7641         // Node 3 is expecting payment of 100_000 but received 10_000,
7642         // it should fail htlc like we didn't know the preimage.
7643         nodes[1].node.process_pending_htlc_forwards();
7644
7645         let events = nodes[1].node.get_and_clear_pending_msg_events();
7646         assert_eq!(events.len(), 1);
7647         let (update_fail_htlc, commitment_signed) = match events[0] {
7648                 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 } } => {
7649                         assert!(update_add_htlcs.is_empty());
7650                         assert!(update_fulfill_htlcs.is_empty());
7651                         assert_eq!(update_fail_htlcs.len(), 1);
7652                         assert!(update_fail_malformed_htlcs.is_empty());
7653                         assert!(update_fee.is_none());
7654                         (update_fail_htlcs[0].clone(), commitment_signed)
7655                 },
7656                 _ => panic!("Unexpected event"),
7657         };
7658         check_added_monitors!(nodes[1], 1);
7659
7660         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7661         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7662
7663         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7664         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7665         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7666         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7667 }
7668
7669 #[test]
7670 fn test_announce_disable_channels() {
7671         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7672         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7673
7674         let chanmon_cfgs = create_chanmon_cfgs(2);
7675         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7676         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7677         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7678
7679         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7680         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7681         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7682
7683         // Disconnect peers
7684         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7685         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7686
7687         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7688         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7689         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7690         assert_eq!(msg_events.len(), 3);
7691         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7692         for e in msg_events {
7693                 match e {
7694                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7695                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7696                                 // Check that each channel gets updated exactly once
7697                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7698                                         panic!("Generated ChannelUpdate for wrong chan!");
7699                                 }
7700                         },
7701                         _ => panic!("Unexpected event"),
7702                 }
7703         }
7704         // Reconnect peers
7705         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7706         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7707         assert_eq!(reestablish_1.len(), 3);
7708         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7709         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7710         assert_eq!(reestablish_2.len(), 3);
7711
7712         // Reestablish chan_1
7713         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7714         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7715         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7716         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7717         // Reestablish chan_2
7718         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7719         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7720         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7721         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7722         // Reestablish chan_3
7723         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7724         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7725         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7726         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7727
7728         nodes[0].node.timer_tick_occurred();
7729         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7730         nodes[0].node.timer_tick_occurred();
7731         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7732         assert_eq!(msg_events.len(), 3);
7733         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7734         for e in msg_events {
7735                 match e {
7736                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7737                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7738                                 // Check that each channel gets updated exactly once
7739                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7740                                         panic!("Generated ChannelUpdate for wrong chan!");
7741                                 }
7742                         },
7743                         _ => panic!("Unexpected event"),
7744                 }
7745         }
7746 }
7747
7748 #[test]
7749 fn test_bump_penalty_txn_on_revoked_commitment() {
7750         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7751         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7752
7753         let chanmon_cfgs = create_chanmon_cfgs(2);
7754         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7755         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7756         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7757
7758         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7759         let logger = test_utils::TestLogger::new();
7760
7761         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7762         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7763         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();
7764         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7765
7766         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7767         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7768         assert_eq!(revoked_txn[0].output.len(), 4);
7769         assert_eq!(revoked_txn[0].input.len(), 1);
7770         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7771         let revoked_txid = revoked_txn[0].txid();
7772
7773         let mut penalty_sum = 0;
7774         for outp in revoked_txn[0].output.iter() {
7775                 if outp.script_pubkey.is_v0_p2wsh() {
7776                         penalty_sum += outp.value;
7777                 }
7778         }
7779
7780         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7781         let header_114 = connect_blocks(&nodes[1], 14);
7782
7783         // Actually revoke tx by claiming a HTLC
7784         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7785         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7786         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7787         check_added_monitors!(nodes[1], 1);
7788
7789         // One or more justice tx should have been broadcast, check it
7790         let penalty_1;
7791         let feerate_1;
7792         {
7793                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7794                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7795                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7796                 assert_eq!(node_txn[0].output.len(), 1);
7797                 check_spends!(node_txn[0], revoked_txn[0]);
7798                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7799                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7800                 penalty_1 = node_txn[0].txid();
7801                 node_txn.clear();
7802         };
7803
7804         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7805         connect_blocks(&nodes[1], 15);
7806         let mut penalty_2 = penalty_1;
7807         let mut feerate_2 = 0;
7808         {
7809                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7810                 assert_eq!(node_txn.len(), 1);
7811                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7812                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7813                         assert_eq!(node_txn[0].output.len(), 1);
7814                         check_spends!(node_txn[0], revoked_txn[0]);
7815                         penalty_2 = node_txn[0].txid();
7816                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7817                         assert_ne!(penalty_2, penalty_1);
7818                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7819                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7820                         // Verify 25% bump heuristic
7821                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7822                         node_txn.clear();
7823                 }
7824         }
7825         assert_ne!(feerate_2, 0);
7826
7827         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7828         connect_blocks(&nodes[1], 1);
7829         let penalty_3;
7830         let mut feerate_3 = 0;
7831         {
7832                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7833                 assert_eq!(node_txn.len(), 1);
7834                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7835                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7836                         assert_eq!(node_txn[0].output.len(), 1);
7837                         check_spends!(node_txn[0], revoked_txn[0]);
7838                         penalty_3 = node_txn[0].txid();
7839                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7840                         assert_ne!(penalty_3, penalty_2);
7841                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7842                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7843                         // Verify 25% bump heuristic
7844                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7845                         node_txn.clear();
7846                 }
7847         }
7848         assert_ne!(feerate_3, 0);
7849
7850         nodes[1].node.get_and_clear_pending_events();
7851         nodes[1].node.get_and_clear_pending_msg_events();
7852 }
7853
7854 #[test]
7855 fn test_bump_penalty_txn_on_revoked_htlcs() {
7856         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7857         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7858
7859         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7860         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7861         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7863         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7864
7865         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7866         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7867         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7868                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7869         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7870         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
7871                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7872         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7873
7874         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7875         assert_eq!(revoked_local_txn[0].input.len(), 1);
7876         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7877
7878         // Revoke local commitment tx
7879         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7880
7881         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7882         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7883         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7884         check_closed_broadcast!(nodes[1], true);
7885         check_added_monitors!(nodes[1], 1);
7886
7887         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7888         assert_eq!(revoked_htlc_txn.len(), 4);
7889         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7890                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7891                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7892                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7893                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7894                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7895                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7896         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7897                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7898                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7899                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7900                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7901                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7902                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7903         }
7904
7905         // Broadcast set of revoked txn on A
7906         let hash_128 = connect_blocks(&nodes[0], 40);
7907         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7908         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7909         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7910         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7911         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7912         let first;
7913         let feerate_1;
7914         let penalty_txn;
7915         {
7916                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7917                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7918                 // Verify claim tx are spending revoked HTLC txn
7919
7920                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7921                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7922                 // which are included in the same block (they are broadcasted because we scan the
7923                 // transactions linearly and generate claims as we go, they likely should be removed in the
7924                 // future).
7925                 assert_eq!(node_txn[0].input.len(), 1);
7926                 check_spends!(node_txn[0], revoked_local_txn[0]);
7927                 assert_eq!(node_txn[1].input.len(), 1);
7928                 check_spends!(node_txn[1], revoked_local_txn[0]);
7929                 assert_eq!(node_txn[2].input.len(), 1);
7930                 check_spends!(node_txn[2], revoked_local_txn[0]);
7931
7932                 // Each of the three justice transactions claim a separate (single) output of the three
7933                 // available, which we check here:
7934                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7935                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7936                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7937
7938                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7939                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7940
7941                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7942                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7943                 // a remote commitment tx has already been confirmed).
7944                 check_spends!(node_txn[3], chan.3);
7945
7946                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7947                 // output, checked above).
7948                 assert_eq!(node_txn[4].input.len(), 2);
7949                 assert_eq!(node_txn[4].output.len(), 1);
7950                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7951
7952                 first = node_txn[4].txid();
7953                 // Store both feerates for later comparison
7954                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7955                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7956                 penalty_txn = vec![node_txn[2].clone()];
7957                 node_txn.clear();
7958         }
7959
7960         // Connect one more block to see if bumped penalty are issued for HTLC txn
7961         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7962         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7963         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7964         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7965         {
7966                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7967                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7968
7969                 check_spends!(node_txn[0], revoked_local_txn[0]);
7970                 check_spends!(node_txn[1], revoked_local_txn[0]);
7971                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7972                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7973                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7974                 } else {
7975                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7976                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7977                 }
7978
7979                 node_txn.clear();
7980         };
7981
7982         // Few more blocks to confirm penalty txn
7983         connect_blocks(&nodes[0], 4);
7984         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7985         let header_144 = connect_blocks(&nodes[0], 9);
7986         let node_txn = {
7987                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7988                 assert_eq!(node_txn.len(), 1);
7989
7990                 assert_eq!(node_txn[0].input.len(), 2);
7991                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7992                 // Verify bumped tx is different and 25% bump heuristic
7993                 assert_ne!(first, node_txn[0].txid());
7994                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7995                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7996                 assert!(feerate_2 * 100 > feerate_1 * 125);
7997                 let txn = vec![node_txn[0].clone()];
7998                 node_txn.clear();
7999                 txn
8000         };
8001         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8002         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8003         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8004         connect_blocks(&nodes[0], 20);
8005         {
8006                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8007                 // We verify than no new transaction has been broadcast because previously
8008                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8009                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8010                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8011                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8012                 // up bumped justice generation.
8013                 assert_eq!(node_txn.len(), 0);
8014                 node_txn.clear();
8015         }
8016         check_closed_broadcast!(nodes[0], true);
8017         check_added_monitors!(nodes[0], 1);
8018 }
8019
8020 #[test]
8021 fn test_bump_penalty_txn_on_remote_commitment() {
8022         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8023         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8024
8025         // Create 2 HTLCs
8026         // Provide preimage for one
8027         // Check aggregation
8028
8029         let chanmon_cfgs = create_chanmon_cfgs(2);
8030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8032         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8033
8034         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8035         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8036         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8037
8038         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8039         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8040         assert_eq!(remote_txn[0].output.len(), 4);
8041         assert_eq!(remote_txn[0].input.len(), 1);
8042         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8043
8044         // Claim a HTLC without revocation (provide B monitor with preimage)
8045         nodes[1].node.claim_funds(payment_preimage);
8046         mine_transaction(&nodes[1], &remote_txn[0]);
8047         check_added_monitors!(nodes[1], 2);
8048
8049         // One or more claim tx should have been broadcast, check it
8050         let timeout;
8051         let preimage;
8052         let feerate_timeout;
8053         let feerate_preimage;
8054         {
8055                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8056                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8057                 assert_eq!(node_txn[0].input.len(), 1);
8058                 assert_eq!(node_txn[1].input.len(), 1);
8059                 check_spends!(node_txn[0], remote_txn[0]);
8060                 check_spends!(node_txn[1], remote_txn[0]);
8061                 check_spends!(node_txn[2], chan.3);
8062                 check_spends!(node_txn[3], node_txn[2]);
8063                 check_spends!(node_txn[4], node_txn[2]);
8064                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8065                         timeout = node_txn[0].txid();
8066                         let index = node_txn[0].input[0].previous_output.vout;
8067                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8068                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8069
8070                         preimage = node_txn[1].txid();
8071                         let index = node_txn[1].input[0].previous_output.vout;
8072                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8073                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8074                 } else {
8075                         timeout = node_txn[1].txid();
8076                         let index = node_txn[1].input[0].previous_output.vout;
8077                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8078                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8079
8080                         preimage = node_txn[0].txid();
8081                         let index = node_txn[0].input[0].previous_output.vout;
8082                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8083                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8084                 }
8085                 node_txn.clear();
8086         };
8087         assert_ne!(feerate_timeout, 0);
8088         assert_ne!(feerate_preimage, 0);
8089
8090         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8091         connect_blocks(&nodes[1], 15);
8092         {
8093                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8094                 assert_eq!(node_txn.len(), 2);
8095                 assert_eq!(node_txn[0].input.len(), 1);
8096                 assert_eq!(node_txn[1].input.len(), 1);
8097                 check_spends!(node_txn[0], remote_txn[0]);
8098                 check_spends!(node_txn[1], remote_txn[0]);
8099                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8100                         let index = node_txn[0].input[0].previous_output.vout;
8101                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8102                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8103                         assert!(new_feerate * 100 > feerate_timeout * 125);
8104                         assert_ne!(timeout, node_txn[0].txid());
8105
8106                         let index = node_txn[1].input[0].previous_output.vout;
8107                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8108                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8109                         assert!(new_feerate * 100 > feerate_preimage * 125);
8110                         assert_ne!(preimage, node_txn[1].txid());
8111                 } else {
8112                         let index = node_txn[1].input[0].previous_output.vout;
8113                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8114                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8115                         assert!(new_feerate * 100 > feerate_timeout * 125);
8116                         assert_ne!(timeout, node_txn[1].txid());
8117
8118                         let index = node_txn[0].input[0].previous_output.vout;
8119                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8120                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8121                         assert!(new_feerate * 100 > feerate_preimage * 125);
8122                         assert_ne!(preimage, node_txn[0].txid());
8123                 }
8124                 node_txn.clear();
8125         }
8126
8127         nodes[1].node.get_and_clear_pending_events();
8128         nodes[1].node.get_and_clear_pending_msg_events();
8129 }
8130
8131 #[test]
8132 fn test_counterparty_raa_skip_no_crash() {
8133         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8134         // commitment transaction, we would have happily carried on and provided them the next
8135         // commitment transaction based on one RAA forward. This would probably eventually have led to
8136         // channel closure, but it would not have resulted in funds loss. Still, our
8137         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8138         // check simply that the channel is closed in response to such an RAA, but don't check whether
8139         // we decide to punish our counterparty for revoking their funds (as we don't currently
8140         // implement that).
8141         let chanmon_cfgs = create_chanmon_cfgs(2);
8142         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8143         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8144         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8145         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8146
8147         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8148         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8149         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8150         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8151         // Must revoke without gaps
8152         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8153         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8154                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8155
8156         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8157                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8158         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8159         check_added_monitors!(nodes[1], 1);
8160 }
8161
8162 #[test]
8163 fn test_bump_txn_sanitize_tracking_maps() {
8164         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8165         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8166
8167         let chanmon_cfgs = create_chanmon_cfgs(2);
8168         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8169         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8170         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8171
8172         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8173         // Lock HTLC in both directions
8174         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8175         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8176
8177         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8178         assert_eq!(revoked_local_txn[0].input.len(), 1);
8179         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8180
8181         // Revoke local commitment tx
8182         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8183
8184         // Broadcast set of revoked txn on A
8185         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8186         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8187         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8188
8189         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8190         check_closed_broadcast!(nodes[0], true);
8191         check_added_monitors!(nodes[0], 1);
8192         let penalty_txn = {
8193                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8194                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8195                 check_spends!(node_txn[0], revoked_local_txn[0]);
8196                 check_spends!(node_txn[1], revoked_local_txn[0]);
8197                 check_spends!(node_txn[2], revoked_local_txn[0]);
8198                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8199                 node_txn.clear();
8200                 penalty_txn
8201         };
8202         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8203         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8204         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8205         {
8206                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8207                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8208                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8209                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8210                 }
8211         }
8212 }
8213
8214 #[test]
8215 fn test_override_channel_config() {
8216         let chanmon_cfgs = create_chanmon_cfgs(2);
8217         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8218         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8219         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8220
8221         // Node0 initiates a channel to node1 using the override config.
8222         let mut override_config = UserConfig::default();
8223         override_config.own_channel_config.our_to_self_delay = 200;
8224
8225         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8226
8227         // Assert the channel created by node0 is using the override config.
8228         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8229         assert_eq!(res.channel_flags, 0);
8230         assert_eq!(res.to_self_delay, 200);
8231 }
8232
8233 #[test]
8234 fn test_override_0msat_htlc_minimum() {
8235         let mut zero_config = UserConfig::default();
8236         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8237         let chanmon_cfgs = create_chanmon_cfgs(2);
8238         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8239         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8240         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8241
8242         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8243         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8244         assert_eq!(res.htlc_minimum_msat, 1);
8245
8246         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8247         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8248         assert_eq!(res.htlc_minimum_msat, 1);
8249 }
8250
8251 #[test]
8252 fn test_simple_mpp() {
8253         // Simple test of sending a multi-path payment.
8254         let chanmon_cfgs = create_chanmon_cfgs(4);
8255         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8256         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8257         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8258
8259         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8260         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8261         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8262         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8263         let logger = test_utils::TestLogger::new();
8264
8265         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8266         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8267         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();
8268         let path = route.paths[0].clone();
8269         route.paths.push(path);
8270         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8271         route.paths[0][0].short_channel_id = chan_1_id;
8272         route.paths[0][1].short_channel_id = chan_3_id;
8273         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8274         route.paths[1][0].short_channel_id = chan_2_id;
8275         route.paths[1][1].short_channel_id = chan_4_id;
8276         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8277         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8278 }
8279
8280 #[test]
8281 fn test_preimage_storage() {
8282         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8283         let chanmon_cfgs = create_chanmon_cfgs(2);
8284         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8285         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8286         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8287
8288         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8289
8290         {
8291                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8292
8293                 let logger = test_utils::TestLogger::new();
8294                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8295                 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();
8296                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8297                 check_added_monitors!(nodes[0], 1);
8298                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8299                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8300                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8301                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8302         }
8303         // Note that after leaving the above scope we have no knowledge of any arguments or return
8304         // values from previous calls.
8305         expect_pending_htlcs_forwardable!(nodes[1]);
8306         let events = nodes[1].node.get_and_clear_pending_events();
8307         assert_eq!(events.len(), 1);
8308         match events[0] {
8309                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8310                         assert_eq!(user_payment_id, 42);
8311                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8312                 },
8313                 _ => panic!("Unexpected event"),
8314         }
8315 }
8316
8317 #[test]
8318 fn test_secret_timeout() {
8319         // Simple test of payment secret storage time outs
8320         let chanmon_cfgs = create_chanmon_cfgs(2);
8321         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8322         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8323         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8324
8325         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8326
8327         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8328
8329         // We should fail to register the same payment hash twice, at least until we've connected a
8330         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8331         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8332                 assert_eq!(err, "Duplicate payment hash");
8333         } else { panic!(); }
8334         let mut block = Block {
8335                 header: BlockHeader {
8336                         version: 0x2000000,
8337                         prev_blockhash: nodes[1].blocks.borrow().last().unwrap().0.block_hash(),
8338                         merkle_root: Default::default(),
8339                         time: nodes[1].blocks.borrow().len() as u32 + 7200, bits: 42, nonce: 42 },
8340                 txdata: vec![],
8341         };
8342         connect_block(&nodes[1], &block);
8343         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8344                 assert_eq!(err, "Duplicate payment hash");
8345         } else { panic!(); }
8346
8347         // If we then connect the second block, we should be able to register the same payment hash
8348         // again with a different user_payment_id (this time getting a new payment secret).
8349         block.header.prev_blockhash = block.header.block_hash();
8350         block.header.time += 1;
8351         connect_block(&nodes[1], &block);
8352         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8353         assert_ne!(payment_secret_1, our_payment_secret);
8354
8355         {
8356                 let logger = test_utils::TestLogger::new();
8357                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8358                 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();
8359                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8360                 check_added_monitors!(nodes[0], 1);
8361                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8362                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8363                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8364                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8365         }
8366         // Note that after leaving the above scope we have no knowledge of any arguments or return
8367         // values from previous calls.
8368         expect_pending_htlcs_forwardable!(nodes[1]);
8369         let events = nodes[1].node.get_and_clear_pending_events();
8370         assert_eq!(events.len(), 1);
8371         match events[0] {
8372                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8373                         assert!(payment_preimage.is_none());
8374                         assert_eq!(user_payment_id, 42);
8375                         assert_eq!(payment_secret, our_payment_secret);
8376                         // We don't actually have the payment preimage with which to claim this payment!
8377                 },
8378                 _ => panic!("Unexpected event"),
8379         }
8380 }
8381
8382 #[test]
8383 fn test_bad_secret_hash() {
8384         // Simple test of unregistered payment hash/invalid payment secret handling
8385         let chanmon_cfgs = create_chanmon_cfgs(2);
8386         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8387         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8388         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8389
8390         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8391
8392         let random_payment_hash = PaymentHash([42; 32]);
8393         let random_payment_secret = PaymentSecret([43; 32]);
8394         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8395
8396         let logger = test_utils::TestLogger::new();
8397         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8398         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();
8399
8400         // All the below cases should end up being handled exactly identically, so we macro the
8401         // resulting events.
8402         macro_rules! handle_unknown_invalid_payment_data {
8403                 () => {
8404                         check_added_monitors!(nodes[0], 1);
8405                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8406                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8407                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8408                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8409
8410                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8411                         // again to process the pending backwards-failure of the HTLC
8412                         expect_pending_htlcs_forwardable!(nodes[1]);
8413                         expect_pending_htlcs_forwardable!(nodes[1]);
8414                         check_added_monitors!(nodes[1], 1);
8415
8416                         // We should fail the payment back
8417                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8418                         match events.pop().unwrap() {
8419                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8420                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8421                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8422                                 },
8423                                 _ => panic!("Unexpected event"),
8424                         }
8425                 }
8426         }
8427
8428         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8429         // Error data is the HTLC value (100,000) and current block height
8430         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8431
8432         // Send a payment with the right payment hash but the wrong payment secret
8433         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8434         handle_unknown_invalid_payment_data!();
8435         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8436
8437         // Send a payment with a random payment hash, but the right payment secret
8438         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8439         handle_unknown_invalid_payment_data!();
8440         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8441
8442         // Send a payment with a random payment hash and random payment secret
8443         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8444         handle_unknown_invalid_payment_data!();
8445         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8446 }
8447
8448 #[test]
8449 fn test_update_err_monitor_lockdown() {
8450         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8451         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8452         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8453         //
8454         // This scenario may happen in a watchtower setup, where watchtower process a block height
8455         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8456         // commitment at same time.
8457
8458         let chanmon_cfgs = create_chanmon_cfgs(2);
8459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8461         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8462
8463         // Create some initial channel
8464         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8465         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8466
8467         // Rebalance the network to generate htlc in the two directions
8468         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8469
8470         // Route a HTLC from node 0 to node 1 (but don't settle)
8471         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8472
8473         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8474         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8475         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8476         let persister = test_utils::TestPersister::new();
8477         let watchtower = {
8478                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8479                 let monitor = monitors.get(&outpoint).unwrap();
8480                 let mut w = test_utils::TestVecWriter(Vec::new());
8481                 monitor.write(&mut w).unwrap();
8482                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8483                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8484                 assert!(new_monitor == *monitor);
8485                 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);
8486                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8487                 watchtower
8488         };
8489         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8490         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8491
8492         // Try to update ChannelMonitor
8493         assert!(nodes[1].node.claim_funds(preimage));
8494         check_added_monitors!(nodes[1], 1);
8495         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8496         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8497         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8498         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8499                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8500                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8501                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8502                 } else { assert!(false); }
8503         } else { assert!(false); };
8504         // Our local monitor is in-sync and hasn't processed yet timeout
8505         check_added_monitors!(nodes[0], 1);
8506         let events = nodes[0].node.get_and_clear_pending_events();
8507         assert_eq!(events.len(), 1);
8508 }
8509
8510 #[test]
8511 fn test_concurrent_monitor_claim() {
8512         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8513         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8514         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8515         // state N+1 confirms. Alice claims output from state N+1.
8516
8517         let chanmon_cfgs = create_chanmon_cfgs(2);
8518         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8519         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8520         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8521
8522         // Create some initial channel
8523         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8524         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8525
8526         // Rebalance the network to generate htlc in the two directions
8527         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8528
8529         // Route a HTLC from node 0 to node 1 (but don't settle)
8530         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8531
8532         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8533         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8534         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8535         let persister = test_utils::TestPersister::new();
8536         let watchtower_alice = {
8537                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8538                 let monitor = monitors.get(&outpoint).unwrap();
8539                 let mut w = test_utils::TestVecWriter(Vec::new());
8540                 monitor.write(&mut w).unwrap();
8541                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8542                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8543                 assert!(new_monitor == *monitor);
8544                 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);
8545                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8546                 watchtower
8547         };
8548         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8549         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8550
8551         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8552         {
8553                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8554                 assert_eq!(txn.len(), 2);
8555                 txn.clear();
8556         }
8557
8558         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8559         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8560         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8561         let persister = test_utils::TestPersister::new();
8562         let watchtower_bob = {
8563                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8564                 let monitor = monitors.get(&outpoint).unwrap();
8565                 let mut w = test_utils::TestVecWriter(Vec::new());
8566                 monitor.write(&mut w).unwrap();
8567                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8568                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8569                 assert!(new_monitor == *monitor);
8570                 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);
8571                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8572                 watchtower
8573         };
8574         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8575         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8576
8577         // Route another payment to generate another update with still previous HTLC pending
8578         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8579         {
8580                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8581                 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();
8582                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8583         }
8584         check_added_monitors!(nodes[1], 1);
8585
8586         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8587         assert_eq!(updates.update_add_htlcs.len(), 1);
8588         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8589         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8590                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8591                         // Watchtower Alice should already have seen the block and reject the update
8592                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8593                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8594                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8595                 } else { assert!(false); }
8596         } else { assert!(false); };
8597         // Our local monitor is in-sync and hasn't processed yet timeout
8598         check_added_monitors!(nodes[0], 1);
8599
8600         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8601         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8602         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8603
8604         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8605         let bob_state_y;
8606         {
8607                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8608                 assert_eq!(txn.len(), 2);
8609                 bob_state_y = txn[0].clone();
8610                 txn.clear();
8611         };
8612
8613         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8614         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8615         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);
8616         {
8617                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8618                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8619                 // the onchain detection of the HTLC output
8620                 assert_eq!(htlc_txn.len(), 2);
8621                 check_spends!(htlc_txn[0], bob_state_y);
8622                 check_spends!(htlc_txn[1], bob_state_y);
8623         }
8624 }
8625
8626 #[test]
8627 fn test_pre_lockin_no_chan_closed_update() {
8628         // Test that if a peer closes a channel in response to a funding_created message we don't
8629         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8630         // message).
8631         //
8632         // Doing so would imply a channel monitor update before the initial channel monitor
8633         // registration, violating our API guarantees.
8634         //
8635         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8636         // then opening a second channel with the same funding output as the first (which is not
8637         // rejected because the first channel does not exist in the ChannelManager) and closing it
8638         // before receiving funding_signed.
8639         let chanmon_cfgs = create_chanmon_cfgs(2);
8640         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8641         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8642         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8643
8644         // Create an initial channel
8645         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8646         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8647         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8648         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8649         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8650
8651         // Move the first channel through the funding flow...
8652         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8653
8654         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8655         check_added_monitors!(nodes[0], 0);
8656
8657         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8658         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8659         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8660         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8661 }
8662
8663 #[test]
8664 fn test_htlc_no_detection() {
8665         // This test is a mutation to underscore the detection logic bug we had
8666         // before #653. HTLC value routed is above the remaining balance, thus
8667         // inverting HTLC and `to_remote` output. HTLC will come second and
8668         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8669         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8670         // outputs order detection for correct spending children filtring.
8671
8672         let chanmon_cfgs = create_chanmon_cfgs(2);
8673         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8674         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8675         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8676
8677         // Create some initial channels
8678         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8679
8680         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8681         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8682         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8683         assert_eq!(local_txn[0].input.len(), 1);
8684         assert_eq!(local_txn[0].output.len(), 3);
8685         check_spends!(local_txn[0], chan_1.3);
8686
8687         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8688         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8689         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8690         // We deliberately connect the local tx twice as this should provoke a failure calling
8691         // this test before #653 fix.
8692         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);
8693         check_closed_broadcast!(nodes[0], true);
8694         check_added_monitors!(nodes[0], 1);
8695
8696         let htlc_timeout = {
8697                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8698                 assert_eq!(node_txn[0].input.len(), 1);
8699                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8700                 check_spends!(node_txn[0], local_txn[0]);
8701                 node_txn[0].clone()
8702         };
8703
8704         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8705         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8706         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8707         expect_payment_failed!(nodes[0], our_payment_hash, true);
8708 }
8709
8710 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8711         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8712         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8713         // Carol, Alice would be the upstream node, and Carol the downstream.)
8714         //
8715         // Steps of the test:
8716         // 1) Alice sends a HTLC to Carol through Bob.
8717         // 2) Carol doesn't settle the HTLC.
8718         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8719         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8720         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8721         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8722         // 5) Carol release the preimage to Bob off-chain.
8723         // 6) Bob claims the offered output on the broadcasted commitment.
8724         let chanmon_cfgs = create_chanmon_cfgs(3);
8725         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8726         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8727         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8728
8729         // Create some initial channels
8730         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8731         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8732
8733         // Steps (1) and (2):
8734         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8735         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8736
8737         // Check that Alice's commitment transaction now contains an output for this HTLC.
8738         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8739         check_spends!(alice_txn[0], chan_ab.3);
8740         assert_eq!(alice_txn[0].output.len(), 2);
8741         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8742         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8743         assert_eq!(alice_txn.len(), 2);
8744
8745         // Steps (3) and (4):
8746         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8747         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8748         let mut force_closing_node = 0; // Alice force-closes
8749         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8750         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8751         check_closed_broadcast!(nodes[force_closing_node], true);
8752         check_added_monitors!(nodes[force_closing_node], 1);
8753         if go_onchain_before_fulfill {
8754                 let txn_to_broadcast = match broadcast_alice {
8755                         true => alice_txn.clone(),
8756                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8757                 };
8758                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8759                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8760                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8761                 if broadcast_alice {
8762                         check_closed_broadcast!(nodes[1], true);
8763                         check_added_monitors!(nodes[1], 1);
8764                 }
8765                 assert_eq!(bob_txn.len(), 1);
8766                 check_spends!(bob_txn[0], chan_ab.3);
8767         }
8768
8769         // Step (5):
8770         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8771         // process of removing the HTLC from their commitment transactions.
8772         assert!(nodes[2].node.claim_funds(payment_preimage));
8773         check_added_monitors!(nodes[2], 1);
8774         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8775         assert!(carol_updates.update_add_htlcs.is_empty());
8776         assert!(carol_updates.update_fail_htlcs.is_empty());
8777         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8778         assert!(carol_updates.update_fee.is_none());
8779         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8780
8781         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8782         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8783         if !go_onchain_before_fulfill && broadcast_alice {
8784                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8785                 assert_eq!(events.len(), 1);
8786                 match events[0] {
8787                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8788                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8789                         },
8790                         _ => panic!("Unexpected event"),
8791                 };
8792         }
8793         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8794         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8795         // Carol<->Bob's updated commitment transaction info.
8796         check_added_monitors!(nodes[1], 2);
8797
8798         let events = nodes[1].node.get_and_clear_pending_msg_events();
8799         assert_eq!(events.len(), 2);
8800         let bob_revocation = match events[0] {
8801                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8802                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8803                         (*msg).clone()
8804                 },
8805                 _ => panic!("Unexpected event"),
8806         };
8807         let bob_updates = match events[1] {
8808                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8809                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8810                         (*updates).clone()
8811                 },
8812                 _ => panic!("Unexpected event"),
8813         };
8814
8815         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8816         check_added_monitors!(nodes[2], 1);
8817         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8818         check_added_monitors!(nodes[2], 1);
8819
8820         let events = nodes[2].node.get_and_clear_pending_msg_events();
8821         assert_eq!(events.len(), 1);
8822         let carol_revocation = match events[0] {
8823                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8824                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8825                         (*msg).clone()
8826                 },
8827                 _ => panic!("Unexpected event"),
8828         };
8829         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8830         check_added_monitors!(nodes[1], 1);
8831
8832         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8833         // here's where we put said channel's commitment tx on-chain.
8834         let mut txn_to_broadcast = alice_txn.clone();
8835         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8836         if !go_onchain_before_fulfill {
8837                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8838                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8839                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8840                 if broadcast_alice {
8841                         check_closed_broadcast!(nodes[1], true);
8842                         check_added_monitors!(nodes[1], 1);
8843                 }
8844                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8845                 if broadcast_alice {
8846                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8847                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8848                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8849                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8850                         // broadcasted.
8851                         assert_eq!(bob_txn.len(), 3);
8852                         check_spends!(bob_txn[1], chan_ab.3);
8853                 } else {
8854                         assert_eq!(bob_txn.len(), 2);
8855                         check_spends!(bob_txn[0], chan_ab.3);
8856                 }
8857         }
8858
8859         // Step (6):
8860         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8861         // broadcasted commitment transaction.
8862         {
8863                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8864                 if go_onchain_before_fulfill {
8865                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8866                         assert_eq!(bob_txn.len(), 2);
8867                 }
8868                 let script_weight = match broadcast_alice {
8869                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8870                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8871                 };
8872                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8873                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8874                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8875                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8876                 if broadcast_alice && !go_onchain_before_fulfill {
8877                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8878                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8879                 } else {
8880                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8881                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8882                 }
8883         }
8884 }
8885
8886 #[test]
8887 fn test_onchain_htlc_settlement_after_close() {
8888         do_test_onchain_htlc_settlement_after_close(true, true);
8889         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8890         do_test_onchain_htlc_settlement_after_close(true, false);
8891         do_test_onchain_htlc_settlement_after_close(false, false);
8892 }
8893
8894 #[test]
8895 fn test_duplicate_chan_id() {
8896         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8897         // already open we reject it and keep the old channel.
8898         //
8899         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8900         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8901         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8902         // updating logic for the existing channel.
8903         let chanmon_cfgs = create_chanmon_cfgs(2);
8904         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8906         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8907
8908         // Create an initial channel
8909         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8910         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8911         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8912         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()));
8913
8914         // Try to create a second channel with the same temporary_channel_id as the first and check
8915         // that it is rejected.
8916         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8917         {
8918                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8919                 assert_eq!(events.len(), 1);
8920                 match events[0] {
8921                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8922                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8923                                 // first (valid) and second (invalid) channels are closed, given they both have
8924                                 // the same non-temporary channel_id. However, currently we do not, so we just
8925                                 // move forward with it.
8926                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8927                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8928                         },
8929                         _ => panic!("Unexpected event"),
8930                 }
8931         }
8932
8933         // Move the first channel through the funding flow...
8934         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8935
8936         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8937         check_added_monitors!(nodes[0], 0);
8938
8939         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8940         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8941         {
8942                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8943                 assert_eq!(added_monitors.len(), 1);
8944                 assert_eq!(added_monitors[0].0, funding_output);
8945                 added_monitors.clear();
8946         }
8947         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8948
8949         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8950         let channel_id = funding_outpoint.to_channel_id();
8951
8952         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8953         // temporary one).
8954
8955         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8956         // Technically this is allowed by the spec, but we don't support it and there's little reason
8957         // to. Still, it shouldn't cause any other issues.
8958         open_chan_msg.temporary_channel_id = channel_id;
8959         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8960         {
8961                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8962                 assert_eq!(events.len(), 1);
8963                 match events[0] {
8964                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8965                                 // Technically, at this point, nodes[1] would be justified in thinking both
8966                                 // channels are closed, but currently we do not, so we just move forward with it.
8967                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8968                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8969                         },
8970                         _ => panic!("Unexpected event"),
8971                 }
8972         }
8973
8974         // Now try to create a second channel which has a duplicate funding output.
8975         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8976         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8977         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8978         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()));
8979         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8980
8981         let funding_created = {
8982                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8983                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8984                 let logger = test_utils::TestLogger::new();
8985                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8986         };
8987         check_added_monitors!(nodes[0], 0);
8988         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8989         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8990         // still needs to be cleared here.
8991         check_added_monitors!(nodes[1], 1);
8992
8993         // ...still, nodes[1] will reject the duplicate channel.
8994         {
8995                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8996                 assert_eq!(events.len(), 1);
8997                 match events[0] {
8998                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8999                                 // Technically, at this point, nodes[1] would be justified in thinking both
9000                                 // channels are closed, but currently we do not, so we just move forward with it.
9001                                 assert_eq!(msg.channel_id, channel_id);
9002                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9003                         },
9004                         _ => panic!("Unexpected event"),
9005                 }
9006         }
9007
9008         // finally, finish creating the original channel and send a payment over it to make sure
9009         // everything is functional.
9010         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9011         {
9012                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9013                 assert_eq!(added_monitors.len(), 1);
9014                 assert_eq!(added_monitors[0].0, funding_output);
9015                 added_monitors.clear();
9016         }
9017
9018         let events_4 = nodes[0].node.get_and_clear_pending_events();
9019         assert_eq!(events_4.len(), 0);
9020         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9021         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9022
9023         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9024         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9025         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9026         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9027 }
9028
9029 #[test]
9030 fn test_error_chans_closed() {
9031         // Test that we properly handle error messages, closing appropriate channels.
9032         //
9033         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9034         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9035         // we can test various edge cases around it to ensure we don't regress.
9036         let chanmon_cfgs = create_chanmon_cfgs(3);
9037         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9038         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9039         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9040
9041         // Create some initial channels
9042         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9043         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9044         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9045
9046         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9047         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9048         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9049
9050         // Closing a channel from a different peer has no effect
9051         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9052         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9053
9054         // Closing one channel doesn't impact others
9055         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9056         check_added_monitors!(nodes[0], 1);
9057         check_closed_broadcast!(nodes[0], false);
9058         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9059         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9060         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);
9061         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);
9062
9063         // A null channel ID should close all channels
9064         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9065         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9066         check_added_monitors!(nodes[0], 2);
9067         let events = nodes[0].node.get_and_clear_pending_msg_events();
9068         assert_eq!(events.len(), 2);
9069         match events[0] {
9070                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9071                         assert_eq!(msg.contents.flags & 2, 2);
9072                 },
9073                 _ => panic!("Unexpected event"),
9074         }
9075         match events[1] {
9076                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9077                         assert_eq!(msg.contents.flags & 2, 2);
9078                 },
9079                 _ => panic!("Unexpected event"),
9080         }
9081         // Note that at this point users of a standard PeerHandler will end up calling
9082         // peer_disconnected with no_connection_possible set to false, duplicating the
9083         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9084         // users with their own peer handling logic. We duplicate the call here, however.
9085         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9086         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9087
9088         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9089         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9090         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9091 }
9092
9093 #[test]
9094 fn test_invalid_funding_tx() {
9095         // Test that we properly handle invalid funding transactions sent to us from a peer.
9096         //
9097         // Previously, all other major lightning implementations had failed to properly sanitize
9098         // funding transactions from their counterparties, leading to a multi-implementation critical
9099         // security vulnerability (though we always sanitized properly, we've previously had
9100         // un-released crashes in the sanitization process).
9101         let chanmon_cfgs = create_chanmon_cfgs(2);
9102         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9103         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9104         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9105
9106         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9107         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()));
9108         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()));
9109
9110         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9111         for output in tx.output.iter_mut() {
9112                 // Make the confirmed funding transaction have a bogus script_pubkey
9113                 output.script_pubkey = bitcoin::Script::new();
9114         }
9115
9116         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9117         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()));
9118         check_added_monitors!(nodes[1], 1);
9119
9120         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()));
9121         check_added_monitors!(nodes[0], 1);
9122
9123         let events_1 = nodes[0].node.get_and_clear_pending_events();
9124         assert_eq!(events_1.len(), 0);
9125
9126         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9127         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9128         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9129
9130         confirm_transaction_at(&nodes[1], &tx, 1);
9131         check_added_monitors!(nodes[1], 1);
9132         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9133         assert_eq!(events_2.len(), 1);
9134         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9135                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9136                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9137                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9138                 } else { panic!(); }
9139         } else { panic!(); }
9140         assert_eq!(nodes[1].node.list_channels().len(), 0);
9141 }