_ 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, MIN_CLTV_EXPIRY_DELTA};
  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, 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 prelude::*;
  54 use alloc::collections::BTreeSet;
  55 use core::default::Default;
  56 use std::sync::{Arc, Mutex};
  57
  58 use ln::functional_test_utils::*;
  59 use ln::chan_utils::CommitmentTransaction;
  60 use ln::msgs::OptionalField::Present;
  61
  62 #[test]
  63 fn test_insane_channel_opens() {
  64         // Stand up a network of 2 nodes
  65         let chanmon_cfgs = create_chanmon_cfgs(2);
  66         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  67         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  68         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  69
  70         // Instantiate channel parameters where we push the maximum msats given our
  71         // funding satoshis
  72         let channel_value_sat = 31337; // same as funding satoshis
  73         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  74         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  75
  76         // Have node0 initiate a channel to node1 with aforementioned parameters
  77         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  78
  79         // Extract the channel open message from node0 to node1
  80         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  81
  82         // Test helper that asserts we get the correct error string given a mutator
  83         // that supposedly makes the channel open message insane
  84         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  85                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  86                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  87                 assert_eq!(msg_events.len(), 1);
  88                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  89                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  90                         match action {
  91                                 &ErrorAction::SendErrorMessage { .. } => {
  92                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  93                                 },
  94                                 _ => panic!("unexpected event!"),
  95                         }
  96                 } else { assert!(false); }
  97         };
  98
  99         use ln::channel::MAX_FUNDING_SATOSHIS;
 100         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 101
 102         // Test all mutations that would make the channel open message insane
 103         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 });
 104
 105         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 106
 107         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 });
 108
 109         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 110
 111         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 });
 112
 113         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 });
 114
 115         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 });
 116
 117         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 118
 119         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 120 }
 121
 122 #[test]
 123 fn test_async_inbound_update_fee() {
 124         let chanmon_cfgs = create_chanmon_cfgs(2);
 125         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 126         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 127         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 128         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 129         let logger = test_utils::TestLogger::new();
 130         let channel_id = chan.2;
 131
 132         // balancing
 133         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 134
 135         // A                                        B
 136         // update_fee                            ->
 137         // send (1) commitment_signed            -.
 138         //                                       <- update_add_htlc/commitment_signed
 139         // send (2) RAA (awaiting remote revoke) -.
 140         // (1) commitment_signed is delivered    ->
 141         //                                       .- send (3) RAA (awaiting remote revoke)
 142         // (2) RAA is delivered                  ->
 143         //                                       .- send (4) commitment_signed
 144         //                                       <- (3) RAA is delivered
 145         // send (5) commitment_signed            -.
 146         //                                       <- (4) commitment_signed is delivered
 147         // send (6) RAA                          -.
 148         // (5) commitment_signed is delivered    ->
 149         //                                       <- RAA
 150         // (6) RAA is delivered                  ->
 151
 152         // First nodes[0] generates an update_fee
 153         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 154         check_added_monitors!(nodes[0], 1);
 155
 156         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 157         assert_eq!(events_0.len(), 1);
 158         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 159                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 160                         (update_fee.as_ref(), commitment_signed)
 161                 },
 162                 _ => panic!("Unexpected event"),
 163         };
 164
 165         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 166
 167         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 168         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 169         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 170         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();
 171         check_added_monitors!(nodes[1], 1);
 172
 173         let payment_event = {
 174                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 175                 assert_eq!(events_1.len(), 1);
 176                 SendEvent::from_event(events_1.remove(0))
 177         };
 178         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 179         assert_eq!(payment_event.msgs.len(), 1);
 180
 181         // ...now when the messages get delivered everyone should be happy
 182         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 183         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 184         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 185         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 186         check_added_monitors!(nodes[0], 1);
 187
 188         // deliver(1), generate (3):
 189         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 190         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 191         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 192         check_added_monitors!(nodes[1], 1);
 193
 194         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 195         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 196         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 197         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fee.is_none()); // (4)
 201         check_added_monitors!(nodes[1], 1);
 202
 203         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 204         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 205         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 206         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fee.is_none()); // (5)
 210         check_added_monitors!(nodes[0], 1);
 211
 212         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 213         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 214         // only (6) so get_event_msg's assert(len == 1) passes
 215         check_added_monitors!(nodes[0], 1);
 216
 217         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 218         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 219         check_added_monitors!(nodes[1], 1);
 220
 221         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 222         check_added_monitors!(nodes[0], 1);
 223
 224         let events_2 = nodes[0].node.get_and_clear_pending_events();
 225         assert_eq!(events_2.len(), 1);
 226         match events_2[0] {
 227                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 228                 _ => panic!("Unexpected event"),
 229         }
 230
 231         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 232         check_added_monitors!(nodes[1], 1);
 233 }
 234
 235 #[test]
 236 fn test_update_fee_unordered_raa() {
 237         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 238         // crash in an earlier version of the update_fee patch)
 239         let chanmon_cfgs = create_chanmon_cfgs(2);
 240         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 241         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 242         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 243         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 244         let channel_id = chan.2;
 245         let logger = test_utils::TestLogger::new();
 246
 247         // balancing
 248         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 249
 250         // First nodes[0] generates an update_fee
 251         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 252         check_added_monitors!(nodes[0], 1);
 253
 254         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 255         assert_eq!(events_0.len(), 1);
 256         let update_msg = match events_0[0] { // (1)
 257                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 258                         update_fee.as_ref()
 259                 },
 260                 _ => panic!("Unexpected event"),
 261         };
 262
 263         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 264
 265         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 266         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 267         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 268         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();
 269         check_added_monitors!(nodes[1], 1);
 270
 271         let payment_event = {
 272                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 273                 assert_eq!(events_1.len(), 1);
 274                 SendEvent::from_event(events_1.remove(0))
 275         };
 276         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 277         assert_eq!(payment_event.msgs.len(), 1);
 278
 279         // ...now when the messages get delivered everyone should be happy
 280         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 281         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 282         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 283         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 284         check_added_monitors!(nodes[0], 1);
 285
 286         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 287         check_added_monitors!(nodes[1], 1);
 288
 289         // We can't continue, sadly, because our (1) now has a bogus signature
 290 }
 291
 292 #[test]
 293 fn test_multi_flight_update_fee() {
 294         let chanmon_cfgs = create_chanmon_cfgs(2);
 295         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 296         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 297         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 298         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 299         let channel_id = chan.2;
 300
 301         // A                                        B
 302         // update_fee/commitment_signed          ->
 303         //                                       .- send (1) RAA and (2) commitment_signed
 304         // update_fee (never committed)          ->
 305         // (3) update_fee                        ->
 306         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 307         // don't track which updates correspond to which revoke_and_ack responses so we're in
 308         // AwaitingRAA mode and will not generate the update_fee yet.
 309         //                                       <- (1) RAA delivered
 310         // (3) is generated and send (4) CS      -.
 311         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 312         // know the per_commitment_point to use for it.
 313         //                                       <- (2) commitment_signed delivered
 314         // revoke_and_ack                        ->
 315         //                                          B should send no response here
 316         // (4) commitment_signed delivered       ->
 317         //                                       <- RAA/commitment_signed delivered
 318         // revoke_and_ack                        ->
 319
 320         // First nodes[0] generates an update_fee
 321         let initial_feerate = get_feerate!(nodes[0], channel_id);
 322         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 323         check_added_monitors!(nodes[0], 1);
 324
 325         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 326         assert_eq!(events_0.len(), 1);
 327         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 328                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 329                         (update_fee.as_ref().unwrap(), commitment_signed)
 330                 },
 331                 _ => panic!("Unexpected event"),
 332         };
 333
 334         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 335         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 336         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 337         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 338         check_added_monitors!(nodes[1], 1);
 339
 340         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 341         // transaction:
 342         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 343         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 344         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 345
 346         // Create the (3) update_fee message that nodes[0] will generate before it does...
 347         let mut update_msg_2 = msgs::UpdateFee {
 348                 channel_id: update_msg_1.channel_id.clone(),
 349                 feerate_per_kw: (initial_feerate + 30) as u32,
 350         };
 351
 352         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 353
 354         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 355         // Deliver (3)
 356         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 357
 358         // Deliver (1), generating (3) and (4)
 359         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 360         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 361         check_added_monitors!(nodes[0], 1);
 362         assert!(as_second_update.update_add_htlcs.is_empty());
 363         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 364         assert!(as_second_update.update_fail_htlcs.is_empty());
 365         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 366         // Check that the update_fee newly generated matches what we delivered:
 367         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 368         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 369
 370         // Deliver (2) commitment_signed
 371         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 372         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 373         check_added_monitors!(nodes[0], 1);
 374         // No commitment_signed so get_event_msg's assert(len == 1) passes
 375
 376         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 377         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 378         check_added_monitors!(nodes[1], 1);
 379
 380         // Delever (4)
 381         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 382         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 383         check_added_monitors!(nodes[1], 1);
 384
 385         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 386         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 387         check_added_monitors!(nodes[0], 1);
 388
 389         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 390         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 391         // No commitment_signed so get_event_msg's assert(len == 1) passes
 392         check_added_monitors!(nodes[0], 1);
 393
 394         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 395         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 396         check_added_monitors!(nodes[1], 1);
 397 }
 398
 399 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 400         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 401         // tests that we properly send one in that case.
 402         let mut alice_config = UserConfig::default();
 403         alice_config.own_channel_config.minimum_depth = 1;
 404         alice_config.channel_options.announced_channel = true;
 405         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 406         let mut bob_config = UserConfig::default();
 407         bob_config.own_channel_config.minimum_depth = 1;
 408         bob_config.channel_options.announced_channel = true;
 409         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 410         let chanmon_cfgs = create_chanmon_cfgs(2);
 411         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 412         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 413         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 414         *nodes[0].connect_style.borrow_mut() = connect_style;
 415
 416         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 417         mine_transaction(&nodes[1], &tx);
 418         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()));
 419
 420         mine_transaction(&nodes[0], &tx);
 421         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 422         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 423
 424         for node in nodes {
 425                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 426                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 427                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 428         }
 429 }
 430 #[test]
 431 fn test_1_conf_open() {
 432         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 433         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 434         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 435 }
 436
 437 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 438         // Previously, we had issues deserializing channels when we hadn't connected the first block
 439         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 440         // serialization round-trips and simply do steps towards opening a channel and then drop the
 441         // Node objects.
 442
 443         let chanmon_cfgs = create_chanmon_cfgs(2);
 444         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 445         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 446         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 447
 448         if steps & 0b1000_0000 != 0{
 449                 let block = Block {
 450                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 451                         txdata: vec![],
 452                 };
 453                 connect_block(&nodes[0], &block);
 454                 connect_block(&nodes[1], &block);
 455         }
 456
 457         if steps & 0x0f == 0 { return; }
 458         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 459         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 460
 461         if steps & 0x0f == 1 { return; }
 462         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 463         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 464
 465         if steps & 0x0f == 2 { return; }
 466         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 467
 468         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 469
 470         if steps & 0x0f == 3 { return; }
 471         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 472         check_added_monitors!(nodes[0], 0);
 473         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 474
 475         if steps & 0x0f == 4 { return; }
 476         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 477         {
 478                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 479                 assert_eq!(added_monitors.len(), 1);
 480                 assert_eq!(added_monitors[0].0, funding_output);
 481                 added_monitors.clear();
 482         }
 483         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 484
 485         if steps & 0x0f == 5 { return; }
 486         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 487         {
 488                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 489                 assert_eq!(added_monitors.len(), 1);
 490                 assert_eq!(added_monitors[0].0, funding_output);
 491                 added_monitors.clear();
 492         }
 493
 494         let events_4 = nodes[0].node.get_and_clear_pending_events();
 495         assert_eq!(events_4.len(), 0);
 496
 497         if steps & 0x0f == 6 { return; }
 498         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 499
 500         if steps & 0x0f == 7 { return; }
 501         confirm_transaction_at(&nodes[0], &tx, 2);
 502         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 503         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 504 }
 505
 506 #[test]
 507 fn test_sanity_on_in_flight_opens() {
 508         do_test_sanity_on_in_flight_opens(0);
 509         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(1);
 511         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 512         do_test_sanity_on_in_flight_opens(2);
 513         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 514         do_test_sanity_on_in_flight_opens(3);
 515         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 516         do_test_sanity_on_in_flight_opens(4);
 517         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 518         do_test_sanity_on_in_flight_opens(5);
 519         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 520         do_test_sanity_on_in_flight_opens(6);
 521         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 522         do_test_sanity_on_in_flight_opens(7);
 523         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 524         do_test_sanity_on_in_flight_opens(8);
 525         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 526 }
 527
 528 #[test]
 529 fn test_update_fee_vanilla() {
 530         let chanmon_cfgs = create_chanmon_cfgs(2);
 531         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 532         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 533         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 534         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 535         let channel_id = chan.2;
 536
 537         let feerate = get_feerate!(nodes[0], channel_id);
 538         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 539         check_added_monitors!(nodes[0], 1);
 540
 541         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 542         assert_eq!(events_0.len(), 1);
 543         let (update_msg, commitment_signed) = match events_0[0] {
 544                         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 } } => {
 545                         (update_fee.as_ref(), commitment_signed)
 546                 },
 547                 _ => panic!("Unexpected event"),
 548         };
 549         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 550
 551         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 552         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 553         check_added_monitors!(nodes[1], 1);
 554
 555         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 556         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 557         check_added_monitors!(nodes[0], 1);
 558
 559         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 560         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 561         // No commitment_signed so get_event_msg's assert(len == 1) passes
 562         check_added_monitors!(nodes[0], 1);
 563
 564         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 565         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 566         check_added_monitors!(nodes[1], 1);
 567 }
 568
 569 #[test]
 570 fn test_update_fee_that_funder_cannot_afford() {
 571         let chanmon_cfgs = create_chanmon_cfgs(2);
 572         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 573         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 574         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 575         let channel_value = 1888;
 576         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 577         let channel_id = chan.2;
 578
 579         let feerate = 260;
 580         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 581         check_added_monitors!(nodes[0], 1);
 582         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 583
 584         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 585
 586         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 587
 588         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 589         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 590         {
 591                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 592
 593                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 594                 let num_htlcs = commitment_tx.output.len() - 2;
 595                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 596                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 597                 actual_fee = channel_value - actual_fee;
 598                 assert_eq!(total_fee, actual_fee);
 599         }
 600
 601         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 602         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 603         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 604         check_added_monitors!(nodes[0], 1);
 605
 606         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 607
 608         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 609
 610         //While producing the commitment_signed response after handling a received update_fee request the
 611         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 612         //Should produce and error.
 613         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 614         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 615         check_added_monitors!(nodes[1], 1);
 616         check_closed_broadcast!(nodes[1], true);
 617 }
 618
 619 #[test]
 620 fn test_update_fee_with_fundee_update_add_htlc() {
 621         let chanmon_cfgs = create_chanmon_cfgs(2);
 622         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 623         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 624         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 625         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 626         let channel_id = chan.2;
 627         let logger = test_utils::TestLogger::new();
 628
 629         // balancing
 630         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 631
 632         let feerate = get_feerate!(nodes[0], channel_id);
 633         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 634         check_added_monitors!(nodes[0], 1);
 635
 636         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 637         assert_eq!(events_0.len(), 1);
 638         let (update_msg, commitment_signed) = match events_0[0] {
 639                         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 } } => {
 640                         (update_fee.as_ref(), commitment_signed)
 641                 },
 642                 _ => panic!("Unexpected event"),
 643         };
 644         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 645         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 646         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 647         check_added_monitors!(nodes[1], 1);
 648
 649         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 650         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 651         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();
 652
 653         // nothing happens since node[1] is in AwaitingRemoteRevoke
 654         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 655         {
 656                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 657                 assert_eq!(added_monitors.len(), 0);
 658                 added_monitors.clear();
 659         }
 660         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 661         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 662         // node[1] has nothing to do
 663
 664         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 665         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 666         check_added_monitors!(nodes[0], 1);
 667
 668         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 669         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 670         // No commitment_signed so get_event_msg's assert(len == 1) passes
 671         check_added_monitors!(nodes[0], 1);
 672         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 673         check_added_monitors!(nodes[1], 1);
 674         // AwaitingRemoteRevoke ends here
 675
 676         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 677         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 678         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 679         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 681         assert_eq!(commitment_update.update_fee.is_none(), true);
 682
 683         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 684         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 685         check_added_monitors!(nodes[0], 1);
 686         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 687
 688         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 689         check_added_monitors!(nodes[1], 1);
 690         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 691
 692         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 693         check_added_monitors!(nodes[1], 1);
 694         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 695         // No commitment_signed so get_event_msg's assert(len == 1) passes
 696
 697         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 698         check_added_monitors!(nodes[0], 1);
 699         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 700
 701         expect_pending_htlcs_forwardable!(nodes[0]);
 702
 703         let events = nodes[0].node.get_and_clear_pending_events();
 704         assert_eq!(events.len(), 1);
 705         match events[0] {
 706                 Event::PaymentReceived { .. } => { },
 707                 _ => panic!("Unexpected event"),
 708         };
 709
 710         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 711
 712         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 713         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 714         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 715 }
 716
 717 #[test]
 718 fn test_update_fee() {
 719         let chanmon_cfgs = create_chanmon_cfgs(2);
 720         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 721         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 722         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 723         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 724         let channel_id = chan.2;
 725
 726         // A                                        B
 727         // (1) update_fee/commitment_signed      ->
 728         //                                       <- (2) revoke_and_ack
 729         //                                       .- send (3) commitment_signed
 730         // (4) update_fee/commitment_signed      ->
 731         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 732         //                                       <- (3) commitment_signed delivered
 733         // send (6) revoke_and_ack               -.
 734         //                                       <- (5) deliver revoke_and_ack
 735         // (6) deliver revoke_and_ack            ->
 736         //                                       .- send (7) commitment_signed in response to (4)
 737         //                                       <- (7) deliver commitment_signed
 738         // revoke_and_ack                        ->
 739
 740         // Create and deliver (1)...
 741         let feerate = get_feerate!(nodes[0], channel_id);
 742         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 743         check_added_monitors!(nodes[0], 1);
 744
 745         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 746         assert_eq!(events_0.len(), 1);
 747         let (update_msg, commitment_signed) = match events_0[0] {
 748                         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 } } => {
 749                         (update_fee.as_ref(), commitment_signed)
 750                 },
 751                 _ => panic!("Unexpected event"),
 752         };
 753         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 754
 755         // Generate (2) and (3):
 756         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 757         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 758         check_added_monitors!(nodes[1], 1);
 759
 760         // Deliver (2):
 761         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 762         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 763         check_added_monitors!(nodes[0], 1);
 764
 765         // Create and deliver (4)...
 766         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 767         check_added_monitors!(nodes[0], 1);
 768         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 769         assert_eq!(events_0.len(), 1);
 770         let (update_msg, commitment_signed) = match events_0[0] {
 771                         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 } } => {
 772                         (update_fee.as_ref(), commitment_signed)
 773                 },
 774                 _ => panic!("Unexpected event"),
 775         };
 776
 777         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 778         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 779         check_added_monitors!(nodes[1], 1);
 780         // ... creating (5)
 781         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 782         // No commitment_signed so get_event_msg's assert(len == 1) passes
 783
 784         // Handle (3), creating (6):
 785         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 786         check_added_monitors!(nodes[0], 1);
 787         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 788         // No commitment_signed so get_event_msg's assert(len == 1) passes
 789
 790         // Deliver (5):
 791         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 792         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 793         check_added_monitors!(nodes[0], 1);
 794
 795         // Deliver (6), creating (7):
 796         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 797         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 798         assert!(commitment_update.update_add_htlcs.is_empty());
 799         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 800         assert!(commitment_update.update_fail_htlcs.is_empty());
 801         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 802         assert!(commitment_update.update_fee.is_none());
 803         check_added_monitors!(nodes[1], 1);
 804
 805         // Deliver (7)
 806         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 807         check_added_monitors!(nodes[0], 1);
 808         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 809         // No commitment_signed so get_event_msg's assert(len == 1) passes
 810
 811         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 812         check_added_monitors!(nodes[1], 1);
 813         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 814
 815         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 816         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 817         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 818 }
 819
 820 #[test]
 821 fn pre_funding_lock_shutdown_test() {
 822         // Test sending a shutdown prior to funding_locked after funding generation
 823         let chanmon_cfgs = create_chanmon_cfgs(2);
 824         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 825         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 826         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 827         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 828         mine_transaction(&nodes[0], &tx);
 829         mine_transaction(&nodes[1], &tx);
 830
 831         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 832         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 833         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 834         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 835         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 836
 837         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 838         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 839         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 840         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 841         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 842         assert!(node_0_none.is_none());
 843
 844         assert!(nodes[0].node.list_channels().is_empty());
 845         assert!(nodes[1].node.list_channels().is_empty());
 846 }
 847
 848 #[test]
 849 fn updates_shutdown_wait() {
 850         // Test sending a shutdown with outstanding updates pending
 851         let chanmon_cfgs = create_chanmon_cfgs(3);
 852         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 854         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 855         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 856         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 857         let logger = test_utils::TestLogger::new();
 858
 859         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 860
 861         nodes[0].node.close_channel(&chan_1.2).unwrap();
 862         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 863         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 864         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 865         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 866
 867         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 868         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 869
 870         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 871
 872         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 873         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 874         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();
 875         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();
 876         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 877         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 878
 879         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 880         check_added_monitors!(nodes[2], 1);
 881         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 882         assert!(updates.update_add_htlcs.is_empty());
 883         assert!(updates.update_fail_htlcs.is_empty());
 884         assert!(updates.update_fail_malformed_htlcs.is_empty());
 885         assert!(updates.update_fee.is_none());
 886         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 887         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 888         check_added_monitors!(nodes[1], 1);
 889         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 890         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 891
 892         assert!(updates_2.update_add_htlcs.is_empty());
 893         assert!(updates_2.update_fail_htlcs.is_empty());
 894         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 895         assert!(updates_2.update_fee.is_none());
 896         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 897         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 898         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 899
 900         let events = nodes[0].node.get_and_clear_pending_events();
 901         assert_eq!(events.len(), 1);
 902         match events[0] {
 903                 Event::PaymentSent { ref payment_preimage } => {
 904                         assert_eq!(our_payment_preimage, *payment_preimage);
 905                 },
 906                 _ => panic!("Unexpected event"),
 907         }
 908
 909         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 910         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 911         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 912         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 913         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 914         assert!(node_0_none.is_none());
 915
 916         assert!(nodes[0].node.list_channels().is_empty());
 917
 918         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 919         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 920         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 921         assert!(nodes[1].node.list_channels().is_empty());
 922         assert!(nodes[2].node.list_channels().is_empty());
 923 }
 924
 925 #[test]
 926 fn htlc_fail_async_shutdown() {
 927         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 928         let chanmon_cfgs = create_chanmon_cfgs(3);
 929         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 930         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 931         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 932         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 933         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 934         let logger = test_utils::TestLogger::new();
 935
 936         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 937         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 938         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();
 939         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 940         check_added_monitors!(nodes[0], 1);
 941         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 942         assert_eq!(updates.update_add_htlcs.len(), 1);
 943         assert!(updates.update_fulfill_htlcs.is_empty());
 944         assert!(updates.update_fail_htlcs.is_empty());
 945         assert!(updates.update_fail_malformed_htlcs.is_empty());
 946         assert!(updates.update_fee.is_none());
 947
 948         nodes[1].node.close_channel(&chan_1.2).unwrap();
 949         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 950         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 951         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 952
 953         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 954         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 955         check_added_monitors!(nodes[1], 1);
 956         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 957         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 958
 959         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 960         assert!(updates_2.update_add_htlcs.is_empty());
 961         assert!(updates_2.update_fulfill_htlcs.is_empty());
 962         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 963         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 964         assert!(updates_2.update_fee.is_none());
 965
 966         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 967         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 968
 969         expect_payment_failed!(nodes[0], our_payment_hash, false);
 970
 971         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 972         assert_eq!(msg_events.len(), 2);
 973         let node_0_closing_signed = match msg_events[0] {
 974                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 975                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 976                         (*msg).clone()
 977                 },
 978                 _ => panic!("Unexpected event"),
 979         };
 980         match msg_events[1] {
 981                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 982                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 983                 },
 984                 _ => panic!("Unexpected event"),
 985         }
 986
 987         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 988         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 989         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 990         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 991         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 992         assert!(node_0_none.is_none());
 993
 994         assert!(nodes[0].node.list_channels().is_empty());
 995
 996         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 997         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 998         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 999         assert!(nodes[1].node.list_channels().is_empty());
1000         assert!(nodes[2].node.list_channels().is_empty());
1001 }
1002
1003 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1004         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1005         // messages delivered prior to disconnect
1006         let chanmon_cfgs = create_chanmon_cfgs(3);
1007         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1008         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1009         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1010         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1011         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1012
1013         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1014
1015         nodes[1].node.close_channel(&chan_1.2).unwrap();
1016         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1017         if recv_count > 0 {
1018                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1019                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1020                 if recv_count > 1 {
1021                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1022                 }
1023         }
1024
1025         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1026         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1027
1028         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1030         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1031         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1032
1033         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1034         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1035         assert!(node_1_shutdown == node_1_2nd_shutdown);
1036
1037         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1038         let node_0_2nd_shutdown = if recv_count > 0 {
1039                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1040                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1041                 node_0_2nd_shutdown
1042         } else {
1043                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1044                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1045                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1046         };
1047         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1048
1049         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1051
1052         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1053         check_added_monitors!(nodes[2], 1);
1054         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1055         assert!(updates.update_add_htlcs.is_empty());
1056         assert!(updates.update_fail_htlcs.is_empty());
1057         assert!(updates.update_fail_malformed_htlcs.is_empty());
1058         assert!(updates.update_fee.is_none());
1059         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1060         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1061         check_added_monitors!(nodes[1], 1);
1062         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1063         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1064
1065         assert!(updates_2.update_add_htlcs.is_empty());
1066         assert!(updates_2.update_fail_htlcs.is_empty());
1067         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1068         assert!(updates_2.update_fee.is_none());
1069         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1070         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1071         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1072
1073         let events = nodes[0].node.get_and_clear_pending_events();
1074         assert_eq!(events.len(), 1);
1075         match events[0] {
1076                 Event::PaymentSent { ref payment_preimage } => {
1077                         assert_eq!(our_payment_preimage, *payment_preimage);
1078                 },
1079                 _ => panic!("Unexpected event"),
1080         }
1081
1082         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1083         if recv_count > 0 {
1084                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1085                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1086                 assert!(node_1_closing_signed.is_some());
1087         }
1088
1089         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1090         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1091
1092         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1094         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095         if recv_count == 0 {
1096                 // If all closing_signeds weren't delivered we can just resume where we left off...
1097                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1098
1099                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1100                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1101                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1102
1103                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1104                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1105                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1106
1107                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1108                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1109
1110                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1111                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1112                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1113
1114                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1115                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1116                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1117                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1118                 assert!(node_0_none.is_none());
1119         } else {
1120                 // If one node, however, received + responded with an identical closing_signed we end
1121                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1122                 // There isn't really anything better we can do simply, but in the future we might
1123                 // explore storing a set of recently-closed channels that got disconnected during
1124                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1125                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1126                 // transaction.
1127                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1128
1129                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1130                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1131                 assert_eq!(msg_events.len(), 1);
1132                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1133                         match action {
1134                                 &ErrorAction::SendErrorMessage { ref msg } => {
1135                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1136                                         assert_eq!(msg.channel_id, chan_1.2);
1137                                 },
1138                                 _ => panic!("Unexpected event!"),
1139                         }
1140                 } else { panic!("Needed SendErrorMessage close"); }
1141
1142                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1143                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1144                 // closing_signed so we do it ourselves
1145                 check_closed_broadcast!(nodes[0], false);
1146                 check_added_monitors!(nodes[0], 1);
1147         }
1148
1149         assert!(nodes[0].node.list_channels().is_empty());
1150
1151         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1152         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1153         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1154         assert!(nodes[1].node.list_channels().is_empty());
1155         assert!(nodes[2].node.list_channels().is_empty());
1156 }
1157
1158 #[test]
1159 fn test_shutdown_rebroadcast() {
1160         do_test_shutdown_rebroadcast(0);
1161         do_test_shutdown_rebroadcast(1);
1162         do_test_shutdown_rebroadcast(2);
1163 }
1164
1165 #[test]
1166 fn fake_network_test() {
1167         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1168         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1169         let chanmon_cfgs = create_chanmon_cfgs(4);
1170         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1171         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1172         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1173
1174         // Create some initial channels
1175         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1176         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1177         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1178
1179         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1184
1185         // Send some more payments
1186         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1187         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1188         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1189
1190         // Test failure packets
1191         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1192         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1193
1194         // Add a new channel that skips 3
1195         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1196
1197         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1198         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1204
1205         // Do some rebalance loop payments, simultaneously
1206         let mut hops = Vec::with_capacity(3);
1207         hops.push(RouteHop {
1208                 pubkey: nodes[2].node.get_our_node_id(),
1209                 node_features: NodeFeatures::empty(),
1210                 short_channel_id: chan_2.0.contents.short_channel_id,
1211                 channel_features: ChannelFeatures::empty(),
1212                 fee_msat: 0,
1213                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1214         });
1215         hops.push(RouteHop {
1216                 pubkey: nodes[3].node.get_our_node_id(),
1217                 node_features: NodeFeatures::empty(),
1218                 short_channel_id: chan_3.0.contents.short_channel_id,
1219                 channel_features: ChannelFeatures::empty(),
1220                 fee_msat: 0,
1221                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1222         });
1223         hops.push(RouteHop {
1224                 pubkey: nodes[1].node.get_our_node_id(),
1225                 node_features: NodeFeatures::known(),
1226                 short_channel_id: chan_4.0.contents.short_channel_id,
1227                 channel_features: ChannelFeatures::known(),
1228                 fee_msat: 1000000,
1229                 cltv_expiry_delta: TEST_FINAL_CLTV,
1230         });
1231         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;
1232         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;
1233         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1234
1235         let mut hops = Vec::with_capacity(3);
1236         hops.push(RouteHop {
1237                 pubkey: nodes[3].node.get_our_node_id(),
1238                 node_features: NodeFeatures::empty(),
1239                 short_channel_id: chan_4.0.contents.short_channel_id,
1240                 channel_features: ChannelFeatures::empty(),
1241                 fee_msat: 0,
1242                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1243         });
1244         hops.push(RouteHop {
1245                 pubkey: nodes[2].node.get_our_node_id(),
1246                 node_features: NodeFeatures::empty(),
1247                 short_channel_id: chan_3.0.contents.short_channel_id,
1248                 channel_features: ChannelFeatures::empty(),
1249                 fee_msat: 0,
1250                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1251         });
1252         hops.push(RouteHop {
1253                 pubkey: nodes[1].node.get_our_node_id(),
1254                 node_features: NodeFeatures::known(),
1255                 short_channel_id: chan_2.0.contents.short_channel_id,
1256                 channel_features: ChannelFeatures::known(),
1257                 fee_msat: 1000000,
1258                 cltv_expiry_delta: TEST_FINAL_CLTV,
1259         });
1260         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;
1261         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;
1262         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1263
1264         // Claim the rebalances...
1265         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1266         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1267
1268         // Add a duplicate new channel from 2 to 4
1269         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1270
1271         // Send some payments across both channels
1272         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275
1276
1277         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1278         let events = nodes[0].node.get_and_clear_pending_msg_events();
1279         assert_eq!(events.len(), 0);
1280         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);
1281
1282         //TODO: Test that routes work again here as we've been notified that the channel is full
1283
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1285         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1287
1288         // Close down the channels...
1289         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1290         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1291         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1292         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1293         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1294 }
1295
1296 #[test]
1297 fn holding_cell_htlc_counting() {
1298         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1299         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1300         // commitment dance rounds.
1301         let chanmon_cfgs = create_chanmon_cfgs(3);
1302         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1303         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1304         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1305         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1306         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1307         let logger = test_utils::TestLogger::new();
1308
1309         let mut payments = Vec::new();
1310         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1311                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1312                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1313                 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();
1314                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1315                 payments.push((payment_preimage, payment_hash));
1316         }
1317         check_added_monitors!(nodes[1], 1);
1318
1319         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1320         assert_eq!(events.len(), 1);
1321         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1322         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1323
1324         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1325         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1326         // another HTLC.
1327         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1328         {
1329                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1330                 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();
1331                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1332                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1333                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1334                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1335         }
1336
1337         // This should also be true if we try to forward a payment.
1338         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1339         {
1340                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1341                 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();
1342                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1343                 check_added_monitors!(nodes[0], 1);
1344         }
1345
1346         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1347         assert_eq!(events.len(), 1);
1348         let payment_event = SendEvent::from_event(events.pop().unwrap());
1349         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1350
1351         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1352         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1353         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1354         // fails), the second will process the resulting failure and fail the HTLC backward.
1355         expect_pending_htlcs_forwardable!(nodes[1]);
1356         expect_pending_htlcs_forwardable!(nodes[1]);
1357         check_added_monitors!(nodes[1], 1);
1358
1359         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1360         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1361         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1362
1363         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1364         expect_payment_failed!(nodes[0], payment_hash_2, false);
1365
1366         // Now forward all the pending HTLCs and claim them back
1367         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1368         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1369         check_added_monitors!(nodes[2], 1);
1370
1371         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1372         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1373         check_added_monitors!(nodes[1], 1);
1374         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1375
1376         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1377         check_added_monitors!(nodes[1], 1);
1378         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1379
1380         for ref update in as_updates.update_add_htlcs.iter() {
1381                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1382         }
1383         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1384         check_added_monitors!(nodes[2], 1);
1385         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1386         check_added_monitors!(nodes[2], 1);
1387         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1388
1389         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1390         check_added_monitors!(nodes[1], 1);
1391         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1392         check_added_monitors!(nodes[1], 1);
1393         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1394
1395         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1396         check_added_monitors!(nodes[2], 1);
1397
1398         expect_pending_htlcs_forwardable!(nodes[2]);
1399
1400         let events = nodes[2].node.get_and_clear_pending_events();
1401         assert_eq!(events.len(), payments.len());
1402         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1403                 match event {
1404                         &Event::PaymentReceived { ref payment_hash, .. } => {
1405                                 assert_eq!(*payment_hash, *hash);
1406                         },
1407                         _ => panic!("Unexpected event"),
1408                 };
1409         }
1410
1411         for (preimage, _) in payments.drain(..) {
1412                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1413         }
1414
1415         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1416 }
1417
1418 #[test]
1419 fn duplicate_htlc_test() {
1420         // Test that we accept duplicate payment_hash HTLCs across the network and that
1421         // claiming/failing them are all separate and don't affect each other
1422         let chanmon_cfgs = create_chanmon_cfgs(6);
1423         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1424         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1425         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1426
1427         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1428         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1429         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1430         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1431         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1432         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1433
1434         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1435
1436         *nodes[0].network_payment_count.borrow_mut() -= 1;
1437         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1438
1439         *nodes[0].network_payment_count.borrow_mut() -= 1;
1440         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1441
1442         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1443         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1444         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1445 }
1446
1447 #[test]
1448 fn test_duplicate_htlc_different_direction_onchain() {
1449         // Test that ChannelMonitor doesn't generate 2 preimage txn
1450         // when we have 2 HTLCs with same preimage that go across a node
1451         // in opposite directions, even with the same payment secret.
1452         let chanmon_cfgs = create_chanmon_cfgs(2);
1453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1456
1457         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1458         let logger = test_utils::TestLogger::new();
1459
1460         // balancing
1461         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1462
1463         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1464
1465         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1466         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();
1467         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1468         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1469
1470         // Provide preimage to node 0 by claiming payment
1471         nodes[0].node.claim_funds(payment_preimage);
1472         check_added_monitors!(nodes[0], 1);
1473
1474         // Broadcast node 1 commitment txn
1475         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1476
1477         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1478         let mut has_both_htlcs = 0; // check htlcs match ones committed
1479         for outp in remote_txn[0].output.iter() {
1480                 if outp.value == 800_000 / 1000 {
1481                         has_both_htlcs += 1;
1482                 } else if outp.value == 900_000 / 1000 {
1483                         has_both_htlcs += 1;
1484                 }
1485         }
1486         assert_eq!(has_both_htlcs, 2);
1487
1488         mine_transaction(&nodes[0], &remote_txn[0]);
1489         check_added_monitors!(nodes[0], 1);
1490         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1491
1492         // Check we only broadcast 1 timeout tx
1493         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1494         assert_eq!(claim_txn.len(), 8);
1495         assert_eq!(claim_txn[1], claim_txn[4]);
1496         assert_eq!(claim_txn[2], claim_txn[5]);
1497         check_spends!(claim_txn[1], chan_1.3);
1498         check_spends!(claim_txn[2], claim_txn[1]);
1499         check_spends!(claim_txn[7], claim_txn[1]);
1500
1501         assert_eq!(claim_txn[0].input.len(), 1);
1502         assert_eq!(claim_txn[3].input.len(), 1);
1503         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1504
1505         assert_eq!(claim_txn[0].input.len(), 1);
1506         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1507         check_spends!(claim_txn[0], remote_txn[0]);
1508         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1509         assert_eq!(claim_txn[6].input.len(), 1);
1510         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1511         check_spends!(claim_txn[6], remote_txn[0]);
1512         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1513
1514         let events = nodes[0].node.get_and_clear_pending_msg_events();
1515         assert_eq!(events.len(), 3);
1516         for e in events {
1517                 match e {
1518                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1519                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1520                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1521                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1522                         },
1523                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1524                                 assert!(update_add_htlcs.is_empty());
1525                                 assert!(update_fail_htlcs.is_empty());
1526                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1527                                 assert!(update_fail_malformed_htlcs.is_empty());
1528                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1529                         },
1530                         _ => panic!("Unexpected event"),
1531                 }
1532         }
1533 }
1534
1535 #[test]
1536 fn test_basic_channel_reserve() {
1537         let chanmon_cfgs = create_chanmon_cfgs(2);
1538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1540         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1541         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1542         let logger = test_utils::TestLogger::new();
1543
1544         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1545         let channel_reserve = chan_stat.channel_reserve_msat;
1546
1547         // The 2* and +1 are for the fee spike reserve.
1548         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1549         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1550         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1551         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1553         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1554         match err {
1555                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1556                         match &fails[0] {
1557                                 &APIError::ChannelUnavailable{ref err} =>
1558                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1559                                 _ => panic!("Unexpected error variant"),
1560                         }
1561                 },
1562                 _ => panic!("Unexpected error variant"),
1563         }
1564         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1565         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1566
1567         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1568 }
1569
1570 #[test]
1571 fn test_fee_spike_violation_fails_htlc() {
1572         let chanmon_cfgs = create_chanmon_cfgs(2);
1573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1577
1578         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1579         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1580         let secp_ctx = Secp256k1::new();
1581         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1582
1583         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1584
1585         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1586         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1587         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1588         let msg = msgs::UpdateAddHTLC {
1589                 channel_id: chan.2,
1590                 htlc_id: 0,
1591                 amount_msat: htlc_msat,
1592                 payment_hash: payment_hash,
1593                 cltv_expiry: htlc_cltv,
1594                 onion_routing_packet: onion_packet,
1595         };
1596
1597         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1598
1599         // Now manually create the commitment_signed message corresponding to the update_add
1600         // nodes[0] just sent. In the code for construction of this message, "local" refers
1601         // to the sender of the message, and "remote" refers to the receiver.
1602
1603         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1604
1605         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1606
1607         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1608         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1609         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1610                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1611                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1612                 let chan_signer = local_chan.get_signer();
1613                 let pubkeys = chan_signer.pubkeys();
1614                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1615                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1616                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1617         };
1618         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1619                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1620                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1621                 let chan_signer = remote_chan.get_signer();
1622                 let pubkeys = chan_signer.pubkeys();
1623                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1624                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1625         };
1626
1627         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1628         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1629                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1630
1631         // Build the remote commitment transaction so we can sign it, and then later use the
1632         // signature for the commitment_signed message.
1633         let local_chan_balance = 1313;
1634
1635         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1636                 offered: false,
1637                 amount_msat: 3460001,
1638                 cltv_expiry: htlc_cltv,
1639                 payment_hash,
1640                 transaction_output_index: Some(1),
1641         };
1642
1643         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1644
1645         let res = {
1646                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1647                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1648                 let local_chan_signer = local_chan.get_signer();
1649                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1650                         commitment_number,
1651                         95000,
1652                         local_chan_balance,
1653                         commit_tx_keys.clone(),
1654                         feerate_per_kw,
1655                         &mut vec![(accepted_htlc_info, ())],
1656                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1657                 );
1658                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1659         };
1660
1661         let commit_signed_msg = msgs::CommitmentSigned {
1662                 channel_id: chan.2,
1663                 signature: res.0,
1664                 htlc_signatures: res.1
1665         };
1666
1667         // Send the commitment_signed message to the nodes[1].
1668         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1669         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1670
1671         // Send the RAA to nodes[1].
1672         let raa_msg = msgs::RevokeAndACK {
1673                 channel_id: chan.2,
1674                 per_commitment_secret: local_secret,
1675                 next_per_commitment_point: next_local_point
1676         };
1677         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1678
1679         let events = nodes[1].node.get_and_clear_pending_msg_events();
1680         assert_eq!(events.len(), 1);
1681         // Make sure the HTLC failed in the way we expect.
1682         match events[0] {
1683                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1684                         assert_eq!(update_fail_htlcs.len(), 1);
1685                         update_fail_htlcs[0].clone()
1686                 },
1687                 _ => panic!("Unexpected event"),
1688         };
1689         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1690                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1691
1692         check_added_monitors!(nodes[1], 2);
1693 }
1694
1695 #[test]
1696 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1697         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1698         // Set the fee rate for the channel very high, to the point where the fundee
1699         // sending any above-dust amount would result in a channel reserve violation.
1700         // In this test we check that we would be prevented from sending an HTLC in
1701         // this situation.
1702         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1703         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1704         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1706         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1707         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1708
1709         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1710         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1711                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1712         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1713         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);
1714 }
1715
1716 #[test]
1717 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1718         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1719         // Set the fee rate for the channel very high, to the point where the funder
1720         // receiving 1 update_add_htlc would result in them closing the channel due
1721         // to channel reserve violation. This close could also happen if the fee went
1722         // up a more realistic amount, but many HTLCs were outstanding at the time of
1723         // the update_add_htlc.
1724         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1725         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1726         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1727         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1728         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1729         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1730
1731         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1732         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1733         let secp_ctx = Secp256k1::new();
1734         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1735         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1736         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1737         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1738         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1739         let msg = msgs::UpdateAddHTLC {
1740                 channel_id: chan.2,
1741                 htlc_id: 1,
1742                 amount_msat: htlc_msat + 1,
1743                 payment_hash: payment_hash,
1744                 cltv_expiry: htlc_cltv,
1745                 onion_routing_packet: onion_packet,
1746         };
1747
1748         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1749         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1750         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);
1751         assert_eq!(nodes[0].node.list_channels().len(), 0);
1752         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1753         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1754         check_added_monitors!(nodes[0], 1);
1755 }
1756
1757 #[test]
1758 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1759         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1760         // calculating our commitment transaction fee (this was previously broken).
1761         let chanmon_cfgs = create_chanmon_cfgs(2);
1762         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1763         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1764         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1765
1766         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1767         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1768         // transaction fee with 0 HTLCs (183 sats)).
1769         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1770
1771         let dust_amt = 329000; // Dust amount
1772         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1773         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1774         // commitment transaction fee.
1775         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1776 }
1777
1778 #[test]
1779 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1780         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1781         // calculating our counterparty's commitment transaction fee (this was previously broken).
1782         let chanmon_cfgs = create_chanmon_cfgs(2);
1783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1786         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1787
1788         let payment_amt = 46000; // Dust amount
1789         // In the previous code, these first four payments would succeed.
1790         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1791         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794
1795         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1796         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1797         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1798         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1800         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1801
1802         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1803         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1804         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1805         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1806 }
1807
1808 #[test]
1809 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1810         let chanmon_cfgs = create_chanmon_cfgs(3);
1811         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1812         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1813         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1814         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1815         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1816
1817         let feemsat = 239;
1818         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1819         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1820         let feerate = get_feerate!(nodes[0], chan.2);
1821
1822         // Add a 2* and +1 for the fee spike reserve.
1823         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1824         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;
1825         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1826
1827         // Add a pending HTLC.
1828         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1829         let payment_event_1 = {
1830                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1831                 check_added_monitors!(nodes[0], 1);
1832
1833                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1834                 assert_eq!(events.len(), 1);
1835                 SendEvent::from_event(events.remove(0))
1836         };
1837         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1838
1839         // Attempt to trigger a channel reserve violation --> payment failure.
1840         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1841         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;
1842         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1843         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1844
1845         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1846         let secp_ctx = Secp256k1::new();
1847         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1848         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1849         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1850         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1851         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1852         let msg = msgs::UpdateAddHTLC {
1853                 channel_id: chan.2,
1854                 htlc_id: 1,
1855                 amount_msat: htlc_msat + 1,
1856                 payment_hash: our_payment_hash_1,
1857                 cltv_expiry: htlc_cltv,
1858                 onion_routing_packet: onion_packet,
1859         };
1860
1861         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1862         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1863         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1864         assert_eq!(nodes[1].node.list_channels().len(), 1);
1865         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1866         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1867         check_added_monitors!(nodes[1], 1);
1868 }
1869
1870 #[test]
1871 fn test_inbound_outbound_capacity_is_not_zero() {
1872         let chanmon_cfgs = create_chanmon_cfgs(2);
1873         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1874         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1875         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1876         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1877         let channels0 = node_chanmgrs[0].list_channels();
1878         let channels1 = node_chanmgrs[1].list_channels();
1879         assert_eq!(channels0.len(), 1);
1880         assert_eq!(channels1.len(), 1);
1881
1882         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1883         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1884
1885         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1886         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1887 }
1888
1889 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1890         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1891 }
1892
1893 #[test]
1894 fn test_channel_reserve_holding_cell_htlcs() {
1895         let chanmon_cfgs = create_chanmon_cfgs(3);
1896         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1897         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1898         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1899         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1900         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1901
1902         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1903         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1904
1905         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1906         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1907
1908         macro_rules! expect_forward {
1909                 ($node: expr) => {{
1910                         let mut events = $node.node.get_and_clear_pending_msg_events();
1911                         assert_eq!(events.len(), 1);
1912                         check_added_monitors!($node, 1);
1913                         let payment_event = SendEvent::from_event(events.remove(0));
1914                         payment_event
1915                 }}
1916         }
1917
1918         let feemsat = 239; // somehow we know?
1919         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1920         let feerate = get_feerate!(nodes[0], chan_1.2);
1921
1922         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1923
1924         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1925         {
1926                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1927                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1928                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1929                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1930                         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)));
1931                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1932                 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);
1933         }
1934
1935         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1936         // nodes[0]'s wealth
1937         loop {
1938                 let amt_msat = recv_value_0 + total_fee_msat;
1939                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1940                 // Also, ensure that each payment has enough to be over the dust limit to
1941                 // ensure it'll be included in each commit tx fee calculation.
1942                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1943                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1944                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1945                         break;
1946                 }
1947                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1948
1949                 let (stat01_, stat11_, stat12_, stat22_) = (
1950                         get_channel_value_stat!(nodes[0], chan_1.2),
1951                         get_channel_value_stat!(nodes[1], chan_1.2),
1952                         get_channel_value_stat!(nodes[1], chan_2.2),
1953                         get_channel_value_stat!(nodes[2], chan_2.2),
1954                 );
1955
1956                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1957                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1958                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1959                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1960                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1961         }
1962
1963         // adding pending output.
1964         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1965         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1966         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1967         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1968         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1969         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1970         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1971         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1972         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1973         // policy.
1974         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1975         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1976         let amt_msat_1 = recv_value_1 + total_fee_msat;
1977
1978         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);
1979         let payment_event_1 = {
1980                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1981                 check_added_monitors!(nodes[0], 1);
1982
1983                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1984                 assert_eq!(events.len(), 1);
1985                 SendEvent::from_event(events.remove(0))
1986         };
1987         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1988
1989         // channel reserve test with htlc pending output > 0
1990         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1991         {
1992                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1993                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1994                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1995                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1996         }
1997
1998         // split the rest to test holding cell
1999         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2000         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2001         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2002         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2003         {
2004                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2005                 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);
2006         }
2007
2008         // now see if they go through on both sides
2009         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);
2010         // but this will stuck in the holding cell
2011         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2012         check_added_monitors!(nodes[0], 0);
2013         let events = nodes[0].node.get_and_clear_pending_events();
2014         assert_eq!(events.len(), 0);
2015
2016         // test with outbound holding cell amount > 0
2017         {
2018                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2019                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2020                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2021                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2022                 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);
2023         }
2024
2025         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);
2026         // this will also stuck in the holding cell
2027         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2028         check_added_monitors!(nodes[0], 0);
2029         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2030         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2031
2032         // flush the pending htlc
2033         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2034         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2035         check_added_monitors!(nodes[1], 1);
2036
2037         // the pending htlc should be promoted to committed
2038         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2039         check_added_monitors!(nodes[0], 1);
2040         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2041
2042         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2043         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2044         // No commitment_signed so get_event_msg's assert(len == 1) passes
2045         check_added_monitors!(nodes[0], 1);
2046
2047         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2048         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2049         check_added_monitors!(nodes[1], 1);
2050
2051         expect_pending_htlcs_forwardable!(nodes[1]);
2052
2053         let ref payment_event_11 = expect_forward!(nodes[1]);
2054         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2055         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2056
2057         expect_pending_htlcs_forwardable!(nodes[2]);
2058         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2059
2060         // flush the htlcs in the holding cell
2061         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2062         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2063         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2064         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2065         expect_pending_htlcs_forwardable!(nodes[1]);
2066
2067         let ref payment_event_3 = expect_forward!(nodes[1]);
2068         assert_eq!(payment_event_3.msgs.len(), 2);
2069         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2070         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2071
2072         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2073         expect_pending_htlcs_forwardable!(nodes[2]);
2074
2075         let events = nodes[2].node.get_and_clear_pending_events();
2076         assert_eq!(events.len(), 2);
2077         match events[0] {
2078                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2079                         assert_eq!(our_payment_hash_21, *payment_hash);
2080                         assert!(payment_preimage.is_none());
2081                         assert_eq!(our_payment_secret_21, *payment_secret);
2082                         assert_eq!(recv_value_21, amt);
2083                 },
2084                 _ => panic!("Unexpected event"),
2085         }
2086         match events[1] {
2087                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2088                         assert_eq!(our_payment_hash_22, *payment_hash);
2089                         assert!(payment_preimage.is_none());
2090                         assert_eq!(our_payment_secret_22, *payment_secret);
2091                         assert_eq!(recv_value_22, amt);
2092                 },
2093                 _ => panic!("Unexpected event"),
2094         }
2095
2096         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2097         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2098         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2099
2100         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2101         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2102         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2103
2104         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2105         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);
2106         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2107         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2108         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2109
2110         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2111         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2112 }
2113
2114 #[test]
2115 fn channel_reserve_in_flight_removes() {
2116         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2117         // can send to its counterparty, but due to update ordering, the other side may not yet have
2118         // considered those HTLCs fully removed.
2119         // This tests that we don't count HTLCs which will not be included in the next remote
2120         // commitment transaction towards the reserve value (as it implies no commitment transaction
2121         // will be generated which violates the remote reserve value).
2122         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2123         // To test this we:
2124         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2125         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2126         //    you only consider the value of the first HTLC, it may not),
2127         //  * start routing a third HTLC from A to B,
2128         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2129         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2130         //  * deliver the first fulfill from B
2131         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2132         //    claim,
2133         //  * deliver A's response CS and RAA.
2134         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2135         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2136         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2137         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2138         let chanmon_cfgs = create_chanmon_cfgs(2);
2139         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2140         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2141         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2142         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2143         let logger = test_utils::TestLogger::new();
2144
2145         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2146         // Route the first two HTLCs.
2147         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2148         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2149
2150         // Start routing the third HTLC (this is just used to get everyone in the right state).
2151         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2152         let send_1 = {
2153                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2154                 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();
2155                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2156                 check_added_monitors!(nodes[0], 1);
2157                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2158                 assert_eq!(events.len(), 1);
2159                 SendEvent::from_event(events.remove(0))
2160         };
2161
2162         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2163         // initial fulfill/CS.
2164         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2165         check_added_monitors!(nodes[1], 1);
2166         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2167
2168         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2169         // remove the second HTLC when we send the HTLC back from B to A.
2170         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2171         check_added_monitors!(nodes[1], 1);
2172         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2173
2174         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2175         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2176         check_added_monitors!(nodes[0], 1);
2177         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2178         expect_payment_sent!(nodes[0], payment_preimage_1);
2179
2180         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2181         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2182         check_added_monitors!(nodes[1], 1);
2183         // B is already AwaitingRAA, so cant generate a CS here
2184         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2185
2186         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2187         check_added_monitors!(nodes[1], 1);
2188         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2189
2190         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2191         check_added_monitors!(nodes[0], 1);
2192         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2193
2194         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2195         check_added_monitors!(nodes[1], 1);
2196         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2197
2198         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2199         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2200         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2201         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2202         // on-chain as necessary).
2203         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2204         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2205         check_added_monitors!(nodes[0], 1);
2206         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2207         expect_payment_sent!(nodes[0], payment_preimage_2);
2208
2209         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2210         check_added_monitors!(nodes[1], 1);
2211         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2212
2213         expect_pending_htlcs_forwardable!(nodes[1]);
2214         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2215
2216         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2217         // resolve the second HTLC from A's point of view.
2218         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2219         check_added_monitors!(nodes[0], 1);
2220         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2221
2222         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2223         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2224         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2225         let send_2 = {
2226                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2227                 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();
2228                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2229                 check_added_monitors!(nodes[1], 1);
2230                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2231                 assert_eq!(events.len(), 1);
2232                 SendEvent::from_event(events.remove(0))
2233         };
2234
2235         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2236         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2237         check_added_monitors!(nodes[0], 1);
2238         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2239
2240         // Now just resolve all the outstanding messages/HTLCs for completeness...
2241
2242         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2243         check_added_monitors!(nodes[1], 1);
2244         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2245
2246         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2247         check_added_monitors!(nodes[1], 1);
2248
2249         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2250         check_added_monitors!(nodes[0], 1);
2251         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2252
2253         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2254         check_added_monitors!(nodes[1], 1);
2255         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2256
2257         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2258         check_added_monitors!(nodes[0], 1);
2259
2260         expect_pending_htlcs_forwardable!(nodes[0]);
2261         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2262
2263         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2264         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2265 }
2266
2267 #[test]
2268 fn channel_monitor_network_test() {
2269         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2270         // tests that ChannelMonitor is able to recover from various states.
2271         let chanmon_cfgs = create_chanmon_cfgs(5);
2272         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2273         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2274         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2275
2276         // Create some initial channels
2277         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2278         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2279         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2280         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2281
2282         // Make sure all nodes are at the same starting height
2283         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2284         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2285         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2286         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2287         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2288
2289         // Rebalance the network a bit by relaying one payment through all the channels...
2290         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2291         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2292         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2293         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2294
2295         // Simple case with no pending HTLCs:
2296         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2297         check_added_monitors!(nodes[1], 1);
2298         check_closed_broadcast!(nodes[1], false);
2299         {
2300                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2301                 assert_eq!(node_txn.len(), 1);
2302                 mine_transaction(&nodes[0], &node_txn[0]);
2303                 check_added_monitors!(nodes[0], 1);
2304                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2305         }
2306         check_closed_broadcast!(nodes[0], true);
2307         assert_eq!(nodes[0].node.list_channels().len(), 0);
2308         assert_eq!(nodes[1].node.list_channels().len(), 1);
2309
2310         // One pending HTLC is discarded by the force-close:
2311         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2312
2313         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2314         // broadcasted until we reach the timelock time).
2315         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2316         check_closed_broadcast!(nodes[1], false);
2317         check_added_monitors!(nodes[1], 1);
2318         {
2319                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2320                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2321                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2322                 mine_transaction(&nodes[2], &node_txn[0]);
2323                 check_added_monitors!(nodes[2], 1);
2324                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2325         }
2326         check_closed_broadcast!(nodes[2], true);
2327         assert_eq!(nodes[1].node.list_channels().len(), 0);
2328         assert_eq!(nodes[2].node.list_channels().len(), 1);
2329
2330         macro_rules! claim_funds {
2331                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2332                         {
2333                                 assert!($node.node.claim_funds($preimage));
2334                                 check_added_monitors!($node, 1);
2335
2336                                 let events = $node.node.get_and_clear_pending_msg_events();
2337                                 assert_eq!(events.len(), 1);
2338                                 match events[0] {
2339                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2340                                                 assert!(update_add_htlcs.is_empty());
2341                                                 assert!(update_fail_htlcs.is_empty());
2342                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2343                                         },
2344                                         _ => panic!("Unexpected event"),
2345                                 };
2346                         }
2347                 }
2348         }
2349
2350         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2351         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2352         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2353         check_added_monitors!(nodes[2], 1);
2354         check_closed_broadcast!(nodes[2], false);
2355         let node2_commitment_txid;
2356         {
2357                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2358                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2359                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2360                 node2_commitment_txid = node_txn[0].txid();
2361
2362                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2363                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2364                 mine_transaction(&nodes[3], &node_txn[0]);
2365                 check_added_monitors!(nodes[3], 1);
2366                 check_preimage_claim(&nodes[3], &node_txn);
2367         }
2368         check_closed_broadcast!(nodes[3], true);
2369         assert_eq!(nodes[2].node.list_channels().len(), 0);
2370         assert_eq!(nodes[3].node.list_channels().len(), 1);
2371
2372         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2373         // confusing us in the following tests.
2374         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2375
2376         // One pending HTLC to time out:
2377         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2378         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2379         // buffer space).
2380
2381         let (close_chan_update_1, close_chan_update_2) = {
2382                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2383                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2384                 assert_eq!(events.len(), 2);
2385                 let close_chan_update_1 = match events[0] {
2386                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2387                                 msg.clone()
2388                         },
2389                         _ => panic!("Unexpected event"),
2390                 };
2391                 match events[1] {
2392                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2393                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2394                         },
2395                         _ => panic!("Unexpected event"),
2396                 }
2397                 check_added_monitors!(nodes[3], 1);
2398
2399                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2400                 {
2401                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2402                         node_txn.retain(|tx| {
2403                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2404                                         false
2405                                 } else { true }
2406                         });
2407                 }
2408
2409                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2410
2411                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2412                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2413
2414                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2415                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2416                 assert_eq!(events.len(), 2);
2417                 let close_chan_update_2 = match events[0] {
2418                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2419                                 msg.clone()
2420                         },
2421                         _ => panic!("Unexpected event"),
2422                 };
2423                 match events[1] {
2424                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2425                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2426                         },
2427                         _ => panic!("Unexpected event"),
2428                 }
2429                 check_added_monitors!(nodes[4], 1);
2430                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2431
2432                 mine_transaction(&nodes[4], &node_txn[0]);
2433                 check_preimage_claim(&nodes[4], &node_txn);
2434                 (close_chan_update_1, close_chan_update_2)
2435         };
2436         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2437         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2438         assert_eq!(nodes[3].node.list_channels().len(), 0);
2439         assert_eq!(nodes[4].node.list_channels().len(), 0);
2440
2441         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2442 }
2443
2444 #[test]
2445 fn test_justice_tx() {
2446         // Test justice txn built on revoked HTLC-Success tx, against both sides
2447         let mut alice_config = UserConfig::default();
2448         alice_config.channel_options.announced_channel = true;
2449         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2450         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2451         let mut bob_config = UserConfig::default();
2452         bob_config.channel_options.announced_channel = true;
2453         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2454         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2455         let user_cfgs = [Some(alice_config), Some(bob_config)];
2456         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2457         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2458         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2461         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2462         // Create some new channels:
2463         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2464
2465         // A pending HTLC which will be revoked:
2466         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2467         // Get the will-be-revoked local txn from nodes[0]
2468         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2469         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2470         assert_eq!(revoked_local_txn[0].input.len(), 1);
2471         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2472         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2473         assert_eq!(revoked_local_txn[1].input.len(), 1);
2474         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2475         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2476         // Revoke the old state
2477         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2478
2479         {
2480                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2481                 {
2482                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2483                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2484                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2485
2486                         check_spends!(node_txn[0], revoked_local_txn[0]);
2487                         node_txn.swap_remove(0);
2488                         node_txn.truncate(1);
2489                 }
2490                 check_added_monitors!(nodes[1], 1);
2491                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2492
2493                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2494                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2495                 // Verify broadcast of revoked HTLC-timeout
2496                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2497                 check_added_monitors!(nodes[0], 1);
2498                 // Broadcast revoked HTLC-timeout on node 1
2499                 mine_transaction(&nodes[1], &node_txn[1]);
2500                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2501         }
2502         get_announce_close_broadcast_events(&nodes, 0, 1);
2503
2504         assert_eq!(nodes[0].node.list_channels().len(), 0);
2505         assert_eq!(nodes[1].node.list_channels().len(), 0);
2506
2507         // We test justice_tx build by A on B's revoked HTLC-Success tx
2508         // Create some new channels:
2509         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2510         {
2511                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2512                 node_txn.clear();
2513         }
2514
2515         // A pending HTLC which will be revoked:
2516         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2517         // Get the will-be-revoked local txn from B
2518         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2519         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2520         assert_eq!(revoked_local_txn[0].input.len(), 1);
2521         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2522         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2523         // Revoke the old state
2524         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2525         {
2526                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2527                 {
2528                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2529                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2530                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2531
2532                         check_spends!(node_txn[0], revoked_local_txn[0]);
2533                         node_txn.swap_remove(0);
2534                 }
2535                 check_added_monitors!(nodes[0], 1);
2536                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2537
2538                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2539                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2540                 check_added_monitors!(nodes[1], 1);
2541                 mine_transaction(&nodes[0], &node_txn[1]);
2542                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2543         }
2544         get_announce_close_broadcast_events(&nodes, 0, 1);
2545         assert_eq!(nodes[0].node.list_channels().len(), 0);
2546         assert_eq!(nodes[1].node.list_channels().len(), 0);
2547 }
2548
2549 #[test]
2550 fn revoked_output_claim() {
2551         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2552         // transaction is broadcast by its counterparty
2553         let chanmon_cfgs = create_chanmon_cfgs(2);
2554         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2555         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2556         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2557         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2558         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2559         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2560         assert_eq!(revoked_local_txn.len(), 1);
2561         // Only output is the full channel value back to nodes[0]:
2562         assert_eq!(revoked_local_txn[0].output.len(), 1);
2563         // Send a payment through, updating everyone's latest commitment txn
2564         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2565
2566         // Inform nodes[1] that nodes[0] broadcast a stale tx
2567         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2568         check_added_monitors!(nodes[1], 1);
2569         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2570         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2571
2572         check_spends!(node_txn[0], revoked_local_txn[0]);
2573         check_spends!(node_txn[1], chan_1.3);
2574
2575         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2576         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2577         get_announce_close_broadcast_events(&nodes, 0, 1);
2578         check_added_monitors!(nodes[0], 1)
2579 }
2580
2581 #[test]
2582 fn claim_htlc_outputs_shared_tx() {
2583         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2584         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2585         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2586         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2587         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2588         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2589
2590         // Create some new channel:
2591         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2592
2593         // Rebalance the network to generate htlc in the two directions
2594         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2595         // 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
2596         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2597         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2598
2599         // Get the will-be-revoked local txn from node[0]
2600         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2601         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2602         assert_eq!(revoked_local_txn[0].input.len(), 1);
2603         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2604         assert_eq!(revoked_local_txn[1].input.len(), 1);
2605         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2606         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2607         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2608
2609         //Revoke the old state
2610         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2611
2612         {
2613                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2614                 check_added_monitors!(nodes[0], 1);
2615                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2616                 check_added_monitors!(nodes[1], 1);
2617                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2618                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2619
2620                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2621                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2622
2623                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2624                 check_spends!(node_txn[0], revoked_local_txn[0]);
2625
2626                 let mut witness_lens = BTreeSet::new();
2627                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2628                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2629                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2630                 assert_eq!(witness_lens.len(), 3);
2631                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2632                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2633                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2634
2635                 // Next nodes[1] broadcasts its current local tx state:
2636                 assert_eq!(node_txn[1].input.len(), 1);
2637                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2638         }
2639         get_announce_close_broadcast_events(&nodes, 0, 1);
2640         assert_eq!(nodes[0].node.list_channels().len(), 0);
2641         assert_eq!(nodes[1].node.list_channels().len(), 0);
2642 }
2643
2644 #[test]
2645 fn claim_htlc_outputs_single_tx() {
2646         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2647         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2648         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2649         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2651         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2652
2653         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2654
2655         // Rebalance the network to generate htlc in the two directions
2656         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2657         // 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
2658         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2659         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2660         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2661
2662         // Get the will-be-revoked local txn from node[0]
2663         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2664
2665         //Revoke the old state
2666         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2667
2668         {
2669                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2670                 check_added_monitors!(nodes[0], 1);
2671                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2672                 check_added_monitors!(nodes[1], 1);
2673                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2674
2675                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2676                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2677
2678                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2679                 assert_eq!(node_txn.len(), 9);
2680                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2681                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2682                 // 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)
2683                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2684
2685                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2686                 assert_eq!(node_txn[0].input.len(), 1);
2687                 check_spends!(node_txn[0], chan_1.3);
2688                 assert_eq!(node_txn[1].input.len(), 1);
2689                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2690                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2691                 check_spends!(node_txn[1], node_txn[0]);
2692
2693                 // Justice transactions are indices 1-2-4
2694                 assert_eq!(node_txn[2].input.len(), 1);
2695                 assert_eq!(node_txn[3].input.len(), 1);
2696                 assert_eq!(node_txn[4].input.len(), 1);
2697
2698                 check_spends!(node_txn[2], revoked_local_txn[0]);
2699                 check_spends!(node_txn[3], revoked_local_txn[0]);
2700                 check_spends!(node_txn[4], revoked_local_txn[0]);
2701
2702                 let mut witness_lens = BTreeSet::new();
2703                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2704                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2705                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2706                 assert_eq!(witness_lens.len(), 3);
2707                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2708                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2709                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2710         }
2711         get_announce_close_broadcast_events(&nodes, 0, 1);
2712         assert_eq!(nodes[0].node.list_channels().len(), 0);
2713         assert_eq!(nodes[1].node.list_channels().len(), 0);
2714 }
2715
2716 #[test]
2717 fn test_htlc_on_chain_success() {
2718         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2719         // the preimage backward accordingly. So here we test that ChannelManager is
2720         // broadcasting the right event to other nodes in payment path.
2721         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2722         // A --------------------> B ----------------------> C (preimage)
2723         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2724         // commitment transaction was broadcast.
2725         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2726         // towards B.
2727         // B should be able to claim via preimage if A then broadcasts its local tx.
2728         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2729         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2730         // PaymentSent event).
2731
2732         let chanmon_cfgs = create_chanmon_cfgs(3);
2733         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2734         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2735         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2736
2737         // Create some initial channels
2738         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2739         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2740
2741         // Ensure all nodes are at the same height
2742         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2743         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2744         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2745         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2746
2747         // Rebalance the network a bit by relaying one payment through all the channels...
2748         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2749         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2750
2751         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2752         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2753
2754         // Broadcast legit commitment tx from C on B's chain
2755         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2756         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2757         assert_eq!(commitment_tx.len(), 1);
2758         check_spends!(commitment_tx[0], chan_2.3);
2759         nodes[2].node.claim_funds(our_payment_preimage);
2760         nodes[2].node.claim_funds(our_payment_preimage_2);
2761         check_added_monitors!(nodes[2], 2);
2762         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2763         assert!(updates.update_add_htlcs.is_empty());
2764         assert!(updates.update_fail_htlcs.is_empty());
2765         assert!(updates.update_fail_malformed_htlcs.is_empty());
2766         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2767
2768         mine_transaction(&nodes[2], &commitment_tx[0]);
2769         check_closed_broadcast!(nodes[2], true);
2770         check_added_monitors!(nodes[2], 1);
2771         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)
2772         assert_eq!(node_txn.len(), 5);
2773         assert_eq!(node_txn[0], node_txn[3]);
2774         assert_eq!(node_txn[1], node_txn[4]);
2775         assert_eq!(node_txn[2], commitment_tx[0]);
2776         check_spends!(node_txn[0], commitment_tx[0]);
2777         check_spends!(node_txn[1], commitment_tx[0]);
2778         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2779         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2780         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2781         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2782         assert_eq!(node_txn[0].lock_time, 0);
2783         assert_eq!(node_txn[1].lock_time, 0);
2784
2785         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2786         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2787         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2788         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2789         {
2790                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2791                 assert_eq!(added_monitors.len(), 1);
2792                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2793                 added_monitors.clear();
2794         }
2795         let events = nodes[1].node.get_and_clear_pending_msg_events();
2796         {
2797                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2798                 assert_eq!(added_monitors.len(), 2);
2799                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2800                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2801                 added_monitors.clear();
2802         }
2803         assert_eq!(events.len(), 3);
2804         match events[0] {
2805                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2806                 _ => panic!("Unexpected event"),
2807         }
2808         match events[1] {
2809                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2810                 _ => panic!("Unexpected event"),
2811         }
2812
2813         match events[2] {
2814                 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, .. } } => {
2815                         assert!(update_add_htlcs.is_empty());
2816                         assert!(update_fail_htlcs.is_empty());
2817                         assert_eq!(update_fulfill_htlcs.len(), 1);
2818                         assert!(update_fail_malformed_htlcs.is_empty());
2819                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2820                 },
2821                 _ => panic!("Unexpected event"),
2822         };
2823         macro_rules! check_tx_local_broadcast {
2824                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2825                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2826                         assert_eq!(node_txn.len(), 3);
2827                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2828                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2829                         check_spends!(node_txn[1], $commitment_tx);
2830                         check_spends!(node_txn[2], $commitment_tx);
2831                         assert_ne!(node_txn[1].lock_time, 0);
2832                         assert_ne!(node_txn[2].lock_time, 0);
2833                         if $htlc_offered {
2834                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2836                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2837                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2838                         } else {
2839                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2840                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2841                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2842                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2843                         }
2844                         check_spends!(node_txn[0], $chan_tx);
2845                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2846                         node_txn.clear();
2847                 } }
2848         }
2849         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2850         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2851         // timeout-claim of the output that nodes[2] just claimed via success.
2852         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2853
2854         // Broadcast legit commitment tx from A on B's chain
2855         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2856         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2857         check_spends!(node_a_commitment_tx[0], chan_1.3);
2858         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2859         check_closed_broadcast!(nodes[1], true);
2860         check_added_monitors!(nodes[1], 1);
2861         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2862         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2863         let commitment_spend =
2864                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2865                         check_spends!(node_txn[1], commitment_tx[0]);
2866                         check_spends!(node_txn[2], commitment_tx[0]);
2867                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2868                         &node_txn[0]
2869                 } else {
2870                         check_spends!(node_txn[0], commitment_tx[0]);
2871                         check_spends!(node_txn[1], commitment_tx[0]);
2872                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2873                         &node_txn[2]
2874                 };
2875
2876         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2877         assert_eq!(commitment_spend.input.len(), 2);
2878         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2879         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2880         assert_eq!(commitment_spend.lock_time, 0);
2881         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2882         check_spends!(node_txn[3], chan_1.3);
2883         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2884         check_spends!(node_txn[4], node_txn[3]);
2885         check_spends!(node_txn[5], node_txn[3]);
2886         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2887         // we already checked the same situation with A.
2888
2889         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2890         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2891         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2892         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2893         check_closed_broadcast!(nodes[0], true);
2894         check_added_monitors!(nodes[0], 1);
2895         let events = nodes[0].node.get_and_clear_pending_events();
2896         assert_eq!(events.len(), 2);
2897         let mut first_claimed = false;
2898         for event in events {
2899                 match event {
2900                         Event::PaymentSent { payment_preimage } => {
2901                                 if payment_preimage == our_payment_preimage {
2902                                         assert!(!first_claimed);
2903                                         first_claimed = true;
2904                                 } else {
2905                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2906                                 }
2907                         },
2908                         _ => panic!("Unexpected event"),
2909                 }
2910         }
2911         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2912 }
2913
2914 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2915         // Test that in case of a unilateral close onchain, we detect the state of output and
2916         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2917         // broadcasting the right event to other nodes in payment path.
2918         // A ------------------> B ----------------------> C (timeout)
2919         //    B's commitment tx                 C's commitment tx
2920         //            \                                  \
2921         //         B's HTLC timeout tx               B's timeout tx
2922
2923         let chanmon_cfgs = create_chanmon_cfgs(3);
2924         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2925         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2926         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2927         *nodes[0].connect_style.borrow_mut() = connect_style;
2928         *nodes[1].connect_style.borrow_mut() = connect_style;
2929         *nodes[2].connect_style.borrow_mut() = connect_style;
2930
2931         // Create some intial channels
2932         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2933         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2934
2935         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2936         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2937         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2938
2939         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2940
2941         // Broadcast legit commitment tx from C on B's chain
2942         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2943         check_spends!(commitment_tx[0], chan_2.3);
2944         nodes[2].node.fail_htlc_backwards(&payment_hash);
2945         check_added_monitors!(nodes[2], 0);
2946         expect_pending_htlcs_forwardable!(nodes[2]);
2947         check_added_monitors!(nodes[2], 1);
2948
2949         let events = nodes[2].node.get_and_clear_pending_msg_events();
2950         assert_eq!(events.len(), 1);
2951         match events[0] {
2952                 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, .. } } => {
2953                         assert!(update_add_htlcs.is_empty());
2954                         assert!(!update_fail_htlcs.is_empty());
2955                         assert!(update_fulfill_htlcs.is_empty());
2956                         assert!(update_fail_malformed_htlcs.is_empty());
2957                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2958                 },
2959                 _ => panic!("Unexpected event"),
2960         };
2961         mine_transaction(&nodes[2], &commitment_tx[0]);
2962         check_closed_broadcast!(nodes[2], true);
2963         check_added_monitors!(nodes[2], 1);
2964         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2965         assert_eq!(node_txn.len(), 1);
2966         check_spends!(node_txn[0], chan_2.3);
2967         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2968
2969         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2970         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2971         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2972         mine_transaction(&nodes[1], &commitment_tx[0]);
2973         let timeout_tx;
2974         {
2975                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2976                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2977                 assert_eq!(node_txn[0], node_txn[3]);
2978                 assert_eq!(node_txn[1], node_txn[4]);
2979
2980                 check_spends!(node_txn[2], commitment_tx[0]);
2981                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2982
2983                 check_spends!(node_txn[0], chan_2.3);
2984                 check_spends!(node_txn[1], node_txn[0]);
2985                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2986                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2987
2988                 timeout_tx = node_txn[2].clone();
2989                 node_txn.clear();
2990         }
2991
2992         mine_transaction(&nodes[1], &timeout_tx);
2993         check_added_monitors!(nodes[1], 1);
2994         check_closed_broadcast!(nodes[1], true);
2995         {
2996                 // B will rebroadcast a fee-bumped timeout transaction here.
2997                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2998                 assert_eq!(node_txn.len(), 1);
2999                 check_spends!(node_txn[0], commitment_tx[0]);
3000         }
3001
3002         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3003         {
3004                 // B will rebroadcast its own holder commitment transaction here...just because
3005                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3006                 assert_eq!(node_txn.len(), 1);
3007                 check_spends!(node_txn[0], chan_2.3);
3008         }
3009
3010         expect_pending_htlcs_forwardable!(nodes[1]);
3011         check_added_monitors!(nodes[1], 1);
3012         let events = nodes[1].node.get_and_clear_pending_msg_events();
3013         assert_eq!(events.len(), 1);
3014         match events[0] {
3015                 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, .. } } => {
3016                         assert!(update_add_htlcs.is_empty());
3017                         assert!(!update_fail_htlcs.is_empty());
3018                         assert!(update_fulfill_htlcs.is_empty());
3019                         assert!(update_fail_malformed_htlcs.is_empty());
3020                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3021                 },
3022                 _ => panic!("Unexpected event"),
3023         };
3024
3025         // Broadcast legit commitment tx from B on A's chain
3026         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3027         check_spends!(commitment_tx[0], chan_1.3);
3028
3029         mine_transaction(&nodes[0], &commitment_tx[0]);
3030         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3031
3032         check_closed_broadcast!(nodes[0], true);
3033         check_added_monitors!(nodes[0], 1);
3034         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3035         assert_eq!(node_txn.len(), 2);
3036         check_spends!(node_txn[0], chan_1.3);
3037         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3038         check_spends!(node_txn[1], commitment_tx[0]);
3039         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3040 }
3041
3042 #[test]
3043 fn test_htlc_on_chain_timeout() {
3044         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3045         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3046         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3047 }
3048
3049 #[test]
3050 fn test_simple_commitment_revoked_fail_backward() {
3051         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3052         // and fail backward accordingly.
3053
3054         let chanmon_cfgs = create_chanmon_cfgs(3);
3055         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3056         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3057         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3058
3059         // Create some initial channels
3060         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3061         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3062
3063         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3064         // Get the will-be-revoked local txn from nodes[2]
3065         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3066         // Revoke the old state
3067         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3068
3069         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3070
3071         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3072         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3073         check_added_monitors!(nodes[1], 1);
3074         check_closed_broadcast!(nodes[1], true);
3075
3076         expect_pending_htlcs_forwardable!(nodes[1]);
3077         check_added_monitors!(nodes[1], 1);
3078         let events = nodes[1].node.get_and_clear_pending_msg_events();
3079         assert_eq!(events.len(), 1);
3080         match events[0] {
3081                 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, .. } } => {
3082                         assert!(update_add_htlcs.is_empty());
3083                         assert_eq!(update_fail_htlcs.len(), 1);
3084                         assert!(update_fulfill_htlcs.is_empty());
3085                         assert!(update_fail_malformed_htlcs.is_empty());
3086                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3087
3088                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3089                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3090                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3091                         expect_payment_failed!(nodes[0], payment_hash, false);
3092                 },
3093                 _ => panic!("Unexpected event"),
3094         }
3095 }
3096
3097 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3098         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3099         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3100         // commitment transaction anymore.
3101         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3102         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3103         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3104         // technically disallowed and we should probably handle it reasonably.
3105         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3106         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3107         // transactions:
3108         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3109         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3110         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3111         //   and once they revoke the previous commitment transaction (allowing us to send a new
3112         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3113         let chanmon_cfgs = create_chanmon_cfgs(3);
3114         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3115         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3116         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3117
3118         // Create some initial channels
3119         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3120         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3121
3122         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 });
3123         // Get the will-be-revoked local txn from nodes[2]
3124         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3125         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3126         // Revoke the old state
3127         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3128
3129         let value = if use_dust {
3130                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3131                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3132                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3133         } else { 3000000 };
3134
3135         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3136         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3137         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3138
3139         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3140         expect_pending_htlcs_forwardable!(nodes[2]);
3141         check_added_monitors!(nodes[2], 1);
3142         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3143         assert!(updates.update_add_htlcs.is_empty());
3144         assert!(updates.update_fulfill_htlcs.is_empty());
3145         assert!(updates.update_fail_malformed_htlcs.is_empty());
3146         assert_eq!(updates.update_fail_htlcs.len(), 1);
3147         assert!(updates.update_fee.is_none());
3148         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3149         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3150         // Drop the last RAA from 3 -> 2
3151
3152         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3153         expect_pending_htlcs_forwardable!(nodes[2]);
3154         check_added_monitors!(nodes[2], 1);
3155         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3156         assert!(updates.update_add_htlcs.is_empty());
3157         assert!(updates.update_fulfill_htlcs.is_empty());
3158         assert!(updates.update_fail_malformed_htlcs.is_empty());
3159         assert_eq!(updates.update_fail_htlcs.len(), 1);
3160         assert!(updates.update_fee.is_none());
3161         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3162         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3163         check_added_monitors!(nodes[1], 1);
3164         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3165         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3166         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3167         check_added_monitors!(nodes[2], 1);
3168
3169         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3170         expect_pending_htlcs_forwardable!(nodes[2]);
3171         check_added_monitors!(nodes[2], 1);
3172         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3173         assert!(updates.update_add_htlcs.is_empty());
3174         assert!(updates.update_fulfill_htlcs.is_empty());
3175         assert!(updates.update_fail_malformed_htlcs.is_empty());
3176         assert_eq!(updates.update_fail_htlcs.len(), 1);
3177         assert!(updates.update_fee.is_none());
3178         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3179         // At this point first_payment_hash has dropped out of the latest two commitment
3180         // transactions that nodes[1] is tracking...
3181         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3182         check_added_monitors!(nodes[1], 1);
3183         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3184         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3185         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3186         check_added_monitors!(nodes[2], 1);
3187
3188         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3189         // on nodes[2]'s RAA.
3190         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3191         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3192         let logger = test_utils::TestLogger::new();
3193         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();
3194         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3195         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3196         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3197         check_added_monitors!(nodes[1], 0);
3198
3199         if deliver_bs_raa {
3200                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3201                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3202                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3203                 check_added_monitors!(nodes[1], 1);
3204                 let events = nodes[1].node.get_and_clear_pending_events();
3205                 assert_eq!(events.len(), 1);
3206                 match events[0] {
3207                         Event::PendingHTLCsForwardable { .. } => { },
3208                         _ => panic!("Unexpected event"),
3209                 };
3210                 // Deliberately don't process the pending fail-back so they all fail back at once after
3211                 // block connection just like the !deliver_bs_raa case
3212         }
3213
3214         let mut failed_htlcs = HashSet::new();
3215         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3216
3217         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3218         check_added_monitors!(nodes[1], 1);
3219         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3220
3221         let events = nodes[1].node.get_and_clear_pending_events();
3222         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3223         match events[0] {
3224                 Event::PaymentFailed { ref payment_hash, .. } => {
3225                         assert_eq!(*payment_hash, fourth_payment_hash);
3226                 },
3227                 _ => panic!("Unexpected event"),
3228         }
3229         if !deliver_bs_raa {
3230                 match events[1] {
3231                         Event::PendingHTLCsForwardable { .. } => { },
3232                         _ => panic!("Unexpected event"),
3233                 };
3234         }
3235         nodes[1].node.process_pending_htlc_forwards();
3236         check_added_monitors!(nodes[1], 1);
3237
3238         let events = nodes[1].node.get_and_clear_pending_msg_events();
3239         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3240         match events[if deliver_bs_raa { 1 } else { 0 }] {
3241                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3242                 _ => panic!("Unexpected event"),
3243         }
3244         match events[if deliver_bs_raa { 2 } else { 1 }] {
3245                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3246                         assert_eq!(channel_id, chan_2.2);
3247                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3248                 },
3249                 _ => panic!("Unexpected event"),
3250         }
3251         if deliver_bs_raa {
3252                 match events[0] {
3253                         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, .. } } => {
3254                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3255                                 assert_eq!(update_add_htlcs.len(), 1);
3256                                 assert!(update_fulfill_htlcs.is_empty());
3257                                 assert!(update_fail_htlcs.is_empty());
3258                                 assert!(update_fail_malformed_htlcs.is_empty());
3259                         },
3260                         _ => panic!("Unexpected event"),
3261                 }
3262         }
3263         match events[if deliver_bs_raa { 3 } else { 2 }] {
3264                 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, .. } } => {
3265                         assert!(update_add_htlcs.is_empty());
3266                         assert_eq!(update_fail_htlcs.len(), 3);
3267                         assert!(update_fulfill_htlcs.is_empty());
3268                         assert!(update_fail_malformed_htlcs.is_empty());
3269                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3270
3271                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3272                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3273                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3274
3275                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3276
3277                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3278                         // If we delivered B's RAA we got an unknown preimage error, not something
3279                         // that we should update our routing table for.
3280                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3281                         for event in events {
3282                                 match event {
3283                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3284                                         _ => panic!("Unexpected event"),
3285                                 }
3286                         }
3287                         let events = nodes[0].node.get_and_clear_pending_events();
3288                         assert_eq!(events.len(), 3);
3289                         match events[0] {
3290                                 Event::PaymentFailed { ref payment_hash, .. } => {
3291                                         assert!(failed_htlcs.insert(payment_hash.0));
3292                                 },
3293                                 _ => panic!("Unexpected event"),
3294                         }
3295                         match events[1] {
3296                                 Event::PaymentFailed { ref payment_hash, .. } => {
3297                                         assert!(failed_htlcs.insert(payment_hash.0));
3298                                 },
3299                                 _ => panic!("Unexpected event"),
3300                         }
3301                         match events[2] {
3302                                 Event::PaymentFailed { ref payment_hash, .. } => {
3303                                         assert!(failed_htlcs.insert(payment_hash.0));
3304                                 },
3305                                 _ => panic!("Unexpected event"),
3306                         }
3307                 },
3308                 _ => panic!("Unexpected event"),
3309         }
3310
3311         assert!(failed_htlcs.contains(&first_payment_hash.0));
3312         assert!(failed_htlcs.contains(&second_payment_hash.0));
3313         assert!(failed_htlcs.contains(&third_payment_hash.0));
3314 }
3315
3316 #[test]
3317 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3318         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3319         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3320         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3321         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3322 }
3323
3324 #[test]
3325 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3326         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3327         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3328         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3329         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3330 }
3331
3332 #[test]
3333 fn fail_backward_pending_htlc_upon_channel_failure() {
3334         let chanmon_cfgs = create_chanmon_cfgs(2);
3335         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3336         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3337         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3338         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3339         let logger = test_utils::TestLogger::new();
3340
3341         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3342         {
3343                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3344                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3345                 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();
3346                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3347                 check_added_monitors!(nodes[0], 1);
3348
3349                 let payment_event = {
3350                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3351                         assert_eq!(events.len(), 1);
3352                         SendEvent::from_event(events.remove(0))
3353                 };
3354                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3355                 assert_eq!(payment_event.msgs.len(), 1);
3356         }
3357
3358         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3359         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3360         {
3361                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3362                 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();
3363                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3364                 check_added_monitors!(nodes[0], 0);
3365
3366                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3367         }
3368
3369         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3370         {
3371                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3372
3373                 let secp_ctx = Secp256k1::new();
3374                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3375                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3376                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3377                 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();
3378                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3379                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3380                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3381
3382                 // Send a 0-msat update_add_htlc to fail the channel.
3383                 let update_add_htlc = msgs::UpdateAddHTLC {
3384                         channel_id: chan.2,
3385                         htlc_id: 0,
3386                         amount_msat: 0,
3387                         payment_hash,
3388                         cltv_expiry,
3389                         onion_routing_packet,
3390                 };
3391                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3392         }
3393
3394         // Check that Alice fails backward the pending HTLC from the second payment.
3395         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3396         check_closed_broadcast!(nodes[0], true);
3397         check_added_monitors!(nodes[0], 1);
3398 }
3399
3400 #[test]
3401 fn test_htlc_ignore_latest_remote_commitment() {
3402         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3403         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3404         let chanmon_cfgs = create_chanmon_cfgs(2);
3405         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3406         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3407         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3408         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3409
3410         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3411         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3412         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3413         check_closed_broadcast!(nodes[0], true);
3414         check_added_monitors!(nodes[0], 1);
3415
3416         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3417         assert_eq!(node_txn.len(), 3);
3418         assert_eq!(node_txn[0], node_txn[1]);
3419
3420         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3421         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3422         check_closed_broadcast!(nodes[1], true);
3423         check_added_monitors!(nodes[1], 1);
3424
3425         // Duplicate the connect_block call since this may happen due to other listeners
3426         // registering new transactions
3427         header.prev_blockhash = header.block_hash();
3428         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3429 }
3430
3431 #[test]
3432 fn test_force_close_fail_back() {
3433         // Check which HTLCs are failed-backwards on channel force-closure
3434         let chanmon_cfgs = create_chanmon_cfgs(3);
3435         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3436         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3437         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3438         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3439         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3440         let logger = test_utils::TestLogger::new();
3441
3442         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3443
3444         let mut payment_event = {
3445                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3446                 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();
3447                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3448                 check_added_monitors!(nodes[0], 1);
3449
3450                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3451                 assert_eq!(events.len(), 1);
3452                 SendEvent::from_event(events.remove(0))
3453         };
3454
3455         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3456         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3457
3458         expect_pending_htlcs_forwardable!(nodes[1]);
3459
3460         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3461         assert_eq!(events_2.len(), 1);
3462         payment_event = SendEvent::from_event(events_2.remove(0));
3463         assert_eq!(payment_event.msgs.len(), 1);
3464
3465         check_added_monitors!(nodes[1], 1);
3466         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3467         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3468         check_added_monitors!(nodes[2], 1);
3469         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3470
3471         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3472         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3473         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3474
3475         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3476         check_closed_broadcast!(nodes[2], true);
3477         check_added_monitors!(nodes[2], 1);
3478         let tx = {
3479                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3480                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3481                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3482                 // back to nodes[1] upon timeout otherwise.
3483                 assert_eq!(node_txn.len(), 1);
3484                 node_txn.remove(0)
3485         };
3486
3487         mine_transaction(&nodes[1], &tx);
3488
3489         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3490         check_closed_broadcast!(nodes[1], true);
3491         check_added_monitors!(nodes[1], 1);
3492
3493         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3494         {
3495                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3496                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3497                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3498         }
3499         mine_transaction(&nodes[2], &tx);
3500         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3501         assert_eq!(node_txn.len(), 1);
3502         assert_eq!(node_txn[0].input.len(), 1);
3503         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3504         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3505         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3506
3507         check_spends!(node_txn[0], tx);
3508 }
3509
3510 #[test]
3511 fn test_dup_events_on_peer_disconnect() {
3512         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3513         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3514         // as we used to generate the event immediately upon receipt of the payment preimage in the
3515         // update_fulfill_htlc message.
3516
3517         let chanmon_cfgs = create_chanmon_cfgs(2);
3518         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3519         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3520         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3521         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3522
3523         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3524
3525         assert!(nodes[1].node.claim_funds(payment_preimage));
3526         check_added_monitors!(nodes[1], 1);
3527         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3528         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3529         expect_payment_sent!(nodes[0], payment_preimage);
3530
3531         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3532         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3533
3534         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3535         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3536 }
3537
3538 #[test]
3539 fn test_simple_peer_disconnect() {
3540         // Test that we can reconnect when there are no lost messages
3541         let chanmon_cfgs = create_chanmon_cfgs(3);
3542         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3543         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3544         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3545         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3546         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3547
3548         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3549         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3550         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3551
3552         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3553         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3554         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3555         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3556
3557         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3558         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3559         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3560
3561         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3562         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3563         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3564         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3565
3566         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3567         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3568
3569         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3570         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3571
3572         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3573         {
3574                 let events = nodes[0].node.get_and_clear_pending_events();
3575                 assert_eq!(events.len(), 2);
3576                 match events[0] {
3577                         Event::PaymentSent { payment_preimage } => {
3578                                 assert_eq!(payment_preimage, payment_preimage_3);
3579                         },
3580                         _ => panic!("Unexpected event"),
3581                 }
3582                 match events[1] {
3583                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3584                                 assert_eq!(payment_hash, payment_hash_5);
3585                                 assert!(rejected_by_dest);
3586                         },
3587                         _ => panic!("Unexpected event"),
3588                 }
3589         }
3590
3591         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3592         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3593 }
3594
3595 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3596         // Test that we can reconnect when in-flight HTLC updates get dropped
3597         let chanmon_cfgs = create_chanmon_cfgs(2);
3598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3600         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3601
3602         let mut as_funding_locked = None;
3603         if messages_delivered == 0 {
3604                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3605                 as_funding_locked = Some(funding_locked);
3606                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3607                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3608                 // it before the channel_reestablish message.
3609         } else {
3610                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3611         }
3612
3613         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3614
3615         let logger = test_utils::TestLogger::new();
3616         let payment_event = {
3617                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3618                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3619                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3620                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3621                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3622                 check_added_monitors!(nodes[0], 1);
3623
3624                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3625                 assert_eq!(events.len(), 1);
3626                 SendEvent::from_event(events.remove(0))
3627         };
3628         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3629
3630         if messages_delivered < 2 {
3631                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3632         } else {
3633                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3634                 if messages_delivered >= 3 {
3635                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3636                         check_added_monitors!(nodes[1], 1);
3637                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3638
3639                         if messages_delivered >= 4 {
3640                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3641                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3642                                 check_added_monitors!(nodes[0], 1);
3643
3644                                 if messages_delivered >= 5 {
3645                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3646                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3647                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3648                                         check_added_monitors!(nodes[0], 1);
3649
3650                                         if messages_delivered >= 6 {
3651                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3652                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3653                                                 check_added_monitors!(nodes[1], 1);
3654                                         }
3655                                 }
3656                         }
3657                 }
3658         }
3659
3660         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3661         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3662         if messages_delivered < 3 {
3663                 if simulate_broken_lnd {
3664                         // lnd has a long-standing bug where they send a funding_locked prior to a
3665                         // channel_reestablish if you reconnect prior to funding_locked time.
3666                         //
3667                         // Here we simulate that behavior, delivering a funding_locked immediately on
3668                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3669                         // in `reconnect_nodes` but we currently don't fail based on that.
3670                         //
3671                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3672                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3673                 }
3674                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3675                 // received on either side, both sides will need to resend them.
3676                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3677         } else if messages_delivered == 3 {
3678                 // nodes[0] still wants its RAA + commitment_signed
3679                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3680         } else if messages_delivered == 4 {
3681                 // nodes[0] still wants its commitment_signed
3682                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3683         } else if messages_delivered == 5 {
3684                 // nodes[1] still wants its final RAA
3685                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3686         } else if messages_delivered == 6 {
3687                 // Everything was delivered...
3688                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3689         }
3690
3691         let events_1 = nodes[1].node.get_and_clear_pending_events();
3692         assert_eq!(events_1.len(), 1);
3693         match events_1[0] {
3694                 Event::PendingHTLCsForwardable { .. } => { },
3695                 _ => panic!("Unexpected event"),
3696         };
3697
3698         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3699         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3700         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3701
3702         nodes[1].node.process_pending_htlc_forwards();
3703
3704         let events_2 = nodes[1].node.get_and_clear_pending_events();
3705         assert_eq!(events_2.len(), 1);
3706         match events_2[0] {
3707                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3708                         assert_eq!(payment_hash_1, *payment_hash);
3709                         assert!(payment_preimage.is_none());
3710                         assert_eq!(payment_secret_1, *payment_secret);
3711                         assert_eq!(amt, 1000000);
3712                 },
3713                 _ => panic!("Unexpected event"),
3714         }
3715
3716         nodes[1].node.claim_funds(payment_preimage_1);
3717         check_added_monitors!(nodes[1], 1);
3718
3719         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3720         assert_eq!(events_3.len(), 1);
3721         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3722                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3723                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3724                         assert!(updates.update_add_htlcs.is_empty());
3725                         assert!(updates.update_fail_htlcs.is_empty());
3726                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3727                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3728                         assert!(updates.update_fee.is_none());
3729                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3730                 },
3731                 _ => panic!("Unexpected event"),
3732         };
3733
3734         if messages_delivered >= 1 {
3735                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3736
3737                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3738                 assert_eq!(events_4.len(), 1);
3739                 match events_4[0] {
3740                         Event::PaymentSent { ref payment_preimage } => {
3741                                 assert_eq!(payment_preimage_1, *payment_preimage);
3742                         },
3743                         _ => panic!("Unexpected event"),
3744                 }
3745
3746                 if messages_delivered >= 2 {
3747                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3748                         check_added_monitors!(nodes[0], 1);
3749                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3750
3751                         if messages_delivered >= 3 {
3752                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3753                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3754                                 check_added_monitors!(nodes[1], 1);
3755
3756                                 if messages_delivered >= 4 {
3757                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3758                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3759                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3760                                         check_added_monitors!(nodes[1], 1);
3761
3762                                         if messages_delivered >= 5 {
3763                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3764                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3765                                                 check_added_monitors!(nodes[0], 1);
3766                                         }
3767                                 }
3768                         }
3769                 }
3770         }
3771
3772         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3773         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3774         if messages_delivered < 2 {
3775                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3776                 if messages_delivered < 1 {
3777                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3778                         assert_eq!(events_4.len(), 1);
3779                         match events_4[0] {
3780                                 Event::PaymentSent { ref payment_preimage } => {
3781                                         assert_eq!(payment_preimage_1, *payment_preimage);
3782                                 },
3783                                 _ => panic!("Unexpected event"),
3784                         }
3785                 } else {
3786                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3787                 }
3788         } else if messages_delivered == 2 {
3789                 // nodes[0] still wants its RAA + commitment_signed
3790                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3791         } else if messages_delivered == 3 {
3792                 // nodes[0] still wants its commitment_signed
3793                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3794         } else if messages_delivered == 4 {
3795                 // nodes[1] still wants its final RAA
3796                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3797         } else if messages_delivered == 5 {
3798                 // Everything was delivered...
3799                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3800         }
3801
3802         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3803         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3804         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3805
3806         // Channel should still work fine...
3807         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3808         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3809                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3810                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3811         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3812         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3813 }
3814
3815 #[test]
3816 fn test_drop_messages_peer_disconnect_a() {
3817         do_test_drop_messages_peer_disconnect(0, true);
3818         do_test_drop_messages_peer_disconnect(0, false);
3819         do_test_drop_messages_peer_disconnect(1, false);
3820         do_test_drop_messages_peer_disconnect(2, false);
3821 }
3822
3823 #[test]
3824 fn test_drop_messages_peer_disconnect_b() {
3825         do_test_drop_messages_peer_disconnect(3, false);
3826         do_test_drop_messages_peer_disconnect(4, false);
3827         do_test_drop_messages_peer_disconnect(5, false);
3828         do_test_drop_messages_peer_disconnect(6, false);
3829 }
3830
3831 #[test]
3832 fn test_funding_peer_disconnect() {
3833         // Test that we can lock in our funding tx while disconnected
3834         let chanmon_cfgs = create_chanmon_cfgs(2);
3835         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3836         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3837         let persister: test_utils::TestPersister;
3838         let new_chain_monitor: test_utils::TestChainMonitor;
3839         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3840         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3841         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3842
3843         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3844         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3845
3846         confirm_transaction(&nodes[0], &tx);
3847         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3848         assert_eq!(events_1.len(), 1);
3849         match events_1[0] {
3850                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3851                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3852                 },
3853                 _ => panic!("Unexpected event"),
3854         }
3855
3856         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3857
3858         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3859         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3860
3861         confirm_transaction(&nodes[1], &tx);
3862         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3863         assert_eq!(events_2.len(), 2);
3864         let funding_locked = match events_2[0] {
3865                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3866                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3867                         msg.clone()
3868                 },
3869                 _ => panic!("Unexpected event"),
3870         };
3871         let bs_announcement_sigs = match events_2[1] {
3872                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3873                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3874                         msg.clone()
3875                 },
3876                 _ => panic!("Unexpected event"),
3877         };
3878
3879         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3880
3881         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3882         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3883         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3884         assert_eq!(events_3.len(), 2);
3885         let as_announcement_sigs = match events_3[0] {
3886                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3887                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3888                         msg.clone()
3889                 },
3890                 _ => panic!("Unexpected event"),
3891         };
3892         let (as_announcement, as_update) = match events_3[1] {
3893                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3894                         (msg.clone(), update_msg.clone())
3895                 },
3896                 _ => panic!("Unexpected event"),
3897         };
3898
3899         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3900         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3901         assert_eq!(events_4.len(), 1);
3902         let (_, bs_update) = match events_4[0] {
3903                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3904                         (msg.clone(), update_msg.clone())
3905                 },
3906                 _ => panic!("Unexpected event"),
3907         };
3908
3909         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3910         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3911         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3912
3913         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3914         let logger = test_utils::TestLogger::new();
3915         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();
3916         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3917         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3918
3919         // Check that after deserialization and reconnection we can still generate an identical
3920         // channel_announcement from the cached signatures.
3921         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3922
3923         let nodes_0_serialized = nodes[0].node.encode();
3924         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3925         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3926
3927         persister = test_utils::TestPersister::new();
3928         let keys_manager = &chanmon_cfgs[0].keys_manager;
3929         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);
3930         nodes[0].chain_monitor = &new_chain_monitor;
3931         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3932         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3933                 &mut chan_0_monitor_read, keys_manager).unwrap();
3934         assert!(chan_0_monitor_read.is_empty());
3935
3936         let mut nodes_0_read = &nodes_0_serialized[..];
3937         let (_, nodes_0_deserialized_tmp) = {
3938                 let mut channel_monitors = HashMap::new();
3939                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3940                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3941                         default_config: UserConfig::default(),
3942                         keys_manager,
3943                         fee_estimator: node_cfgs[0].fee_estimator,
3944                         chain_monitor: nodes[0].chain_monitor,
3945                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3946                         logger: nodes[0].logger,
3947                         channel_monitors,
3948                 }).unwrap()
3949         };
3950         nodes_0_deserialized = nodes_0_deserialized_tmp;
3951         assert!(nodes_0_read.is_empty());
3952
3953         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3954         nodes[0].node = &nodes_0_deserialized;
3955         check_added_monitors!(nodes[0], 1);
3956
3957         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3958
3959         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3960         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3961         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3962         let mut found_announcement = false;
3963         for event in msgs.iter() {
3964                 match event {
3965                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3966                                 if *msg == as_announcement { found_announcement = true; }
3967                         },
3968                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3969                         _ => panic!("Unexpected event"),
3970                 }
3971         }
3972         assert!(found_announcement);
3973 }
3974
3975 #[test]
3976 fn test_drop_messages_peer_disconnect_dual_htlc() {
3977         // Test that we can handle reconnecting when both sides of a channel have pending
3978         // commitment_updates when we disconnect.
3979         let chanmon_cfgs = create_chanmon_cfgs(2);
3980         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3981         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3982         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3983         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3984         let logger = test_utils::TestLogger::new();
3985
3986         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3987
3988         // Now try to send a second payment which will fail to send
3989         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3990         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3991         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();
3992         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3993         check_added_monitors!(nodes[0], 1);
3994
3995         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3996         assert_eq!(events_1.len(), 1);
3997         match events_1[0] {
3998                 MessageSendEvent::UpdateHTLCs { .. } => {},
3999                 _ => panic!("Unexpected event"),
4000         }
4001
4002         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4003         check_added_monitors!(nodes[1], 1);
4004
4005         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4006         assert_eq!(events_2.len(), 1);
4007         match events_2[0] {
4008                 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 } } => {
4009                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4010                         assert!(update_add_htlcs.is_empty());
4011                         assert_eq!(update_fulfill_htlcs.len(), 1);
4012                         assert!(update_fail_htlcs.is_empty());
4013                         assert!(update_fail_malformed_htlcs.is_empty());
4014                         assert!(update_fee.is_none());
4015
4016                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4017                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4018                         assert_eq!(events_3.len(), 1);
4019                         match events_3[0] {
4020                                 Event::PaymentSent { ref payment_preimage } => {
4021                                         assert_eq!(*payment_preimage, payment_preimage_1);
4022                                 },
4023                                 _ => panic!("Unexpected event"),
4024                         }
4025
4026                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4027                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4028                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4029                         check_added_monitors!(nodes[0], 1);
4030                 },
4031                 _ => panic!("Unexpected event"),
4032         }
4033
4034         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4035         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4036
4037         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4038         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4039         assert_eq!(reestablish_1.len(), 1);
4040         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4041         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4042         assert_eq!(reestablish_2.len(), 1);
4043
4044         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4045         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4046         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4047         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4048
4049         assert!(as_resp.0.is_none());
4050         assert!(bs_resp.0.is_none());
4051
4052         assert!(bs_resp.1.is_none());
4053         assert!(bs_resp.2.is_none());
4054
4055         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4056
4057         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4058         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4059         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4060         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4061         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4062         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4063         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4064         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4065         // No commitment_signed so get_event_msg's assert(len == 1) passes
4066         check_added_monitors!(nodes[1], 1);
4067
4068         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4069         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4070         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4071         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4072         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4073         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4074         assert!(bs_second_commitment_signed.update_fee.is_none());
4075         check_added_monitors!(nodes[1], 1);
4076
4077         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4078         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4079         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4080         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4081         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4082         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4083         assert!(as_commitment_signed.update_fee.is_none());
4084         check_added_monitors!(nodes[0], 1);
4085
4086         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4087         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4088         // No commitment_signed so get_event_msg's assert(len == 1) passes
4089         check_added_monitors!(nodes[0], 1);
4090
4091         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4092         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4093         // No commitment_signed so get_event_msg's assert(len == 1) passes
4094         check_added_monitors!(nodes[1], 1);
4095
4096         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4097         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4098         check_added_monitors!(nodes[1], 1);
4099
4100         expect_pending_htlcs_forwardable!(nodes[1]);
4101
4102         let events_5 = nodes[1].node.get_and_clear_pending_events();
4103         assert_eq!(events_5.len(), 1);
4104         match events_5[0] {
4105                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4106                         assert_eq!(payment_hash_2, *payment_hash);
4107                         assert!(payment_preimage.is_none());
4108                         assert_eq!(payment_secret_2, *payment_secret);
4109                 },
4110                 _ => panic!("Unexpected event"),
4111         }
4112
4113         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4114         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4115         check_added_monitors!(nodes[0], 1);
4116
4117         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4118 }
4119
4120 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4121         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4122         // to avoid our counterparty failing the channel.
4123         let chanmon_cfgs = create_chanmon_cfgs(2);
4124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4126         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4127
4128         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4129         let logger = test_utils::TestLogger::new();
4130
4131         let our_payment_hash = if send_partial_mpp {
4132                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4133                 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();
4134                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4135                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4136                 // indicates there are more HTLCs coming.
4137                 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.
4138                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4139                 check_added_monitors!(nodes[0], 1);
4140                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4141                 assert_eq!(events.len(), 1);
4142                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4143                 // hop should *not* yet generate any PaymentReceived event(s).
4144                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4145                 our_payment_hash
4146         } else {
4147                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4148         };
4149
4150         let mut block = Block {
4151                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4152                 txdata: vec![],
4153         };
4154         connect_block(&nodes[0], &block);
4155         connect_block(&nodes[1], &block);
4156         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4157         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4158                 block.header.prev_blockhash = block.block_hash();
4159                 connect_block(&nodes[0], &block);
4160                 connect_block(&nodes[1], &block);
4161         }
4162
4163         expect_pending_htlcs_forwardable!(nodes[1]);
4164
4165         check_added_monitors!(nodes[1], 1);
4166         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4167         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4168         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4169         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4170         assert!(htlc_timeout_updates.update_fee.is_none());
4171
4172         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4173         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4174         // 100_000 msat as u64, followed by the height at which we failed back above
4175         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4176         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4177         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4178 }
4179
4180 #[test]
4181 fn test_htlc_timeout() {
4182         do_test_htlc_timeout(true);
4183         do_test_htlc_timeout(false);
4184 }
4185
4186 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4187         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4188         let chanmon_cfgs = create_chanmon_cfgs(3);
4189         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4190         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4191         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4192         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4193         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4194
4195         // Make sure all nodes are at the same starting height
4196         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4197         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4198         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4199
4200         let logger = test_utils::TestLogger::new();
4201
4202         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4203         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4204         {
4205                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4206                 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();
4207                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4208         }
4209         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4210         check_added_monitors!(nodes[1], 1);
4211
4212         // Now attempt to route a second payment, which should be placed in the holding cell
4213         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4214         if forwarded_htlc {
4215                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4216                 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();
4217                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4218                 check_added_monitors!(nodes[0], 1);
4219                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4220                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4221                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4222                 expect_pending_htlcs_forwardable!(nodes[1]);
4223                 check_added_monitors!(nodes[1], 0);
4224         } else {
4225                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4226                 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();
4227                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4228                 check_added_monitors!(nodes[1], 0);
4229         }
4230
4231         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4232         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4233         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4234         connect_blocks(&nodes[1], 1);
4235
4236         if forwarded_htlc {
4237                 expect_pending_htlcs_forwardable!(nodes[1]);
4238                 check_added_monitors!(nodes[1], 1);
4239                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4240                 assert_eq!(fail_commit.len(), 1);
4241                 match fail_commit[0] {
4242                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4243                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4244                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4245                         },
4246                         _ => unreachable!(),
4247                 }
4248                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4249                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4250         } else {
4251                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4252         }
4253 }
4254
4255 #[test]
4256 fn test_holding_cell_htlc_add_timeouts() {
4257         do_test_holding_cell_htlc_add_timeouts(false);
4258         do_test_holding_cell_htlc_add_timeouts(true);
4259 }
4260
4261 #[test]
4262 fn test_invalid_channel_announcement() {
4263         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4264         let secp_ctx = Secp256k1::new();
4265         let chanmon_cfgs = create_chanmon_cfgs(2);
4266         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4267         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4268         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4269
4270         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4271
4272         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4273         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4274         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4275         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4276
4277         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 } );
4278
4279         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4280         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4281
4282         let as_network_key = nodes[0].node.get_our_node_id();
4283         let bs_network_key = nodes[1].node.get_our_node_id();
4284
4285         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4286
4287         let mut chan_announcement;
4288
4289         macro_rules! dummy_unsigned_msg {
4290                 () => {
4291                         msgs::UnsignedChannelAnnouncement {
4292                                 features: ChannelFeatures::known(),
4293                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4294                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4295                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4296                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4297                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4298                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4299                                 excess_data: Vec::new(),
4300                         };
4301                 }
4302         }
4303
4304         macro_rules! sign_msg {
4305                 ($unsigned_msg: expr) => {
4306                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4307                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4308                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4309                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4310                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4311                         chan_announcement = msgs::ChannelAnnouncement {
4312                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4313                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4314                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4315                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4316                                 contents: $unsigned_msg
4317                         }
4318                 }
4319         }
4320
4321         let unsigned_msg = dummy_unsigned_msg!();
4322         sign_msg!(unsigned_msg);
4323         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4324         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 } );
4325
4326         // Configured with Network::Testnet
4327         let mut unsigned_msg = dummy_unsigned_msg!();
4328         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4329         sign_msg!(unsigned_msg);
4330         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4331
4332         let mut unsigned_msg = dummy_unsigned_msg!();
4333         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4334         sign_msg!(unsigned_msg);
4335         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4336 }
4337
4338 #[test]
4339 fn test_no_txn_manager_serialize_deserialize() {
4340         let chanmon_cfgs = create_chanmon_cfgs(2);
4341         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4342         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4343         let logger: test_utils::TestLogger;
4344         let fee_estimator: test_utils::TestFeeEstimator;
4345         let persister: test_utils::TestPersister;
4346         let new_chain_monitor: test_utils::TestChainMonitor;
4347         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4348         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4349
4350         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4351
4352         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4353
4354         let nodes_0_serialized = nodes[0].node.encode();
4355         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4356         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4357
4358         logger = test_utils::TestLogger::new();
4359         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4360         persister = test_utils::TestPersister::new();
4361         let keys_manager = &chanmon_cfgs[0].keys_manager;
4362         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4363         nodes[0].chain_monitor = &new_chain_monitor;
4364         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4365         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4366                 &mut chan_0_monitor_read, keys_manager).unwrap();
4367         assert!(chan_0_monitor_read.is_empty());
4368
4369         let mut nodes_0_read = &nodes_0_serialized[..];
4370         let config = UserConfig::default();
4371         let (_, nodes_0_deserialized_tmp) = {
4372                 let mut channel_monitors = HashMap::new();
4373                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4374                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4375                         default_config: config,
4376                         keys_manager,
4377                         fee_estimator: &fee_estimator,
4378                         chain_monitor: nodes[0].chain_monitor,
4379                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4380                         logger: &logger,
4381                         channel_monitors,
4382                 }).unwrap()
4383         };
4384         nodes_0_deserialized = nodes_0_deserialized_tmp;
4385         assert!(nodes_0_read.is_empty());
4386
4387         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4388         nodes[0].node = &nodes_0_deserialized;
4389         assert_eq!(nodes[0].node.list_channels().len(), 1);
4390         check_added_monitors!(nodes[0], 1);
4391
4392         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4393         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4394         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4395         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4396
4397         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4398         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4399         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4400         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4401
4402         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4403         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4404         for node in nodes.iter() {
4405                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4406                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4407                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4408         }
4409
4410         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4411 }
4412
4413 #[test]
4414 fn test_dup_htlc_onchain_fails_on_reload() {
4415         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4416         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4417         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4418         // the ChannelMonitor tells it to.
4419         //
4420         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4421         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4422         // PaymentFailed event appearing). However, because we may not serialize the relevant
4423         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4424         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4425         // and de-duplicates ChannelMonitor events.
4426         //
4427         // This tests that explicit tracking behavior.
4428         let chanmon_cfgs = create_chanmon_cfgs(2);
4429         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4430         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4431         let persister: test_utils::TestPersister;
4432         let new_chain_monitor: test_utils::TestChainMonitor;
4433         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4434         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4435
4436         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4437
4438         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4439         // nodes[0].
4440         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4441         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4442         check_closed_broadcast!(nodes[0], true);
4443         check_added_monitors!(nodes[0], 1);
4444
4445         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4446         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4447
4448         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4449         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4450         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4451         assert_eq!(node_txn.len(), 3);
4452         assert_eq!(node_txn[0], node_txn[1]);
4453
4454         assert!(nodes[1].node.claim_funds(payment_preimage));
4455         check_added_monitors!(nodes[1], 1);
4456
4457         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4458         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4459         check_closed_broadcast!(nodes[1], true);
4460         check_added_monitors!(nodes[1], 1);
4461         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4462
4463         header.prev_blockhash = nodes[0].best_block_hash();
4464         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4465
4466         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4467         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4468         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4469         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4470         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4471
4472         header.prev_blockhash = nodes[0].best_block_hash();
4473         let claim_block = Block { header, txdata: claim_txn};
4474         connect_block(&nodes[0], &claim_block);
4475         expect_payment_sent!(nodes[0], payment_preimage);
4476
4477         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4478         // connected a highly-relevant block, it likely gets serialized out now.
4479         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4480         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4481
4482         // Now reload nodes[0]...
4483         persister = test_utils::TestPersister::new();
4484         let keys_manager = &chanmon_cfgs[0].keys_manager;
4485         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);
4486         nodes[0].chain_monitor = &new_chain_monitor;
4487         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4488         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4489                 &mut chan_0_monitor_read, keys_manager).unwrap();
4490         assert!(chan_0_monitor_read.is_empty());
4491
4492         let (_, nodes_0_deserialized_tmp) = {
4493                 let mut channel_monitors = HashMap::new();
4494                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4495                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4496                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4497                                 default_config: Default::default(),
4498                                 keys_manager,
4499                                 fee_estimator: node_cfgs[0].fee_estimator,
4500                                 chain_monitor: nodes[0].chain_monitor,
4501                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4502                                 logger: nodes[0].logger,
4503                                 channel_monitors,
4504                         }).unwrap()
4505         };
4506         nodes_0_deserialized = nodes_0_deserialized_tmp;
4507
4508         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4509         check_added_monitors!(nodes[0], 1);
4510         nodes[0].node = &nodes_0_deserialized;
4511
4512         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4513         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4514         // payment events should kick in, leaving us with no pending events here.
4515         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4516         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4517         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4518 }
4519
4520 #[test]
4521 fn test_manager_serialize_deserialize_events() {
4522         // This test makes sure the events field in ChannelManager survives de/serialization
4523         let chanmon_cfgs = create_chanmon_cfgs(2);
4524         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4525         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4526         let fee_estimator: test_utils::TestFeeEstimator;
4527         let persister: test_utils::TestPersister;
4528         let logger: test_utils::TestLogger;
4529         let new_chain_monitor: test_utils::TestChainMonitor;
4530         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4531         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4532
4533         // Start creating a channel, but stop right before broadcasting the funding transaction
4534         let channel_value = 100000;
4535         let push_msat = 10001;
4536         let a_flags = InitFeatures::known();
4537         let b_flags = InitFeatures::known();
4538         let node_a = nodes.remove(0);
4539         let node_b = nodes.remove(0);
4540         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4541         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()));
4542         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()));
4543
4544         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4545
4546         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4547         check_added_monitors!(node_a, 0);
4548
4549         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()));
4550         {
4551                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4552                 assert_eq!(added_monitors.len(), 1);
4553                 assert_eq!(added_monitors[0].0, funding_output);
4554                 added_monitors.clear();
4555         }
4556
4557         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()));
4558         {
4559                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4560                 assert_eq!(added_monitors.len(), 1);
4561                 assert_eq!(added_monitors[0].0, funding_output);
4562                 added_monitors.clear();
4563         }
4564         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4565
4566         nodes.push(node_a);
4567         nodes.push(node_b);
4568
4569         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4570         let nodes_0_serialized = nodes[0].node.encode();
4571         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4572         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4573
4574         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4575         logger = test_utils::TestLogger::new();
4576         persister = test_utils::TestPersister::new();
4577         let keys_manager = &chanmon_cfgs[0].keys_manager;
4578         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4579         nodes[0].chain_monitor = &new_chain_monitor;
4580         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4581         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4582                 &mut chan_0_monitor_read, keys_manager).unwrap();
4583         assert!(chan_0_monitor_read.is_empty());
4584
4585         let mut nodes_0_read = &nodes_0_serialized[..];
4586         let config = UserConfig::default();
4587         let (_, nodes_0_deserialized_tmp) = {
4588                 let mut channel_monitors = HashMap::new();
4589                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4590                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4591                         default_config: config,
4592                         keys_manager,
4593                         fee_estimator: &fee_estimator,
4594                         chain_monitor: nodes[0].chain_monitor,
4595                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4596                         logger: &logger,
4597                         channel_monitors,
4598                 }).unwrap()
4599         };
4600         nodes_0_deserialized = nodes_0_deserialized_tmp;
4601         assert!(nodes_0_read.is_empty());
4602
4603         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4604
4605         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4606         nodes[0].node = &nodes_0_deserialized;
4607
4608         // After deserializing, make sure the funding_transaction is still held by the channel manager
4609         let events_4 = nodes[0].node.get_and_clear_pending_events();
4610         assert_eq!(events_4.len(), 0);
4611         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4612         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4613
4614         // Make sure the channel is functioning as though the de/serialization never happened
4615         assert_eq!(nodes[0].node.list_channels().len(), 1);
4616         check_added_monitors!(nodes[0], 1);
4617
4618         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4619         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4620         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4621         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4622
4623         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4624         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4625         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4626         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4627
4628         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4629         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4630         for node in nodes.iter() {
4631                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4632                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4633                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4634         }
4635
4636         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4637 }
4638
4639 #[test]
4640 fn test_simple_manager_serialize_deserialize() {
4641         let chanmon_cfgs = create_chanmon_cfgs(2);
4642         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4643         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4644         let logger: test_utils::TestLogger;
4645         let fee_estimator: test_utils::TestFeeEstimator;
4646         let persister: test_utils::TestPersister;
4647         let new_chain_monitor: test_utils::TestChainMonitor;
4648         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4649         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4650         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4651
4652         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4653         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4654
4655         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4656
4657         let nodes_0_serialized = nodes[0].node.encode();
4658         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4659         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4660
4661         logger = test_utils::TestLogger::new();
4662         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4663         persister = test_utils::TestPersister::new();
4664         let keys_manager = &chanmon_cfgs[0].keys_manager;
4665         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4666         nodes[0].chain_monitor = &new_chain_monitor;
4667         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4668         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4669                 &mut chan_0_monitor_read, keys_manager).unwrap();
4670         assert!(chan_0_monitor_read.is_empty());
4671
4672         let mut nodes_0_read = &nodes_0_serialized[..];
4673         let (_, nodes_0_deserialized_tmp) = {
4674                 let mut channel_monitors = HashMap::new();
4675                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4676                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4677                         default_config: UserConfig::default(),
4678                         keys_manager,
4679                         fee_estimator: &fee_estimator,
4680                         chain_monitor: nodes[0].chain_monitor,
4681                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4682                         logger: &logger,
4683                         channel_monitors,
4684                 }).unwrap()
4685         };
4686         nodes_0_deserialized = nodes_0_deserialized_tmp;
4687         assert!(nodes_0_read.is_empty());
4688
4689         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4690         nodes[0].node = &nodes_0_deserialized;
4691         check_added_monitors!(nodes[0], 1);
4692
4693         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4694
4695         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4696         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4697 }
4698
4699 #[test]
4700 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4701         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4702         let chanmon_cfgs = create_chanmon_cfgs(4);
4703         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4704         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4705         let logger: test_utils::TestLogger;
4706         let fee_estimator: test_utils::TestFeeEstimator;
4707         let persister: test_utils::TestPersister;
4708         let new_chain_monitor: test_utils::TestChainMonitor;
4709         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4710         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4711         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4712         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4713         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4714
4715         let mut node_0_stale_monitors_serialized = Vec::new();
4716         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4717                 let mut writer = test_utils::TestVecWriter(Vec::new());
4718                 monitor.1.write(&mut writer).unwrap();
4719                 node_0_stale_monitors_serialized.push(writer.0);
4720         }
4721
4722         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4723
4724         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4725         let nodes_0_serialized = nodes[0].node.encode();
4726
4727         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4728         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4729         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4730         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4731
4732         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4733         // nodes[3])
4734         let mut node_0_monitors_serialized = Vec::new();
4735         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4736                 let mut writer = test_utils::TestVecWriter(Vec::new());
4737                 monitor.1.write(&mut writer).unwrap();
4738                 node_0_monitors_serialized.push(writer.0);
4739         }
4740
4741         logger = test_utils::TestLogger::new();
4742         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4743         persister = test_utils::TestPersister::new();
4744         let keys_manager = &chanmon_cfgs[0].keys_manager;
4745         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4746         nodes[0].chain_monitor = &new_chain_monitor;
4747
4748
4749         let mut node_0_stale_monitors = Vec::new();
4750         for serialized in node_0_stale_monitors_serialized.iter() {
4751                 let mut read = &serialized[..];
4752                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4753                 assert!(read.is_empty());
4754                 node_0_stale_monitors.push(monitor);
4755         }
4756
4757         let mut node_0_monitors = Vec::new();
4758         for serialized in node_0_monitors_serialized.iter() {
4759                 let mut read = &serialized[..];
4760                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4761                 assert!(read.is_empty());
4762                 node_0_monitors.push(monitor);
4763         }
4764
4765         let mut nodes_0_read = &nodes_0_serialized[..];
4766         if let Err(msgs::DecodeError::InvalidValue) =
4767                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4768                 default_config: UserConfig::default(),
4769                 keys_manager,
4770                 fee_estimator: &fee_estimator,
4771                 chain_monitor: nodes[0].chain_monitor,
4772                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4773                 logger: &logger,
4774                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4775         }) { } else {
4776                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4777         };
4778
4779         let mut nodes_0_read = &nodes_0_serialized[..];
4780         let (_, nodes_0_deserialized_tmp) =
4781                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4782                 default_config: UserConfig::default(),
4783                 keys_manager,
4784                 fee_estimator: &fee_estimator,
4785                 chain_monitor: nodes[0].chain_monitor,
4786                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4787                 logger: &logger,
4788                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4789         }).unwrap();
4790         nodes_0_deserialized = nodes_0_deserialized_tmp;
4791         assert!(nodes_0_read.is_empty());
4792
4793         { // Channel close should result in a commitment tx
4794                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4795                 assert_eq!(txn.len(), 1);
4796                 check_spends!(txn[0], funding_tx);
4797                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4798         }
4799
4800         for monitor in node_0_monitors.drain(..) {
4801                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4802                 check_added_monitors!(nodes[0], 1);
4803         }
4804         nodes[0].node = &nodes_0_deserialized;
4805
4806         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4807         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4808         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4809         //... and we can even still claim the payment!
4810         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4811
4812         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4813         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4814         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4815         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4816         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4817         assert_eq!(msg_events.len(), 1);
4818         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4819                 match action {
4820                         &ErrorAction::SendErrorMessage { ref msg } => {
4821                                 assert_eq!(msg.channel_id, channel_id);
4822                         },
4823                         _ => panic!("Unexpected event!"),
4824                 }
4825         }
4826 }
4827
4828 macro_rules! check_spendable_outputs {
4829         ($node: expr, $keysinterface: expr) => {
4830                 {
4831                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4832                         let mut txn = Vec::new();
4833                         let mut all_outputs = Vec::new();
4834                         let secp_ctx = Secp256k1::new();
4835                         for event in events.drain(..) {
4836                                 match event {
4837                                         Event::SpendableOutputs { mut outputs } => {
4838                                                 for outp in outputs.drain(..) {
4839                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4840                                                         all_outputs.push(outp);
4841                                                 }
4842                                         },
4843                                         _ => panic!("Unexpected event"),
4844                                 };
4845                         }
4846                         if all_outputs.len() > 1 {
4847                                 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) {
4848                                         txn.push(tx);
4849                                 }
4850                         }
4851                         txn
4852                 }
4853         }
4854 }
4855
4856 #[test]
4857 fn test_claim_sizeable_push_msat() {
4858         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4859         let chanmon_cfgs = create_chanmon_cfgs(2);
4860         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4861         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4862         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4863
4864         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4865         nodes[1].node.force_close_channel(&chan.2).unwrap();
4866         check_closed_broadcast!(nodes[1], true);
4867         check_added_monitors!(nodes[1], 1);
4868         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4869         assert_eq!(node_txn.len(), 1);
4870         check_spends!(node_txn[0], chan.3);
4871         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
4872
4873         mine_transaction(&nodes[1], &node_txn[0]);
4874         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4875
4876         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4877         assert_eq!(spend_txn.len(), 1);
4878         assert_eq!(spend_txn[0].input.len(), 1);
4879         check_spends!(spend_txn[0], node_txn[0]);
4880         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4881 }
4882
4883 #[test]
4884 fn test_claim_on_remote_sizeable_push_msat() {
4885         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4886         // to_remote output is encumbered by a P2WPKH
4887         let chanmon_cfgs = create_chanmon_cfgs(2);
4888         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4889         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4890         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4891
4892         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4893         nodes[0].node.force_close_channel(&chan.2).unwrap();
4894         check_closed_broadcast!(nodes[0], true);
4895         check_added_monitors!(nodes[0], 1);
4896
4897         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4898         assert_eq!(node_txn.len(), 1);
4899         check_spends!(node_txn[0], chan.3);
4900         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
4901
4902         mine_transaction(&nodes[1], &node_txn[0]);
4903         check_closed_broadcast!(nodes[1], true);
4904         check_added_monitors!(nodes[1], 1);
4905         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4906
4907         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4908         assert_eq!(spend_txn.len(), 1);
4909         check_spends!(spend_txn[0], node_txn[0]);
4910 }
4911
4912 #[test]
4913 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4914         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4915         // to_remote output is encumbered by a P2WPKH
4916
4917         let chanmon_cfgs = create_chanmon_cfgs(2);
4918         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4919         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4920         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4921
4922         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4923         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4924         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4925         assert_eq!(revoked_local_txn[0].input.len(), 1);
4926         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4927
4928         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4929         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4930         check_closed_broadcast!(nodes[1], true);
4931         check_added_monitors!(nodes[1], 1);
4932
4933         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4934         mine_transaction(&nodes[1], &node_txn[0]);
4935         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4936
4937         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4938         assert_eq!(spend_txn.len(), 3);
4939         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4940         check_spends!(spend_txn[1], node_txn[0]);
4941         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4942 }
4943
4944 #[test]
4945 fn test_static_spendable_outputs_preimage_tx() {
4946         let chanmon_cfgs = create_chanmon_cfgs(2);
4947         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4948         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4949         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4950
4951         // Create some initial channels
4952         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4953
4954         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4955
4956         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4957         assert_eq!(commitment_tx[0].input.len(), 1);
4958         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4959
4960         // Settle A's commitment tx on B's chain
4961         assert!(nodes[1].node.claim_funds(payment_preimage));
4962         check_added_monitors!(nodes[1], 1);
4963         mine_transaction(&nodes[1], &commitment_tx[0]);
4964         check_added_monitors!(nodes[1], 1);
4965         let events = nodes[1].node.get_and_clear_pending_msg_events();
4966         match events[0] {
4967                 MessageSendEvent::UpdateHTLCs { .. } => {},
4968                 _ => panic!("Unexpected event"),
4969         }
4970         match events[1] {
4971                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4972                 _ => panic!("Unexepected event"),
4973         }
4974
4975         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4976         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4977         assert_eq!(node_txn.len(), 3);
4978         check_spends!(node_txn[0], commitment_tx[0]);
4979         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4980         check_spends!(node_txn[1], chan_1.3);
4981         check_spends!(node_txn[2], node_txn[1]);
4982
4983         mine_transaction(&nodes[1], &node_txn[0]);
4984         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4985
4986         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4987         assert_eq!(spend_txn.len(), 1);
4988         check_spends!(spend_txn[0], node_txn[0]);
4989 }
4990
4991 #[test]
4992 fn test_static_spendable_outputs_timeout_tx() {
4993         let chanmon_cfgs = create_chanmon_cfgs(2);
4994         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4995         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4996         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4997
4998         // Create some initial channels
4999         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5000
5001         // Rebalance the network a bit by relaying one payment through all the channels ...
5002         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5003
5004         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5005
5006         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5007         assert_eq!(commitment_tx[0].input.len(), 1);
5008         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5009
5010         // Settle A's commitment tx on B' chain
5011         mine_transaction(&nodes[1], &commitment_tx[0]);
5012         check_added_monitors!(nodes[1], 1);
5013         let events = nodes[1].node.get_and_clear_pending_msg_events();
5014         match events[0] {
5015                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5016                 _ => panic!("Unexpected event"),
5017         }
5018         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5019
5020         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5021         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5022         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5023         check_spends!(node_txn[0], chan_1.3.clone());
5024         check_spends!(node_txn[1],  commitment_tx[0].clone());
5025         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5026
5027         mine_transaction(&nodes[1], &node_txn[1]);
5028         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5029         expect_payment_failed!(nodes[1], our_payment_hash, true);
5030
5031         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5032         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5033         check_spends!(spend_txn[0], commitment_tx[0]);
5034         check_spends!(spend_txn[1], node_txn[1]);
5035         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5036 }
5037
5038 #[test]
5039 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5040         let chanmon_cfgs = create_chanmon_cfgs(2);
5041         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5042         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5043         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5044
5045         // Create some initial channels
5046         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5047
5048         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5049         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5050         assert_eq!(revoked_local_txn[0].input.len(), 1);
5051         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5052
5053         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5054
5055         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5056         check_closed_broadcast!(nodes[1], true);
5057         check_added_monitors!(nodes[1], 1);
5058
5059         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5060         assert_eq!(node_txn.len(), 2);
5061         assert_eq!(node_txn[0].input.len(), 2);
5062         check_spends!(node_txn[0], revoked_local_txn[0]);
5063
5064         mine_transaction(&nodes[1], &node_txn[0]);
5065         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5066
5067         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5068         assert_eq!(spend_txn.len(), 1);
5069         check_spends!(spend_txn[0], node_txn[0]);
5070 }
5071
5072 #[test]
5073 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5074         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5075         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5076         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5077         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5078         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5079
5080         // Create some initial channels
5081         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5082
5083         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5084         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5085         assert_eq!(revoked_local_txn[0].input.len(), 1);
5086         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5087
5088         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5089
5090         // A will generate HTLC-Timeout from revoked commitment tx
5091         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5092         check_closed_broadcast!(nodes[0], true);
5093         check_added_monitors!(nodes[0], 1);
5094         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5095
5096         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5097         assert_eq!(revoked_htlc_txn.len(), 2);
5098         check_spends!(revoked_htlc_txn[0], chan_1.3);
5099         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5100         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5101         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5102         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5103
5104         // B will generate justice tx from A's revoked commitment/HTLC tx
5105         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5106         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5107         check_closed_broadcast!(nodes[1], true);
5108         check_added_monitors!(nodes[1], 1);
5109
5110         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5111         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5112         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5113         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5114         // transactions next...
5115         assert_eq!(node_txn[0].input.len(), 3);
5116         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5117
5118         assert_eq!(node_txn[1].input.len(), 2);
5119         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5120         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5121                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5122         } else {
5123                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5124                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5125         }
5126
5127         assert_eq!(node_txn[2].input.len(), 1);
5128         check_spends!(node_txn[2], chan_1.3);
5129
5130         mine_transaction(&nodes[1], &node_txn[1]);
5131         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5132
5133         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5134         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5135         assert_eq!(spend_txn.len(), 1);
5136         assert_eq!(spend_txn[0].input.len(), 1);
5137         check_spends!(spend_txn[0], node_txn[1]);
5138 }
5139
5140 #[test]
5141 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5142         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5143         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5144         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5145         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5146         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5147
5148         // Create some initial channels
5149         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5150
5151         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5152         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5153         assert_eq!(revoked_local_txn[0].input.len(), 1);
5154         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5155
5156         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5157         assert_eq!(revoked_local_txn[0].output.len(), 2);
5158
5159         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5160
5161         // B will generate HTLC-Success from revoked commitment tx
5162         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5163         check_closed_broadcast!(nodes[1], true);
5164         check_added_monitors!(nodes[1], 1);
5165         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5166
5167         assert_eq!(revoked_htlc_txn.len(), 2);
5168         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5169         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5170         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5171
5172         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5173         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5174         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5175
5176         // A will generate justice tx from B's revoked commitment/HTLC tx
5177         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5178         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5179         check_closed_broadcast!(nodes[0], true);
5180         check_added_monitors!(nodes[0], 1);
5181
5182         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5183         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5184
5185         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5186         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5187         // transactions next...
5188         assert_eq!(node_txn[0].input.len(), 2);
5189         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5190         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5191                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5192         } else {
5193                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5194                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5195         }
5196
5197         assert_eq!(node_txn[1].input.len(), 1);
5198         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5199
5200         check_spends!(node_txn[2], chan_1.3);
5201
5202         mine_transaction(&nodes[0], &node_txn[1]);
5203         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5204
5205         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5206         // didn't try to generate any new transactions.
5207
5208         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5209         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5210         assert_eq!(spend_txn.len(), 3);
5211         assert_eq!(spend_txn[0].input.len(), 1);
5212         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5213         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5214         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5215         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5216 }
5217
5218 #[test]
5219 fn test_onchain_to_onchain_claim() {
5220         // Test that in case of channel closure, we detect the state of output and claim HTLC
5221         // on downstream peer's remote commitment tx.
5222         // First, have C claim an HTLC against its own latest commitment transaction.
5223         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5224         // channel.
5225         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5226         // gets broadcast.
5227
5228         let chanmon_cfgs = create_chanmon_cfgs(3);
5229         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5230         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5231         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5232
5233         // Create some initial channels
5234         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5235         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5236
5237         // Ensure all nodes are at the same height
5238         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5239         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5240         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5241         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5242
5243         // Rebalance the network a bit by relaying one payment through all the channels ...
5244         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5245         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5246
5247         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5248         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5249         check_spends!(commitment_tx[0], chan_2.3);
5250         nodes[2].node.claim_funds(payment_preimage);
5251         check_added_monitors!(nodes[2], 1);
5252         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5253         assert!(updates.update_add_htlcs.is_empty());
5254         assert!(updates.update_fail_htlcs.is_empty());
5255         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5256         assert!(updates.update_fail_malformed_htlcs.is_empty());
5257
5258         mine_transaction(&nodes[2], &commitment_tx[0]);
5259         check_closed_broadcast!(nodes[2], true);
5260         check_added_monitors!(nodes[2], 1);
5261
5262         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5263         assert_eq!(c_txn.len(), 3);
5264         assert_eq!(c_txn[0], c_txn[2]);
5265         assert_eq!(commitment_tx[0], c_txn[1]);
5266         check_spends!(c_txn[1], chan_2.3);
5267         check_spends!(c_txn[2], c_txn[1]);
5268         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5269         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5270         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5271         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5272
5273         // 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
5274         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5275         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5276         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5277         {
5278                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5279                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5280                 assert_eq!(b_txn.len(), 2);
5281                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5282                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5283                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5284                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5285                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5286                 b_txn.clear();
5287         }
5288         check_added_monitors!(nodes[1], 1);
5289         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5290         assert_eq!(msg_events.len(), 3);
5291         check_added_monitors!(nodes[1], 1);
5292         match msg_events[0] {
5293                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5294                 _ => panic!("Unexpected event"),
5295         }
5296         match msg_events[1] {
5297                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5298                 _ => panic!("Unexpected event"),
5299         }
5300         match msg_events[2] {
5301                 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, .. } } => {
5302                         assert!(update_add_htlcs.is_empty());
5303                         assert!(update_fail_htlcs.is_empty());
5304                         assert_eq!(update_fulfill_htlcs.len(), 1);
5305                         assert!(update_fail_malformed_htlcs.is_empty());
5306                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5307                 },
5308                 _ => panic!("Unexpected event"),
5309         };
5310         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5311         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5312         mine_transaction(&nodes[1], &commitment_tx[0]);
5313         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5314         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5315         assert_eq!(b_txn.len(), 4);
5316         check_spends!(b_txn[2], chan_1.3);
5317         check_spends!(b_txn[3], b_txn[2]);
5318         let (htlc_success_claim, htlc_timeout_bumped) =
5319                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5320                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5321         check_spends!(htlc_success_claim, commitment_tx[0]);
5322         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5323         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5324         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5325         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5326         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5327
5328         check_closed_broadcast!(nodes[1], true);
5329         check_added_monitors!(nodes[1], 1);
5330 }
5331
5332 #[test]
5333 fn test_duplicate_payment_hash_one_failure_one_success() {
5334         // Topology : A --> B --> C --> D
5335         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5336         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5337         // we forward one of the payments onwards to D.
5338         let chanmon_cfgs = create_chanmon_cfgs(4);
5339         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5340         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5341         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5342
5343         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5344         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5345         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5346
5347         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5348         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5349         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5350         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5351         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5352
5353         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5354
5355         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5356         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5357         // script push size limit so that the below script length checks match
5358         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5359         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5360                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5361         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5362
5363         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5364         assert_eq!(commitment_txn[0].input.len(), 1);
5365         check_spends!(commitment_txn[0], chan_2.3);
5366
5367         mine_transaction(&nodes[1], &commitment_txn[0]);
5368         check_closed_broadcast!(nodes[1], true);
5369         check_added_monitors!(nodes[1], 1);
5370         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5371
5372         let htlc_timeout_tx;
5373         { // Extract one of the two HTLC-Timeout transaction
5374                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5375                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5376                 assert_eq!(node_txn.len(), 4);
5377                 check_spends!(node_txn[0], chan_2.3);
5378
5379                 check_spends!(node_txn[1], commitment_txn[0]);
5380                 assert_eq!(node_txn[1].input.len(), 1);
5381                 check_spends!(node_txn[2], commitment_txn[0]);
5382                 assert_eq!(node_txn[2].input.len(), 1);
5383                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5384                 check_spends!(node_txn[3], commitment_txn[0]);
5385                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5386
5387                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5388                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5389                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5390                 htlc_timeout_tx = node_txn[1].clone();
5391         }
5392
5393         nodes[2].node.claim_funds(our_payment_preimage);
5394         mine_transaction(&nodes[2], &commitment_txn[0]);
5395         check_added_monitors!(nodes[2], 2);
5396         let events = nodes[2].node.get_and_clear_pending_msg_events();
5397         match events[0] {
5398                 MessageSendEvent::UpdateHTLCs { .. } => {},
5399                 _ => panic!("Unexpected event"),
5400         }
5401         match events[1] {
5402                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5403                 _ => panic!("Unexepected event"),
5404         }
5405         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5406         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)
5407         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5408         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5409         assert_eq!(htlc_success_txn[0].input.len(), 1);
5410         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5411         assert_eq!(htlc_success_txn[1].input.len(), 1);
5412         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5413         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5414         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5415         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5416         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5417         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5418
5419         mine_transaction(&nodes[1], &htlc_timeout_tx);
5420         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5421         expect_pending_htlcs_forwardable!(nodes[1]);
5422         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5423         assert!(htlc_updates.update_add_htlcs.is_empty());
5424         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5425         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5426         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5427         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5428         check_added_monitors!(nodes[1], 1);
5429
5430         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5431         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5432         {
5433                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5434                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5435         }
5436         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5437
5438         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5439         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5440         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5441         assert!(updates.update_add_htlcs.is_empty());
5442         assert!(updates.update_fail_htlcs.is_empty());
5443         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5444         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5445         assert!(updates.update_fail_malformed_htlcs.is_empty());
5446         check_added_monitors!(nodes[1], 1);
5447
5448         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5449         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5450
5451         let events = nodes[0].node.get_and_clear_pending_events();
5452         match events[0] {
5453                 Event::PaymentSent { ref payment_preimage } => {
5454                         assert_eq!(*payment_preimage, our_payment_preimage);
5455                 }
5456                 _ => panic!("Unexpected event"),
5457         }
5458 }
5459
5460 #[test]
5461 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5462         let chanmon_cfgs = create_chanmon_cfgs(2);
5463         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5464         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5465         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5466
5467         // Create some initial channels
5468         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5469
5470         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5471         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5472         assert_eq!(local_txn.len(), 1);
5473         assert_eq!(local_txn[0].input.len(), 1);
5474         check_spends!(local_txn[0], chan_1.3);
5475
5476         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5477         nodes[1].node.claim_funds(payment_preimage);
5478         check_added_monitors!(nodes[1], 1);
5479         mine_transaction(&nodes[1], &local_txn[0]);
5480         check_added_monitors!(nodes[1], 1);
5481         let events = nodes[1].node.get_and_clear_pending_msg_events();
5482         match events[0] {
5483                 MessageSendEvent::UpdateHTLCs { .. } => {},
5484                 _ => panic!("Unexpected event"),
5485         }
5486         match events[1] {
5487                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5488                 _ => panic!("Unexepected event"),
5489         }
5490         let node_tx = {
5491                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5492                 assert_eq!(node_txn.len(), 3);
5493                 assert_eq!(node_txn[0], node_txn[2]);
5494                 assert_eq!(node_txn[1], local_txn[0]);
5495                 assert_eq!(node_txn[0].input.len(), 1);
5496                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5497                 check_spends!(node_txn[0], local_txn[0]);
5498                 node_txn[0].clone()
5499         };
5500
5501         mine_transaction(&nodes[1], &node_tx);
5502         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5503
5504         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5505         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5506         assert_eq!(spend_txn.len(), 1);
5507         assert_eq!(spend_txn[0].input.len(), 1);
5508         check_spends!(spend_txn[0], node_tx);
5509         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5510 }
5511
5512 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5513         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5514         // unrevoked commitment transaction.
5515         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5516         // a remote RAA before they could be failed backwards (and combinations thereof).
5517         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5518         // use the same payment hashes.
5519         // Thus, we use a six-node network:
5520         //
5521         // A \         / E
5522         //    - C - D -
5523         // B /         \ F
5524         // And test where C fails back to A/B when D announces its latest commitment transaction
5525         let chanmon_cfgs = create_chanmon_cfgs(6);
5526         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5527         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5528         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5529         let logger = test_utils::TestLogger::new();
5530
5531         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5532         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5533         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5534         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5535         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5536
5537         // Rebalance and check output sanity...
5538         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5539         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5540         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5541
5542         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5543         // 0th HTLC:
5544         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
5545         // 1st HTLC:
5546         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
5547         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5548         let our_node_id = &nodes[1].node.get_our_node_id();
5549         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();
5550         // 2nd HTLC:
5551         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
5552         // 3rd HTLC:
5553         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
5554         // 4th HTLC:
5555         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5556         // 5th HTLC:
5557         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5558         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();
5559         // 6th HTLC:
5560         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());
5561         // 7th HTLC:
5562         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());
5563
5564         // 8th HTLC:
5565         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5566         // 9th HTLC:
5567         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();
5568         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
5569
5570         // 10th HTLC:
5571         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
5572         // 11th HTLC:
5573         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();
5574         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());
5575
5576         // Double-check that six of the new HTLC were added
5577         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5578         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5579         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5580         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5581
5582         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5583         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5584         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5585         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5586         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5587         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5588         check_added_monitors!(nodes[4], 0);
5589         expect_pending_htlcs_forwardable!(nodes[4]);
5590         check_added_monitors!(nodes[4], 1);
5591
5592         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5593         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5594         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5595         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5596         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5597         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5598
5599         // Fail 3rd below-dust and 7th above-dust HTLCs
5600         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5601         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5602         check_added_monitors!(nodes[5], 0);
5603         expect_pending_htlcs_forwardable!(nodes[5]);
5604         check_added_monitors!(nodes[5], 1);
5605
5606         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5607         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5608         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5609         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5610
5611         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5612
5613         expect_pending_htlcs_forwardable!(nodes[3]);
5614         check_added_monitors!(nodes[3], 1);
5615         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5616         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5617         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5618         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5619         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5620         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5621         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5622         if deliver_last_raa {
5623                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5624         } else {
5625                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5626         }
5627
5628         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5629         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5630         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5631         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5632         //
5633         // We now broadcast the latest commitment transaction, which *should* result in failures for
5634         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5635         // the non-broadcast above-dust HTLCs.
5636         //
5637         // Alternatively, we may broadcast the previous commitment transaction, which should only
5638         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5639         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5640
5641         if announce_latest {
5642                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5643         } else {
5644                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5645         }
5646         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5647         check_closed_broadcast!(nodes[2], true);
5648         expect_pending_htlcs_forwardable!(nodes[2]);
5649         check_added_monitors!(nodes[2], 3);
5650
5651         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5652         assert_eq!(cs_msgs.len(), 2);
5653         let mut a_done = false;
5654         for msg in cs_msgs {
5655                 match msg {
5656                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5657                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5658                                 // should be failed-backwards here.
5659                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5660                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5661                                         for htlc in &updates.update_fail_htlcs {
5662                                                 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 });
5663                                         }
5664                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5665                                         assert!(!a_done);
5666                                         a_done = true;
5667                                         &nodes[0]
5668                                 } else {
5669                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5670                                         for htlc in &updates.update_fail_htlcs {
5671                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5672                                         }
5673                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5674                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5675                                         &nodes[1]
5676                                 };
5677                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5678                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5679                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5680                                 if announce_latest {
5681                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5682                                         if *node_id == nodes[0].node.get_our_node_id() {
5683                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5684                                         }
5685                                 }
5686                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5687                         },
5688                         _ => panic!("Unexpected event"),
5689                 }
5690         }
5691
5692         let as_events = nodes[0].node.get_and_clear_pending_events();
5693         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5694         let mut as_failds = HashSet::new();
5695         for event in as_events.iter() {
5696                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5697                         assert!(as_failds.insert(*payment_hash));
5698                         if *payment_hash != payment_hash_2 {
5699                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5700                         } else {
5701                                 assert!(!rejected_by_dest);
5702                         }
5703                 } else { panic!("Unexpected event"); }
5704         }
5705         assert!(as_failds.contains(&payment_hash_1));
5706         assert!(as_failds.contains(&payment_hash_2));
5707         if announce_latest {
5708                 assert!(as_failds.contains(&payment_hash_3));
5709                 assert!(as_failds.contains(&payment_hash_5));
5710         }
5711         assert!(as_failds.contains(&payment_hash_6));
5712
5713         let bs_events = nodes[1].node.get_and_clear_pending_events();
5714         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5715         let mut bs_failds = HashSet::new();
5716         for event in bs_events.iter() {
5717                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5718                         assert!(bs_failds.insert(*payment_hash));
5719                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5720                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5721                         } else {
5722                                 assert!(!rejected_by_dest);
5723                         }
5724                 } else { panic!("Unexpected event"); }
5725         }
5726         assert!(bs_failds.contains(&payment_hash_1));
5727         assert!(bs_failds.contains(&payment_hash_2));
5728         if announce_latest {
5729                 assert!(bs_failds.contains(&payment_hash_4));
5730         }
5731         assert!(bs_failds.contains(&payment_hash_5));
5732
5733         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5734         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5735         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5736         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5737         // PaymentFailureNetworkUpdates.
5738         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5739         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5740         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5741         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5742         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5743                 match event {
5744                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5745                         _ => panic!("Unexpected event"),
5746                 }
5747         }
5748 }
5749
5750 #[test]
5751 fn test_fail_backwards_latest_remote_announce_a() {
5752         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5753 }
5754
5755 #[test]
5756 fn test_fail_backwards_latest_remote_announce_b() {
5757         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5758 }
5759
5760 #[test]
5761 fn test_fail_backwards_previous_remote_announce() {
5762         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5763         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5764         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5765 }
5766
5767 #[test]
5768 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5769         let chanmon_cfgs = create_chanmon_cfgs(2);
5770         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5771         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5772         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5773
5774         // Create some initial channels
5775         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5776
5777         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5778         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5779         assert_eq!(local_txn[0].input.len(), 1);
5780         check_spends!(local_txn[0], chan_1.3);
5781
5782         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5783         mine_transaction(&nodes[0], &local_txn[0]);
5784         check_closed_broadcast!(nodes[0], true);
5785         check_added_monitors!(nodes[0], 1);
5786         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5787
5788         let htlc_timeout = {
5789                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5790                 assert_eq!(node_txn.len(), 2);
5791                 check_spends!(node_txn[0], chan_1.3);
5792                 assert_eq!(node_txn[1].input.len(), 1);
5793                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5794                 check_spends!(node_txn[1], local_txn[0]);
5795                 node_txn[1].clone()
5796         };
5797
5798         mine_transaction(&nodes[0], &htlc_timeout);
5799         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5800         expect_payment_failed!(nodes[0], our_payment_hash, true);
5801
5802         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5803         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5804         assert_eq!(spend_txn.len(), 3);
5805         check_spends!(spend_txn[0], local_txn[0]);
5806         assert_eq!(spend_txn[1].input.len(), 1);
5807         check_spends!(spend_txn[1], htlc_timeout);
5808         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5809         assert_eq!(spend_txn[2].input.len(), 2);
5810         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5811         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5812                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5813 }
5814
5815 #[test]
5816 fn test_key_derivation_params() {
5817         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5818         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5819         // let us re-derive the channel key set to then derive a delayed_payment_key.
5820
5821         let chanmon_cfgs = create_chanmon_cfgs(3);
5822
5823         // We manually create the node configuration to backup the seed.
5824         let seed = [42; 32];
5825         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5826         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);
5827         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 };
5828         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5829         node_cfgs.remove(0);
5830         node_cfgs.insert(0, node);
5831
5832         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5833         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5834
5835         // Create some initial channels
5836         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5837         // for node 0
5838         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5839         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5840         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5841
5842         // Ensure all nodes are at the same height
5843         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5844         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5845         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5846         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5847
5848         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5849         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5850         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5851         assert_eq!(local_txn_1[0].input.len(), 1);
5852         check_spends!(local_txn_1[0], chan_1.3);
5853
5854         // We check funding pubkey are unique
5855         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]));
5856         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]));
5857         if from_0_funding_key_0 == from_1_funding_key_0
5858             || from_0_funding_key_0 == from_1_funding_key_1
5859             || from_0_funding_key_1 == from_1_funding_key_0
5860             || from_0_funding_key_1 == from_1_funding_key_1 {
5861                 panic!("Funding pubkeys aren't unique");
5862         }
5863
5864         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5865         mine_transaction(&nodes[0], &local_txn_1[0]);
5866         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5867         check_closed_broadcast!(nodes[0], true);
5868         check_added_monitors!(nodes[0], 1);
5869
5870         let htlc_timeout = {
5871                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5872                 assert_eq!(node_txn[1].input.len(), 1);
5873                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5874                 check_spends!(node_txn[1], local_txn_1[0]);
5875                 node_txn[1].clone()
5876         };
5877
5878         mine_transaction(&nodes[0], &htlc_timeout);
5879         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5880         expect_payment_failed!(nodes[0], our_payment_hash, true);
5881
5882         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5883         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5884         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5885         assert_eq!(spend_txn.len(), 3);
5886         check_spends!(spend_txn[0], local_txn_1[0]);
5887         assert_eq!(spend_txn[1].input.len(), 1);
5888         check_spends!(spend_txn[1], htlc_timeout);
5889         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5890         assert_eq!(spend_txn[2].input.len(), 2);
5891         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5892         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5893                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5894 }
5895
5896 #[test]
5897 fn test_static_output_closing_tx() {
5898         let chanmon_cfgs = create_chanmon_cfgs(2);
5899         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5900         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5901         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5902
5903         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5904
5905         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5906         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5907
5908         mine_transaction(&nodes[0], &closing_tx);
5909         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5910
5911         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5912         assert_eq!(spend_txn.len(), 1);
5913         check_spends!(spend_txn[0], closing_tx);
5914
5915         mine_transaction(&nodes[1], &closing_tx);
5916         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5917
5918         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5919         assert_eq!(spend_txn.len(), 1);
5920         check_spends!(spend_txn[0], closing_tx);
5921 }
5922
5923 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5924         let chanmon_cfgs = create_chanmon_cfgs(2);
5925         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5926         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5927         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5928         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5929
5930         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5931
5932         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5933         // present in B's local commitment transaction, but none of A's commitment transactions.
5934         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5935         check_added_monitors!(nodes[1], 1);
5936
5937         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5938         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5939         let events = nodes[0].node.get_and_clear_pending_events();
5940         assert_eq!(events.len(), 1);
5941         match events[0] {
5942                 Event::PaymentSent { payment_preimage } => {
5943                         assert_eq!(payment_preimage, our_payment_preimage);
5944                 },
5945                 _ => panic!("Unexpected event"),
5946         }
5947
5948         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5949         check_added_monitors!(nodes[0], 1);
5950         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5951         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5952         check_added_monitors!(nodes[1], 1);
5953
5954         let starting_block = nodes[1].best_block_info();
5955         let mut block = Block {
5956                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5957                 txdata: vec![],
5958         };
5959         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5960                 connect_block(&nodes[1], &block);
5961                 block.header.prev_blockhash = block.block_hash();
5962         }
5963         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5964         check_closed_broadcast!(nodes[1], true);
5965         check_added_monitors!(nodes[1], 1);
5966 }
5967
5968 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5969         let chanmon_cfgs = create_chanmon_cfgs(2);
5970         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5971         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5972         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5973         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5974         let logger = test_utils::TestLogger::new();
5975
5976         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5977         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5978         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();
5979         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5980         check_added_monitors!(nodes[0], 1);
5981
5982         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5983
5984         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5985         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5986         // to "time out" the HTLC.
5987
5988         let starting_block = nodes[1].best_block_info();
5989         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5990
5991         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5992                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5993                 header.prev_blockhash = header.block_hash();
5994         }
5995         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5996         check_closed_broadcast!(nodes[0], true);
5997         check_added_monitors!(nodes[0], 1);
5998 }
5999
6000 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6001         let chanmon_cfgs = create_chanmon_cfgs(3);
6002         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6003         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6004         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6005         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6006
6007         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6008         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6009         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6010         // actually revoked.
6011         let htlc_value = if use_dust { 50000 } else { 3000000 };
6012         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6013         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6014         expect_pending_htlcs_forwardable!(nodes[1]);
6015         check_added_monitors!(nodes[1], 1);
6016
6017         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6018         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6019         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6020         check_added_monitors!(nodes[0], 1);
6021         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6022         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6023         check_added_monitors!(nodes[1], 1);
6024         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6025         check_added_monitors!(nodes[1], 1);
6026         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6027
6028         if check_revoke_no_close {
6029                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6030                 check_added_monitors!(nodes[0], 1);
6031         }
6032
6033         let starting_block = nodes[1].best_block_info();
6034         let mut block = Block {
6035                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6036                 txdata: vec![],
6037         };
6038         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6039                 connect_block(&nodes[0], &block);
6040                 block.header.prev_blockhash = block.block_hash();
6041         }
6042         if !check_revoke_no_close {
6043                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6044                 check_closed_broadcast!(nodes[0], true);
6045                 check_added_monitors!(nodes[0], 1);
6046         } else {
6047                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6048         }
6049 }
6050
6051 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6052 // There are only a few cases to test here:
6053 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6054 //    broadcastable commitment transactions result in channel closure,
6055 //  * its included in an unrevoked-but-previous remote commitment transaction,
6056 //  * its included in the latest remote or local commitment transactions.
6057 // We test each of the three possible commitment transactions individually and use both dust and
6058 // non-dust HTLCs.
6059 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6060 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6061 // tested for at least one of the cases in other tests.
6062 #[test]
6063 fn htlc_claim_single_commitment_only_a() {
6064         do_htlc_claim_local_commitment_only(true);
6065         do_htlc_claim_local_commitment_only(false);
6066
6067         do_htlc_claim_current_remote_commitment_only(true);
6068         do_htlc_claim_current_remote_commitment_only(false);
6069 }
6070
6071 #[test]
6072 fn htlc_claim_single_commitment_only_b() {
6073         do_htlc_claim_previous_remote_commitment_only(true, false);
6074         do_htlc_claim_previous_remote_commitment_only(false, false);
6075         do_htlc_claim_previous_remote_commitment_only(true, true);
6076         do_htlc_claim_previous_remote_commitment_only(false, true);
6077 }
6078
6079 #[test]
6080 #[should_panic]
6081 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6082         let chanmon_cfgs = create_chanmon_cfgs(2);
6083         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6084         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6085         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6086         //Force duplicate channel ids
6087         for node in nodes.iter() {
6088                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6089         }
6090
6091         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6092         let channel_value_satoshis=10000;
6093         let push_msat=10001;
6094         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6095         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6096         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6097
6098         //Create a second channel with a channel_id collision
6099         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6100 }
6101
6102 #[test]
6103 fn bolt2_open_channel_sending_node_checks_part2() {
6104         let chanmon_cfgs = create_chanmon_cfgs(2);
6105         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6106         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6107         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6108
6109         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6110         let channel_value_satoshis=2^24;
6111         let push_msat=10001;
6112         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6113
6114         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6115         let channel_value_satoshis=10000;
6116         // Test when push_msat is equal to 1000 * funding_satoshis.
6117         let push_msat=1000*channel_value_satoshis+1;
6118         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6119
6120         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6121         let channel_value_satoshis=10000;
6122         let push_msat=10001;
6123         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
6124         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6125         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6126
6127         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6128         // 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
6129         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6130
6131         // 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.
6132         assert!(BREAKDOWN_TIMEOUT>0);
6133         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6134
6135         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6136         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6137         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6138
6139         // 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.
6140         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6141         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6142         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6143         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6144         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6145 }
6146
6147 #[test]
6148 fn bolt2_open_channel_sane_dust_limit() {
6149         let chanmon_cfgs = create_chanmon_cfgs(2);
6150         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6151         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6152         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6153
6154         let channel_value_satoshis=1000000;
6155         let push_msat=10001;
6156         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6157         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6158         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6159         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6160
6161         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6162         let events = nodes[1].node.get_and_clear_pending_msg_events();
6163         let err_msg = match events[0] {
6164                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6165                         msg.clone()
6166                 },
6167                 _ => panic!("Unexpected event"),
6168         };
6169         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6170 }
6171
6172 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6173 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6174 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6175 // is no longer affordable once it's freed.
6176 #[test]
6177 fn test_fail_holding_cell_htlc_upon_free() {
6178         let chanmon_cfgs = create_chanmon_cfgs(2);
6179         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6180         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6181         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6182         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6183         let logger = test_utils::TestLogger::new();
6184
6185         // First nodes[0] generates an update_fee, setting the channel's
6186         // pending_update_fee.
6187         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6188         check_added_monitors!(nodes[0], 1);
6189
6190         let events = nodes[0].node.get_and_clear_pending_msg_events();
6191         assert_eq!(events.len(), 1);
6192         let (update_msg, commitment_signed) = match events[0] {
6193                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6194                         (update_fee.as_ref(), commitment_signed)
6195                 },
6196                 _ => panic!("Unexpected event"),
6197         };
6198
6199         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6200
6201         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6202         let channel_reserve = chan_stat.channel_reserve_msat;
6203         let feerate = get_feerate!(nodes[0], chan.2);
6204
6205         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6206         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6207         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6208         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6209         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();
6210
6211         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6212         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6213         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6214         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6215
6216         // Flush the pending fee update.
6217         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6218         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6219         check_added_monitors!(nodes[1], 1);
6220         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6221         check_added_monitors!(nodes[0], 1);
6222
6223         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6224         // HTLC, but now that the fee has been raised the payment will now fail, causing
6225         // us to surface its failure to the user.
6226         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6227         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6228         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 1 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6229         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 ({}) in channel {}",
6230                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6231         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6232
6233         // Check that the payment failed to be sent out.
6234         let events = nodes[0].node.get_and_clear_pending_events();
6235         assert_eq!(events.len(), 1);
6236         match &events[0] {
6237                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6238                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6239                         assert_eq!(*rejected_by_dest, false);
6240                         assert_eq!(*error_code, None);
6241                         assert_eq!(*error_data, None);
6242                 },
6243                 _ => panic!("Unexpected event"),
6244         }
6245 }
6246
6247 // Test that if multiple HTLCs are released from the holding cell and one is
6248 // valid but the other is no longer valid upon release, the valid HTLC can be
6249 // successfully completed while the other one fails as expected.
6250 #[test]
6251 fn test_free_and_fail_holding_cell_htlcs() {
6252         let chanmon_cfgs = create_chanmon_cfgs(2);
6253         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6254         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6255         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6256         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6257         let logger = test_utils::TestLogger::new();
6258
6259         // First nodes[0] generates an update_fee, setting the channel's
6260         // pending_update_fee.
6261         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6262         check_added_monitors!(nodes[0], 1);
6263
6264         let events = nodes[0].node.get_and_clear_pending_msg_events();
6265         assert_eq!(events.len(), 1);
6266         let (update_msg, commitment_signed) = match events[0] {
6267                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6268                         (update_fee.as_ref(), commitment_signed)
6269                 },
6270                 _ => panic!("Unexpected event"),
6271         };
6272
6273         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6274
6275         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6276         let channel_reserve = chan_stat.channel_reserve_msat;
6277         let feerate = get_feerate!(nodes[0], chan.2);
6278
6279         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6280         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6281         let amt_1 = 20000;
6282         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6283         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6284         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6285         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();
6286         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();
6287
6288         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6289         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6290         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6291         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6292         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6293         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6294         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6295
6296         // Flush the pending fee update.
6297         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6298         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6299         check_added_monitors!(nodes[1], 1);
6300         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6301         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6302         check_added_monitors!(nodes[0], 2);
6303
6304         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6305         // but now that the fee has been raised the second payment will now fail, causing us
6306         // to surface its failure to the user. The first payment should succeed.
6307         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6308         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6309         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 2 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6310         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 ({}) in channel {}",
6311                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6312         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6313
6314         // Check that the second payment failed to be sent out.
6315         let events = nodes[0].node.get_and_clear_pending_events();
6316         assert_eq!(events.len(), 1);
6317         match &events[0] {
6318                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6319                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6320                         assert_eq!(*rejected_by_dest, false);
6321                         assert_eq!(*error_code, None);
6322                         assert_eq!(*error_data, None);
6323                 },
6324                 _ => panic!("Unexpected event"),
6325         }
6326
6327         // Complete the first payment and the RAA from the fee update.
6328         let (payment_event, send_raa_event) = {
6329                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6330                 assert_eq!(msgs.len(), 2);
6331                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6332         };
6333         let raa = match send_raa_event {
6334                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6335                 _ => panic!("Unexpected event"),
6336         };
6337         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6338         check_added_monitors!(nodes[1], 1);
6339         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6340         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6341         let events = nodes[1].node.get_and_clear_pending_events();
6342         assert_eq!(events.len(), 1);
6343         match events[0] {
6344                 Event::PendingHTLCsForwardable { .. } => {},
6345                 _ => panic!("Unexpected event"),
6346         }
6347         nodes[1].node.process_pending_htlc_forwards();
6348         let events = nodes[1].node.get_and_clear_pending_events();
6349         assert_eq!(events.len(), 1);
6350         match events[0] {
6351                 Event::PaymentReceived { .. } => {},
6352                 _ => panic!("Unexpected event"),
6353         }
6354         nodes[1].node.claim_funds(payment_preimage_1);
6355         check_added_monitors!(nodes[1], 1);
6356         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6357         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6358         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6359         let events = nodes[0].node.get_and_clear_pending_events();
6360         assert_eq!(events.len(), 1);
6361         match events[0] {
6362                 Event::PaymentSent { ref payment_preimage } => {
6363                         assert_eq!(*payment_preimage, payment_preimage_1);
6364                 }
6365                 _ => panic!("Unexpected event"),
6366         }
6367 }
6368
6369 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6370 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6371 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6372 // once it's freed.
6373 #[test]
6374 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6375         let chanmon_cfgs = create_chanmon_cfgs(3);
6376         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6377         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6378         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6379         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6380         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6381         let logger = test_utils::TestLogger::new();
6382
6383         // First nodes[1] generates an update_fee, setting the channel's
6384         // pending_update_fee.
6385         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6386         check_added_monitors!(nodes[1], 1);
6387
6388         let events = nodes[1].node.get_and_clear_pending_msg_events();
6389         assert_eq!(events.len(), 1);
6390         let (update_msg, commitment_signed) = match events[0] {
6391                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6392                         (update_fee.as_ref(), commitment_signed)
6393                 },
6394                 _ => panic!("Unexpected event"),
6395         };
6396
6397         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6398
6399         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6400         let channel_reserve = chan_stat.channel_reserve_msat;
6401         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6402
6403         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6404         let feemsat = 239;
6405         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6406         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6407         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6408         let payment_event = {
6409                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6410                 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();
6411                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6412                 check_added_monitors!(nodes[0], 1);
6413
6414                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6415                 assert_eq!(events.len(), 1);
6416
6417                 SendEvent::from_event(events.remove(0))
6418         };
6419         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6420         check_added_monitors!(nodes[1], 0);
6421         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6422         expect_pending_htlcs_forwardable!(nodes[1]);
6423
6424         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6425         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6426
6427         // Flush the pending fee update.
6428         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6429         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6430         check_added_monitors!(nodes[2], 1);
6431         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6432         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6433         check_added_monitors!(nodes[1], 2);
6434
6435         // A final RAA message is generated to finalize the fee update.
6436         let events = nodes[1].node.get_and_clear_pending_msg_events();
6437         assert_eq!(events.len(), 1);
6438
6439         let raa_msg = match &events[0] {
6440                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6441                         msg.clone()
6442                 },
6443                 _ => panic!("Unexpected event"),
6444         };
6445
6446         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6447         check_added_monitors!(nodes[2], 1);
6448         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6449
6450         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6451         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6452         assert_eq!(process_htlc_forwards_event.len(), 1);
6453         match &process_htlc_forwards_event[0] {
6454                 &Event::PendingHTLCsForwardable { .. } => {},
6455                 _ => panic!("Unexpected event"),
6456         }
6457
6458         // In response, we call ChannelManager's process_pending_htlc_forwards
6459         nodes[1].node.process_pending_htlc_forwards();
6460         check_added_monitors!(nodes[1], 1);
6461
6462         // This causes the HTLC to be failed backwards.
6463         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6464         assert_eq!(fail_event.len(), 1);
6465         let (fail_msg, commitment_signed) = match &fail_event[0] {
6466                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6467                         assert_eq!(updates.update_add_htlcs.len(), 0);
6468                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6469                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6470                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6471                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6472                 },
6473                 _ => panic!("Unexpected event"),
6474         };
6475
6476         // Pass the failure messages back to nodes[0].
6477         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6478         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6479
6480         // Complete the HTLC failure+removal process.
6481         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6482         check_added_monitors!(nodes[0], 1);
6483         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6484         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6485         check_added_monitors!(nodes[1], 2);
6486         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6487         assert_eq!(final_raa_event.len(), 1);
6488         let raa = match &final_raa_event[0] {
6489                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6490                 _ => panic!("Unexpected event"),
6491         };
6492         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6493         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6494         expect_payment_failed!(nodes[0], our_payment_hash, false);
6495         check_added_monitors!(nodes[0], 1);
6496 }
6497
6498 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6499 // 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.
6500 //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.
6501
6502 #[test]
6503 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6504         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6505         let chanmon_cfgs = create_chanmon_cfgs(2);
6506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6508         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6509         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6510
6511         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6512         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6513         let logger = test_utils::TestLogger::new();
6514         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();
6515         route.paths[0][0].fee_msat = 100;
6516
6517         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6518                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6519         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6520         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6521 }
6522
6523 #[test]
6524 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6525         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6526         let chanmon_cfgs = create_chanmon_cfgs(2);
6527         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6528         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6529         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6530         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6531         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6532
6533         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6534         let logger = test_utils::TestLogger::new();
6535         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();
6536         route.paths[0][0].fee_msat = 0;
6537         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6538                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6539
6540         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6541         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6542 }
6543
6544 #[test]
6545 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6546         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6547         let chanmon_cfgs = create_chanmon_cfgs(2);
6548         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6549         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6550         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6551         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6552
6553         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6554         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6555         let logger = test_utils::TestLogger::new();
6556         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();
6557         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6558         check_added_monitors!(nodes[0], 1);
6559         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6560         updates.update_add_htlcs[0].amount_msat = 0;
6561
6562         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6563         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6564         check_closed_broadcast!(nodes[1], true).unwrap();
6565         check_added_monitors!(nodes[1], 1);
6566 }
6567
6568 #[test]
6569 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6570         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6571         //It is enforced when constructing a route.
6572         let chanmon_cfgs = create_chanmon_cfgs(2);
6573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6576         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6577         let logger = test_utils::TestLogger::new();
6578
6579         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6580
6581         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6582         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();
6583         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6584                 assert_eq!(err, &"Channel CLTV overflowed?"));
6585 }
6586
6587 #[test]
6588 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6589         //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.
6590         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6591         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
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, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6597         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6598
6599         let logger = test_utils::TestLogger::new();
6600         for i in 0..max_accepted_htlcs {
6601                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6602                 let payment_event = {
6603                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6604                         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();
6605                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6606                         check_added_monitors!(nodes[0], 1);
6607
6608                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6609                         assert_eq!(events.len(), 1);
6610                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6611                                 assert_eq!(htlcs[0].htlc_id, i);
6612                         } else {
6613                                 assert!(false);
6614                         }
6615                         SendEvent::from_event(events.remove(0))
6616                 };
6617                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6618                 check_added_monitors!(nodes[1], 0);
6619                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6620
6621                 expect_pending_htlcs_forwardable!(nodes[1]);
6622                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6623         }
6624         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6625         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6626         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();
6627         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6628                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6629
6630         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6631         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6632 }
6633
6634 #[test]
6635 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6636         //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.
6637         let chanmon_cfgs = create_chanmon_cfgs(2);
6638         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6639         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6640         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6641         let channel_value = 100000;
6642         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6643         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6644
6645         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6646
6647         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6648         // Manually create a route over our max in flight (which our router normally automatically
6649         // limits us to.
6650         let route = Route { paths: vec![vec![RouteHop {
6651            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6652            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6653            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6654         }]] };
6655         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6656                 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)));
6657
6658         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6659         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);
6660
6661         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6662 }
6663
6664 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6665 #[test]
6666 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6667         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6668         let chanmon_cfgs = create_chanmon_cfgs(2);
6669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6672         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6673         let htlc_minimum_msat: u64;
6674         {
6675                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6676                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6677                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6678         }
6679
6680         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6681         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6682         let logger = test_utils::TestLogger::new();
6683         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();
6684         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6685         check_added_monitors!(nodes[0], 1);
6686         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6687         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6688         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6689         assert!(nodes[1].node.list_channels().is_empty());
6690         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6691         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()));
6692         check_added_monitors!(nodes[1], 1);
6693 }
6694
6695 #[test]
6696 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6697         //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
6698         let chanmon_cfgs = create_chanmon_cfgs(2);
6699         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6700         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6701         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6702         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6703         let logger = test_utils::TestLogger::new();
6704
6705         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6706         let channel_reserve = chan_stat.channel_reserve_msat;
6707         let feerate = get_feerate!(nodes[0], chan.2);
6708         // The 2* and +1 are for the fee spike reserve.
6709         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6710
6711         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6712         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6713         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6714         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();
6715         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6716         check_added_monitors!(nodes[0], 1);
6717         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6718
6719         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6720         // at this time channel-initiatee receivers are not required to enforce that senders
6721         // respect the fee_spike_reserve.
6722         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
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_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6728         check_added_monitors!(nodes[1], 1);
6729 }
6730
6731 #[test]
6732 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6733         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6734         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
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 chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6740         let logger = test_utils::TestLogger::new();
6741
6742         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6743         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6744
6745         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6746         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();
6747
6748         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6749         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6750         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6751         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6752
6753         let mut msg = msgs::UpdateAddHTLC {
6754                 channel_id: chan.2,
6755                 htlc_id: 0,
6756                 amount_msat: 1000,
6757                 payment_hash: our_payment_hash,
6758                 cltv_expiry: htlc_cltv,
6759                 onion_routing_packet: onion_packet.clone(),
6760         };
6761
6762         for i in 0..super::channel::OUR_MAX_HTLCS {
6763                 msg.htlc_id = i as u64;
6764                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6765         }
6766         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6767         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6768
6769         assert!(nodes[1].node.list_channels().is_empty());
6770         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6771         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6772         check_added_monitors!(nodes[1], 1);
6773 }
6774
6775 #[test]
6776 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6777         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6778         let chanmon_cfgs = create_chanmon_cfgs(2);
6779         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6780         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6781         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6782         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6783         let logger = test_utils::TestLogger::new();
6784
6785         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6786         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6787         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();
6788         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6789         check_added_monitors!(nodes[0], 1);
6790         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6791         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6792         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6793
6794         assert!(nodes[1].node.list_channels().is_empty());
6795         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6796         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6797         check_added_monitors!(nodes[1], 1);
6798 }
6799
6800 #[test]
6801 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6802         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6803         let chanmon_cfgs = create_chanmon_cfgs(2);
6804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6806         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6807         let logger = test_utils::TestLogger::new();
6808
6809         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6810         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6811         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6812         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();
6813         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6814         check_added_monitors!(nodes[0], 1);
6815         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6816         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6817         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6818
6819         assert!(nodes[1].node.list_channels().is_empty());
6820         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6821         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6822         check_added_monitors!(nodes[1], 1);
6823 }
6824
6825 #[test]
6826 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6827         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6828         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6829         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6830         let chanmon_cfgs = create_chanmon_cfgs(2);
6831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6833         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6834         let logger = test_utils::TestLogger::new();
6835
6836         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6837         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6838         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6839         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6840         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6841         check_added_monitors!(nodes[0], 1);
6842         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6843         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6844
6845         //Disconnect and Reconnect
6846         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6847         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6848         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6849         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6850         assert_eq!(reestablish_1.len(), 1);
6851         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6852         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6853         assert_eq!(reestablish_2.len(), 1);
6854         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6855         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6856         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6857         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6858
6859         //Resend HTLC
6860         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6861         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6862         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6863         check_added_monitors!(nodes[1], 1);
6864         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6865
6866         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6867
6868         assert!(nodes[1].node.list_channels().is_empty());
6869         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6870         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6871         check_added_monitors!(nodes[1], 1);
6872 }
6873
6874 #[test]
6875 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6876         //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.
6877
6878         let chanmon_cfgs = create_chanmon_cfgs(2);
6879         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6880         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6881         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6882         let logger = test_utils::TestLogger::new();
6883         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6884         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6885         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6886         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();
6887         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6888
6889         check_added_monitors!(nodes[0], 1);
6890         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6891         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6892
6893         let update_msg = msgs::UpdateFulfillHTLC{
6894                 channel_id: chan.2,
6895                 htlc_id: 0,
6896                 payment_preimage: our_payment_preimage,
6897         };
6898
6899         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6900
6901         assert!(nodes[0].node.list_channels().is_empty());
6902         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6903         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()));
6904         check_added_monitors!(nodes[0], 1);
6905 }
6906
6907 #[test]
6908 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6909         //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.
6910
6911         let chanmon_cfgs = create_chanmon_cfgs(2);
6912         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6913         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6914         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6915         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6916         let logger = test_utils::TestLogger::new();
6917
6918         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6919         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6920         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();
6921         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6922         check_added_monitors!(nodes[0], 1);
6923         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6924         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6925
6926         let update_msg = msgs::UpdateFailHTLC{
6927                 channel_id: chan.2,
6928                 htlc_id: 0,
6929                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6930         };
6931
6932         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6933
6934         assert!(nodes[0].node.list_channels().is_empty());
6935         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6936         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()));
6937         check_added_monitors!(nodes[0], 1);
6938 }
6939
6940 #[test]
6941 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6942         //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.
6943
6944         let chanmon_cfgs = create_chanmon_cfgs(2);
6945         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6946         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6947         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6948         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6949         let logger = test_utils::TestLogger::new();
6950
6951         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6952         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6953         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();
6954         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6955         check_added_monitors!(nodes[0], 1);
6956         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6957         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6958         let update_msg = msgs::UpdateFailMalformedHTLC{
6959                 channel_id: chan.2,
6960                 htlc_id: 0,
6961                 sha256_of_onion: [1; 32],
6962                 failure_code: 0x8000,
6963         };
6964
6965         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6966
6967         assert!(nodes[0].node.list_channels().is_empty());
6968         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6969         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()));
6970         check_added_monitors!(nodes[0], 1);
6971 }
6972
6973 #[test]
6974 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6975         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6976
6977         let chanmon_cfgs = create_chanmon_cfgs(2);
6978         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6979         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6980         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6981         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6982
6983         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6984
6985         nodes[1].node.claim_funds(our_payment_preimage);
6986         check_added_monitors!(nodes[1], 1);
6987
6988         let events = nodes[1].node.get_and_clear_pending_msg_events();
6989         assert_eq!(events.len(), 1);
6990         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6991                 match events[0] {
6992                         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, .. } } => {
6993                                 assert!(update_add_htlcs.is_empty());
6994                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6995                                 assert!(update_fail_htlcs.is_empty());
6996                                 assert!(update_fail_malformed_htlcs.is_empty());
6997                                 assert!(update_fee.is_none());
6998                                 update_fulfill_htlcs[0].clone()
6999                         },
7000                         _ => panic!("Unexpected event"),
7001                 }
7002         };
7003
7004         update_fulfill_msg.htlc_id = 1;
7005
7006         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7007
7008         assert!(nodes[0].node.list_channels().is_empty());
7009         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7010         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7011         check_added_monitors!(nodes[0], 1);
7012 }
7013
7014 #[test]
7015 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7016         //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.
7017
7018         let chanmon_cfgs = create_chanmon_cfgs(2);
7019         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7020         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7021         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7022         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7023
7024         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7025
7026         nodes[1].node.claim_funds(our_payment_preimage);
7027         check_added_monitors!(nodes[1], 1);
7028
7029         let events = nodes[1].node.get_and_clear_pending_msg_events();
7030         assert_eq!(events.len(), 1);
7031         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7032                 match events[0] {
7033                         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, .. } } => {
7034                                 assert!(update_add_htlcs.is_empty());
7035                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7036                                 assert!(update_fail_htlcs.is_empty());
7037                                 assert!(update_fail_malformed_htlcs.is_empty());
7038                                 assert!(update_fee.is_none());
7039                                 update_fulfill_htlcs[0].clone()
7040                         },
7041                         _ => panic!("Unexpected event"),
7042                 }
7043         };
7044
7045         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7046
7047         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7048
7049         assert!(nodes[0].node.list_channels().is_empty());
7050         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7051         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7052         check_added_monitors!(nodes[0], 1);
7053 }
7054
7055 #[test]
7056 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7057         //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.
7058
7059         let chanmon_cfgs = create_chanmon_cfgs(2);
7060         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7061         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7062         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7063         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7064         let logger = test_utils::TestLogger::new();
7065
7066         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7067         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7068         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();
7069         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7070         check_added_monitors!(nodes[0], 1);
7071
7072         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7073         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7074
7075         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7076         check_added_monitors!(nodes[1], 0);
7077         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7078
7079         let events = nodes[1].node.get_and_clear_pending_msg_events();
7080
7081         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7082                 match events[0] {
7083                         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, .. } } => {
7084                                 assert!(update_add_htlcs.is_empty());
7085                                 assert!(update_fulfill_htlcs.is_empty());
7086                                 assert!(update_fail_htlcs.is_empty());
7087                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7088                                 assert!(update_fee.is_none());
7089                                 update_fail_malformed_htlcs[0].clone()
7090                         },
7091                         _ => panic!("Unexpected event"),
7092                 }
7093         };
7094         update_msg.failure_code &= !0x8000;
7095         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7096
7097         assert!(nodes[0].node.list_channels().is_empty());
7098         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7099         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7100         check_added_monitors!(nodes[0], 1);
7101 }
7102
7103 #[test]
7104 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7105         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7106         //    * 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.
7107
7108         let chanmon_cfgs = create_chanmon_cfgs(3);
7109         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7110         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7111         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7112         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7113         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7114         let logger = test_utils::TestLogger::new();
7115
7116         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7117
7118         //First hop
7119         let mut payment_event = {
7120                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7121                 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();
7122                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7123                 check_added_monitors!(nodes[0], 1);
7124                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7125                 assert_eq!(events.len(), 1);
7126                 SendEvent::from_event(events.remove(0))
7127         };
7128         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7129         check_added_monitors!(nodes[1], 0);
7130         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7131         expect_pending_htlcs_forwardable!(nodes[1]);
7132         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7133         assert_eq!(events_2.len(), 1);
7134         check_added_monitors!(nodes[1], 1);
7135         payment_event = SendEvent::from_event(events_2.remove(0));
7136         assert_eq!(payment_event.msgs.len(), 1);
7137
7138         //Second Hop
7139         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7140         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7141         check_added_monitors!(nodes[2], 0);
7142         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7143
7144         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7145         assert_eq!(events_3.len(), 1);
7146         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7147                 match events_3[0] {
7148                         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 } } => {
7149                                 assert!(update_add_htlcs.is_empty());
7150                                 assert!(update_fulfill_htlcs.is_empty());
7151                                 assert!(update_fail_htlcs.is_empty());
7152                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7153                                 assert!(update_fee.is_none());
7154                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7155                         },
7156                         _ => panic!("Unexpected event"),
7157                 }
7158         };
7159
7160         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7161
7162         check_added_monitors!(nodes[1], 0);
7163         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7164         expect_pending_htlcs_forwardable!(nodes[1]);
7165         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7166         assert_eq!(events_4.len(), 1);
7167
7168         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7169         match events_4[0] {
7170                 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, .. } } => {
7171                         assert!(update_add_htlcs.is_empty());
7172                         assert!(update_fulfill_htlcs.is_empty());
7173                         assert_eq!(update_fail_htlcs.len(), 1);
7174                         assert!(update_fail_malformed_htlcs.is_empty());
7175                         assert!(update_fee.is_none());
7176                 },
7177                 _ => panic!("Unexpected event"),
7178         };
7179
7180         check_added_monitors!(nodes[1], 1);
7181 }
7182
7183 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7184         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7185         // 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
7186         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7187
7188         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7189         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7190         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7191         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7192         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7193         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7194
7195         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7196
7197         // We route 2 dust-HTLCs between A and B
7198         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7199         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7200         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7201
7202         // Cache one local commitment tx as previous
7203         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7204
7205         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7206         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7207         check_added_monitors!(nodes[1], 0);
7208         expect_pending_htlcs_forwardable!(nodes[1]);
7209         check_added_monitors!(nodes[1], 1);
7210
7211         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7212         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7213         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7214         check_added_monitors!(nodes[0], 1);
7215
7216         // Cache one local commitment tx as lastest
7217         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7218
7219         let events = nodes[0].node.get_and_clear_pending_msg_events();
7220         match events[0] {
7221                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7222                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7223                 },
7224                 _ => panic!("Unexpected event"),
7225         }
7226         match events[1] {
7227                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7228                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7229                 },
7230                 _ => panic!("Unexpected event"),
7231         }
7232
7233         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7234         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7235         if announce_latest {
7236                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7237         } else {
7238                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7239         }
7240
7241         check_closed_broadcast!(nodes[0], true);
7242         check_added_monitors!(nodes[0], 1);
7243
7244         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7245         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7246         let events = nodes[0].node.get_and_clear_pending_events();
7247         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7248         assert_eq!(events.len(), 2);
7249         let mut first_failed = false;
7250         for event in events {
7251                 match event {
7252                         Event::PaymentFailed { payment_hash, .. } => {
7253                                 if payment_hash == payment_hash_1 {
7254                                         assert!(!first_failed);
7255                                         first_failed = true;
7256                                 } else {
7257                                         assert_eq!(payment_hash, payment_hash_2);
7258                                 }
7259                         }
7260                         _ => panic!("Unexpected event"),
7261                 }
7262         }
7263 }
7264
7265 #[test]
7266 fn test_failure_delay_dust_htlc_local_commitment() {
7267         do_test_failure_delay_dust_htlc_local_commitment(true);
7268         do_test_failure_delay_dust_htlc_local_commitment(false);
7269 }
7270
7271 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7272         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7273         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7274         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7275         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7276         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7277         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7278
7279         let chanmon_cfgs = create_chanmon_cfgs(3);
7280         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7281         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7282         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7283         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7284
7285         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7286
7287         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7288         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7289
7290         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7291         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7292
7293         // We revoked bs_commitment_tx
7294         if revoked {
7295                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7296                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7297         }
7298
7299         let mut timeout_tx = Vec::new();
7300         if local {
7301                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7302                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7303                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7304                 expect_payment_failed!(nodes[0], dust_hash, true);
7305
7306                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7307                 check_closed_broadcast!(nodes[0], true);
7308                 check_added_monitors!(nodes[0], 1);
7309                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7310                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7311                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7312                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7313                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7314                 mine_transaction(&nodes[0], &timeout_tx[0]);
7315                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7316                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7317         } else {
7318                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7319                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7320                 check_closed_broadcast!(nodes[0], true);
7321                 check_added_monitors!(nodes[0], 1);
7322                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7323                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7324                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7325                 if !revoked {
7326                         expect_payment_failed!(nodes[0], dust_hash, true);
7327                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7328                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7329                         mine_transaction(&nodes[0], &timeout_tx[0]);
7330                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7331                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7332                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7333                 } else {
7334                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7335                         // commitment tx
7336                         let events = nodes[0].node.get_and_clear_pending_events();
7337                         assert_eq!(events.len(), 2);
7338                         let first;
7339                         match events[0] {
7340                                 Event::PaymentFailed { payment_hash, .. } => {
7341                                         if payment_hash == dust_hash { first = true; }
7342                                         else { first = false; }
7343                                 },
7344                                 _ => panic!("Unexpected event"),
7345                         }
7346                         match events[1] {
7347                                 Event::PaymentFailed { payment_hash, .. } => {
7348                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7349                                         else { assert_eq!(payment_hash, dust_hash); }
7350                                 },
7351                                 _ => panic!("Unexpected event"),
7352                         }
7353                 }
7354         }
7355 }
7356
7357 #[test]
7358 fn test_sweep_outbound_htlc_failure_update() {
7359         do_test_sweep_outbound_htlc_failure_update(false, true);
7360         do_test_sweep_outbound_htlc_failure_update(false, false);
7361         do_test_sweep_outbound_htlc_failure_update(true, false);
7362 }
7363
7364 #[test]
7365 fn test_upfront_shutdown_script() {
7366         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7367         // enforce it at shutdown message
7368
7369         let mut config = UserConfig::default();
7370         config.channel_options.announced_channel = true;
7371         config.peer_channel_config_limits.force_announced_channel_preference = false;
7372         config.channel_options.commit_upfront_shutdown_pubkey = false;
7373         let user_cfgs = [None, Some(config), None];
7374         let chanmon_cfgs = create_chanmon_cfgs(3);
7375         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7376         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7377         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7378
7379         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7380         let flags = InitFeatures::known();
7381         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7382         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7383         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7384         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7385         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7386         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7387     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()));
7388         check_added_monitors!(nodes[2], 1);
7389
7390         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7391         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7392         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7393         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7394         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7395         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7396         let events = nodes[2].node.get_and_clear_pending_msg_events();
7397         assert_eq!(events.len(), 1);
7398         match events[0] {
7399                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7400                 _ => panic!("Unexpected event"),
7401         }
7402
7403         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7404         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7405         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7406         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7407         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7408         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7409         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7410         let events = nodes[1].node.get_and_clear_pending_msg_events();
7411         assert_eq!(events.len(), 1);
7412         match events[0] {
7413                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7414                 _ => panic!("Unexpected event"),
7415         }
7416
7417         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7418         // channel smoothly, opt-out is from channel initiator here
7419         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7420         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7421         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7422         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7423         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7424         let events = nodes[0].node.get_and_clear_pending_msg_events();
7425         assert_eq!(events.len(), 1);
7426         match events[0] {
7427                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7428                 _ => panic!("Unexpected event"),
7429         }
7430
7431         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7432         //// channel smoothly
7433         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7434         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7435         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7436         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7437         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7438         let events = nodes[0].node.get_and_clear_pending_msg_events();
7439         assert_eq!(events.len(), 2);
7440         match events[0] {
7441                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7442                 _ => panic!("Unexpected event"),
7443         }
7444         match events[1] {
7445                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7446                 _ => panic!("Unexpected event"),
7447         }
7448 }
7449
7450 #[test]
7451 fn test_upfront_shutdown_script_unsupport_segwit() {
7452         // We test that channel is closed early
7453         // if a segwit program is passed as upfront shutdown script,
7454         // but the peer does not support segwit.
7455         let chanmon_cfgs = create_chanmon_cfgs(2);
7456         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7457         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7458         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7459
7460         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7461
7462         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7463         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7464                 .push_slice(&[0, 0])
7465                 .into_script());
7466
7467         let features = InitFeatures::known().clear_shutdown_anysegwit();
7468         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7469
7470         let events = nodes[0].node.get_and_clear_pending_msg_events();
7471         assert_eq!(events.len(), 1);
7472         match events[0] {
7473                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7474                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7475                         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));
7476                 },
7477                 _ => panic!("Unexpected event"),
7478         }
7479 }
7480
7481 #[test]
7482 fn test_shutdown_script_any_segwit_allowed() {
7483         let mut config = UserConfig::default();
7484         config.channel_options.announced_channel = true;
7485         config.peer_channel_config_limits.force_announced_channel_preference = false;
7486         config.channel_options.commit_upfront_shutdown_pubkey = false;
7487         let user_cfgs = [None, Some(config), None];
7488         let chanmon_cfgs = create_chanmon_cfgs(3);
7489         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7490         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7491         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7492
7493         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7494         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7495         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7496         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7497         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7498                 .push_slice(&[0, 0])
7499                 .into_script();
7500         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7501         let events = nodes[0].node.get_and_clear_pending_msg_events();
7502         assert_eq!(events.len(), 2);
7503         match events[0] {
7504                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7505                 _ => panic!("Unexpected event"),
7506         }
7507         match events[1] {
7508                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7509                 _ => panic!("Unexpected event"),
7510         }
7511 }
7512
7513 #[test]
7514 fn test_shutdown_script_any_segwit_not_allowed() {
7515         let mut config = UserConfig::default();
7516         config.channel_options.announced_channel = true;
7517         config.peer_channel_config_limits.force_announced_channel_preference = false;
7518         config.channel_options.commit_upfront_shutdown_pubkey = false;
7519         let user_cfgs = [None, Some(config), None];
7520         let chanmon_cfgs = create_chanmon_cfgs(3);
7521         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7522         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7523         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7524
7525         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7526         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7527         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7528         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7529         // Make an any segwit version script
7530         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7531                 .push_slice(&[0, 0])
7532                 .into_script();
7533         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7534         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7535         let events = nodes[0].node.get_and_clear_pending_msg_events();
7536         assert_eq!(events.len(), 2);
7537         match events[1] {
7538                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7539                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7540                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7541                 },
7542                 _ => panic!("Unexpected event"),
7543         }
7544         check_added_monitors!(nodes[0], 1);
7545 }
7546
7547 #[test]
7548 fn test_shutdown_script_segwit_but_not_anysegwit() {
7549         let mut config = UserConfig::default();
7550         config.channel_options.announced_channel = true;
7551         config.peer_channel_config_limits.force_announced_channel_preference = false;
7552         config.channel_options.commit_upfront_shutdown_pubkey = false;
7553         let user_cfgs = [None, Some(config), None];
7554         let chanmon_cfgs = create_chanmon_cfgs(3);
7555         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7556         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7557         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7558
7559         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7560         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7561         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7562         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7563         // Make a segwit script that is not a valid as any segwit
7564         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7565                 .push_slice(&[0, 0])
7566                 .into_script();
7567         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7568         let events = nodes[0].node.get_and_clear_pending_msg_events();
7569         assert_eq!(events.len(), 2);
7570         match events[1] {
7571                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7572                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7573                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7574                 },
7575                 _ => panic!("Unexpected event"),
7576         }
7577         check_added_monitors!(nodes[0], 1);
7578 }
7579
7580 #[test]
7581 fn test_user_configurable_csv_delay() {
7582         // We test our channel constructors yield errors when we pass them absurd csv delay
7583
7584         let mut low_our_to_self_config = UserConfig::default();
7585         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7586         let mut high_their_to_self_config = UserConfig::default();
7587         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7588         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7589         let chanmon_cfgs = create_chanmon_cfgs(2);
7590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7592         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7593
7594         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7595         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) {
7596                 match error {
7597                         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())); },
7598                         _ => panic!("Unexpected event"),
7599                 }
7600         } else { assert!(false) }
7601
7602         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7603         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7604         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7605         open_channel.to_self_delay = 200;
7606         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) {
7607                 match error {
7608                         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()));  },
7609                         _ => panic!("Unexpected event"),
7610                 }
7611         } else { assert!(false); }
7612
7613         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7614         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7615         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()));
7616         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7617         accept_channel.to_self_delay = 200;
7618         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7619         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7620                 match action {
7621                         &ErrorAction::SendErrorMessage { ref msg } => {
7622                                 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()));
7623                         },
7624                         _ => { assert!(false); }
7625                 }
7626         } else { assert!(false); }
7627
7628         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7629         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7630         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7631         open_channel.to_self_delay = 200;
7632         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) {
7633                 match error {
7634                         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())); },
7635                         _ => panic!("Unexpected event"),
7636                 }
7637         } else { assert!(false); }
7638 }
7639
7640 #[test]
7641 fn test_data_loss_protect() {
7642         // We want to be sure that :
7643         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7644         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7645         // * we close channel in case of detecting other being fallen behind
7646         // * we are able to claim our own outputs thanks to to_remote being static
7647         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7648         let persister;
7649         let logger;
7650         let fee_estimator;
7651         let tx_broadcaster;
7652         let chain_source;
7653         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7654         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7655         // during signing due to revoked tx
7656         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7657         let keys_manager = &chanmon_cfgs[0].keys_manager;
7658         let monitor;
7659         let node_state_0;
7660         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7661         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7662         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7663
7664         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7665
7666         // Cache node A state before any channel update
7667         let previous_node_state = nodes[0].node.encode();
7668         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7669         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7670
7671         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7672         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7673
7674         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7675         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7676
7677         // Restore node A from previous state
7678         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7679         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7680         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7681         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7682         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7683         persister = test_utils::TestPersister::new();
7684         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7685         node_state_0 = {
7686                 let mut channel_monitors = HashMap::new();
7687                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7688                 <(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 {
7689                         keys_manager: keys_manager,
7690                         fee_estimator: &fee_estimator,
7691                         chain_monitor: &monitor,
7692                         logger: &logger,
7693                         tx_broadcaster: &tx_broadcaster,
7694                         default_config: UserConfig::default(),
7695                         channel_monitors,
7696                 }).unwrap().1
7697         };
7698         nodes[0].node = &node_state_0;
7699         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7700         nodes[0].chain_monitor = &monitor;
7701         nodes[0].chain_source = &chain_source;
7702
7703         check_added_monitors!(nodes[0], 1);
7704
7705         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7706         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7707
7708         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7709
7710         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7711         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7712         check_added_monitors!(nodes[0], 1);
7713
7714         {
7715                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7716                 assert_eq!(node_txn.len(), 0);
7717         }
7718
7719         let mut reestablish_1 = Vec::with_capacity(1);
7720         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7721                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7722                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7723                         reestablish_1.push(msg.clone());
7724                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7725                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7726                         match action {
7727                                 &ErrorAction::SendErrorMessage { ref msg } => {
7728                                         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");
7729                                 },
7730                                 _ => panic!("Unexpected event!"),
7731                         }
7732                 } else {
7733                         panic!("Unexpected event")
7734                 }
7735         }
7736
7737         // Check we close channel detecting A is fallen-behind
7738         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7739         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7740         check_added_monitors!(nodes[1], 1);
7741
7742
7743         // Check A is able to claim to_remote output
7744         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7745         assert_eq!(node_txn.len(), 1);
7746         check_spends!(node_txn[0], chan.3);
7747         assert_eq!(node_txn[0].output.len(), 2);
7748         mine_transaction(&nodes[0], &node_txn[0]);
7749         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7750         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7751         assert_eq!(spend_txn.len(), 1);
7752         check_spends!(spend_txn[0], node_txn[0]);
7753 }
7754
7755 #[test]
7756 fn test_check_htlc_underpaying() {
7757         // Send payment through A -> B but A is maliciously
7758         // sending a probe payment (i.e less than expected value0
7759         // to B, B should refuse payment.
7760
7761         let chanmon_cfgs = create_chanmon_cfgs(2);
7762         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7763         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7764         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7765
7766         // Create some initial channels
7767         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7768
7769         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();
7770         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7771         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7772         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7773         check_added_monitors!(nodes[0], 1);
7774
7775         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7776         assert_eq!(events.len(), 1);
7777         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7778         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7779         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7780
7781         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7782         // and then will wait a second random delay before failing the HTLC back:
7783         expect_pending_htlcs_forwardable!(nodes[1]);
7784         expect_pending_htlcs_forwardable!(nodes[1]);
7785
7786         // Node 3 is expecting payment of 100_000 but received 10_000,
7787         // it should fail htlc like we didn't know the preimage.
7788         nodes[1].node.process_pending_htlc_forwards();
7789
7790         let events = nodes[1].node.get_and_clear_pending_msg_events();
7791         assert_eq!(events.len(), 1);
7792         let (update_fail_htlc, commitment_signed) = match events[0] {
7793                 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 } } => {
7794                         assert!(update_add_htlcs.is_empty());
7795                         assert!(update_fulfill_htlcs.is_empty());
7796                         assert_eq!(update_fail_htlcs.len(), 1);
7797                         assert!(update_fail_malformed_htlcs.is_empty());
7798                         assert!(update_fee.is_none());
7799                         (update_fail_htlcs[0].clone(), commitment_signed)
7800                 },
7801                 _ => panic!("Unexpected event"),
7802         };
7803         check_added_monitors!(nodes[1], 1);
7804
7805         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7806         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7807
7808         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7809         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7810         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7811         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7812 }
7813
7814 #[test]
7815 fn test_announce_disable_channels() {
7816         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7817         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7818
7819         let chanmon_cfgs = create_chanmon_cfgs(2);
7820         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7821         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7822         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7823
7824         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7825         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7826         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7827
7828         // Disconnect peers
7829         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7830         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7831
7832         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7833         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7834         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7835         assert_eq!(msg_events.len(), 3);
7836         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7837         for e in msg_events {
7838                 match e {
7839                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7840                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7841                                 // Check that each channel gets updated exactly once
7842                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7843                                         panic!("Generated ChannelUpdate for wrong chan!");
7844                                 }
7845                         },
7846                         _ => panic!("Unexpected event"),
7847                 }
7848         }
7849         // Reconnect peers
7850         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7851         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7852         assert_eq!(reestablish_1.len(), 3);
7853         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7854         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7855         assert_eq!(reestablish_2.len(), 3);
7856
7857         // Reestablish chan_1
7858         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7859         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7860         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7861         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7862         // Reestablish chan_2
7863         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7864         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7865         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7866         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7867         // Reestablish chan_3
7868         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7869         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7870         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7871         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7872
7873         nodes[0].node.timer_tick_occurred();
7874         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7875         nodes[0].node.timer_tick_occurred();
7876         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7877         assert_eq!(msg_events.len(), 3);
7878         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7879         for e in msg_events {
7880                 match e {
7881                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7882                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7883                                 // Check that each channel gets updated exactly once
7884                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7885                                         panic!("Generated ChannelUpdate for wrong chan!");
7886                                 }
7887                         },
7888                         _ => panic!("Unexpected event"),
7889                 }
7890         }
7891 }
7892
7893 #[test]
7894 fn test_bump_penalty_txn_on_revoked_commitment() {
7895         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7896         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7897
7898         let chanmon_cfgs = create_chanmon_cfgs(2);
7899         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7900         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7901         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7902
7903         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7904         let logger = test_utils::TestLogger::new();
7905
7906         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7907         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7908         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();
7909         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7910
7911         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7912         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7913         assert_eq!(revoked_txn[0].output.len(), 4);
7914         assert_eq!(revoked_txn[0].input.len(), 1);
7915         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7916         let revoked_txid = revoked_txn[0].txid();
7917
7918         let mut penalty_sum = 0;
7919         for outp in revoked_txn[0].output.iter() {
7920                 if outp.script_pubkey.is_v0_p2wsh() {
7921                         penalty_sum += outp.value;
7922                 }
7923         }
7924
7925         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7926         let header_114 = connect_blocks(&nodes[1], 14);
7927
7928         // Actually revoke tx by claiming a HTLC
7929         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7930         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7931         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7932         check_added_monitors!(nodes[1], 1);
7933
7934         // One or more justice tx should have been broadcast, check it
7935         let penalty_1;
7936         let feerate_1;
7937         {
7938                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7939                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7940                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7941                 assert_eq!(node_txn[0].output.len(), 1);
7942                 check_spends!(node_txn[0], revoked_txn[0]);
7943                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7944                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7945                 penalty_1 = node_txn[0].txid();
7946                 node_txn.clear();
7947         };
7948
7949         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7950         connect_blocks(&nodes[1], 15);
7951         let mut penalty_2 = penalty_1;
7952         let mut feerate_2 = 0;
7953         {
7954                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7955                 assert_eq!(node_txn.len(), 1);
7956                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7957                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7958                         assert_eq!(node_txn[0].output.len(), 1);
7959                         check_spends!(node_txn[0], revoked_txn[0]);
7960                         penalty_2 = node_txn[0].txid();
7961                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7962                         assert_ne!(penalty_2, penalty_1);
7963                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7964                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7965                         // Verify 25% bump heuristic
7966                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7967                         node_txn.clear();
7968                 }
7969         }
7970         assert_ne!(feerate_2, 0);
7971
7972         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7973         connect_blocks(&nodes[1], 1);
7974         let penalty_3;
7975         let mut feerate_3 = 0;
7976         {
7977                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7978                 assert_eq!(node_txn.len(), 1);
7979                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7980                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7981                         assert_eq!(node_txn[0].output.len(), 1);
7982                         check_spends!(node_txn[0], revoked_txn[0]);
7983                         penalty_3 = node_txn[0].txid();
7984                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7985                         assert_ne!(penalty_3, penalty_2);
7986                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7987                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7988                         // Verify 25% bump heuristic
7989                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7990                         node_txn.clear();
7991                 }
7992         }
7993         assert_ne!(feerate_3, 0);
7994
7995         nodes[1].node.get_and_clear_pending_events();
7996         nodes[1].node.get_and_clear_pending_msg_events();
7997 }
7998
7999 #[test]
8000 fn test_bump_penalty_txn_on_revoked_htlcs() {
8001         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8002         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8003
8004         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8005         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8006         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8007         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8008         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8009
8010         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8011         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8012         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8013                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8014         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8015         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8016                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8017         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8018
8019         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8020         assert_eq!(revoked_local_txn[0].input.len(), 1);
8021         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8022
8023         // Revoke local commitment tx
8024         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8025
8026         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8027         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8028         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8029         check_closed_broadcast!(nodes[1], true);
8030         check_added_monitors!(nodes[1], 1);
8031         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8032
8033         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8034         assert_eq!(revoked_htlc_txn.len(), 3);
8035         check_spends!(revoked_htlc_txn[1], chan.3);
8036
8037         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8038         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8039         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8040
8041         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8042         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8043         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8044         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8045
8046         // Broadcast set of revoked txn on A
8047         let hash_128 = connect_blocks(&nodes[0], 40);
8048         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8049         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8050         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8051         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8052         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8053         let first;
8054         let feerate_1;
8055         let penalty_txn;
8056         {
8057                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8058                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8059                 // Verify claim tx are spending revoked HTLC txn
8060
8061                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8062                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8063                 // which are included in the same block (they are broadcasted because we scan the
8064                 // transactions linearly and generate claims as we go, they likely should be removed in the
8065                 // future).
8066                 assert_eq!(node_txn[0].input.len(), 1);
8067                 check_spends!(node_txn[0], revoked_local_txn[0]);
8068                 assert_eq!(node_txn[1].input.len(), 1);
8069                 check_spends!(node_txn[1], revoked_local_txn[0]);
8070                 assert_eq!(node_txn[2].input.len(), 1);
8071                 check_spends!(node_txn[2], revoked_local_txn[0]);
8072
8073                 // Each of the three justice transactions claim a separate (single) output of the three
8074                 // available, which we check here:
8075                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8076                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8077                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8078
8079                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8080                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8081
8082                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8083                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8084                 // a remote commitment tx has already been confirmed).
8085                 check_spends!(node_txn[3], chan.3);
8086
8087                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8088                 // output, checked above).
8089                 assert_eq!(node_txn[4].input.len(), 2);
8090                 assert_eq!(node_txn[4].output.len(), 1);
8091                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8092
8093                 first = node_txn[4].txid();
8094                 // Store both feerates for later comparison
8095                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8096                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8097                 penalty_txn = vec![node_txn[2].clone()];
8098                 node_txn.clear();
8099         }
8100
8101         // Connect one more block to see if bumped penalty are issued for HTLC txn
8102         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8103         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8104         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8105         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8106         {
8107                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8108                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8109
8110                 check_spends!(node_txn[0], revoked_local_txn[0]);
8111                 check_spends!(node_txn[1], revoked_local_txn[0]);
8112                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8113                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8114                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8115                 } else {
8116                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8117                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8118                 }
8119
8120                 node_txn.clear();
8121         };
8122
8123         // Few more blocks to confirm penalty txn
8124         connect_blocks(&nodes[0], 4);
8125         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8126         let header_144 = connect_blocks(&nodes[0], 9);
8127         let node_txn = {
8128                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8129                 assert_eq!(node_txn.len(), 1);
8130
8131                 assert_eq!(node_txn[0].input.len(), 2);
8132                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8133                 // Verify bumped tx is different and 25% bump heuristic
8134                 assert_ne!(first, node_txn[0].txid());
8135                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8136                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8137                 assert!(feerate_2 * 100 > feerate_1 * 125);
8138                 let txn = vec![node_txn[0].clone()];
8139                 node_txn.clear();
8140                 txn
8141         };
8142         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8143         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8144         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8145         connect_blocks(&nodes[0], 20);
8146         {
8147                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8148                 // We verify than no new transaction has been broadcast because previously
8149                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8150                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8151                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8152                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8153                 // up bumped justice generation.
8154                 assert_eq!(node_txn.len(), 0);
8155                 node_txn.clear();
8156         }
8157         check_closed_broadcast!(nodes[0], true);
8158         check_added_monitors!(nodes[0], 1);
8159 }
8160
8161 #[test]
8162 fn test_bump_penalty_txn_on_remote_commitment() {
8163         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8164         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8165
8166         // Create 2 HTLCs
8167         // Provide preimage for one
8168         // Check aggregation
8169
8170         let chanmon_cfgs = create_chanmon_cfgs(2);
8171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8174
8175         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8176         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8177         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8178
8179         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8180         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8181         assert_eq!(remote_txn[0].output.len(), 4);
8182         assert_eq!(remote_txn[0].input.len(), 1);
8183         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8184
8185         // Claim a HTLC without revocation (provide B monitor with preimage)
8186         nodes[1].node.claim_funds(payment_preimage);
8187         mine_transaction(&nodes[1], &remote_txn[0]);
8188         check_added_monitors!(nodes[1], 2);
8189         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8190
8191         // One or more claim tx should have been broadcast, check it
8192         let timeout;
8193         let preimage;
8194         let preimage_bump;
8195         let feerate_timeout;
8196         let feerate_preimage;
8197         {
8198                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8199                 // 9 transactions including:
8200                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8201                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8202                 // 2 * HTLC-Success (one RBF bump we'll check later)
8203                 // 1 * HTLC-Timeout
8204                 assert_eq!(node_txn.len(), 8);
8205                 assert_eq!(node_txn[0].input.len(), 1);
8206                 assert_eq!(node_txn[6].input.len(), 1);
8207                 check_spends!(node_txn[0], remote_txn[0]);
8208                 check_spends!(node_txn[6], remote_txn[0]);
8209                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8210                 preimage_bump = node_txn[3].clone();
8211
8212                 check_spends!(node_txn[1], chan.3);
8213                 check_spends!(node_txn[2], node_txn[1]);
8214                 assert_eq!(node_txn[1], node_txn[4]);
8215                 assert_eq!(node_txn[2], node_txn[5]);
8216
8217                 timeout = node_txn[6].txid();
8218                 let index = node_txn[6].input[0].previous_output.vout;
8219                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8220                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8221
8222                 preimage = node_txn[0].txid();
8223                 let index = node_txn[0].input[0].previous_output.vout;
8224                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8225                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8226
8227                 node_txn.clear();
8228         };
8229         assert_ne!(feerate_timeout, 0);
8230         assert_ne!(feerate_preimage, 0);
8231
8232         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8233         connect_blocks(&nodes[1], 15);
8234         {
8235                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8236                 assert_eq!(node_txn.len(), 1);
8237                 assert_eq!(node_txn[0].input.len(), 1);
8238                 assert_eq!(preimage_bump.input.len(), 1);
8239                 check_spends!(node_txn[0], remote_txn[0]);
8240                 check_spends!(preimage_bump, remote_txn[0]);
8241
8242                 let index = preimage_bump.input[0].previous_output.vout;
8243                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8244                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8245                 assert!(new_feerate * 100 > feerate_timeout * 125);
8246                 assert_ne!(timeout, preimage_bump.txid());
8247
8248                 let index = node_txn[0].input[0].previous_output.vout;
8249                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8250                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8251                 assert!(new_feerate * 100 > feerate_preimage * 125);
8252                 assert_ne!(preimage, node_txn[0].txid());
8253
8254                 node_txn.clear();
8255         }
8256
8257         nodes[1].node.get_and_clear_pending_events();
8258         nodes[1].node.get_and_clear_pending_msg_events();
8259 }
8260
8261 #[test]
8262 fn test_counterparty_raa_skip_no_crash() {
8263         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8264         // commitment transaction, we would have happily carried on and provided them the next
8265         // commitment transaction based on one RAA forward. This would probably eventually have led to
8266         // channel closure, but it would not have resulted in funds loss. Still, our
8267         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8268         // check simply that the channel is closed in response to such an RAA, but don't check whether
8269         // we decide to punish our counterparty for revoking their funds (as we don't currently
8270         // implement that).
8271         let chanmon_cfgs = create_chanmon_cfgs(2);
8272         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8273         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8274         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8275         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8276
8277         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8278         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8279         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8280         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8281         // Must revoke without gaps
8282         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8283         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8284                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8285
8286         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8287                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8288         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8289         check_added_monitors!(nodes[1], 1);
8290 }
8291
8292 #[test]
8293 fn test_bump_txn_sanitize_tracking_maps() {
8294         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8295         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8296
8297         let chanmon_cfgs = create_chanmon_cfgs(2);
8298         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8299         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8300         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8301
8302         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8303         // Lock HTLC in both directions
8304         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8305         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8306
8307         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8308         assert_eq!(revoked_local_txn[0].input.len(), 1);
8309         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8310
8311         // Revoke local commitment tx
8312         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8313
8314         // Broadcast set of revoked txn on A
8315         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8316         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8317         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8318
8319         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8320         check_closed_broadcast!(nodes[0], true);
8321         check_added_monitors!(nodes[0], 1);
8322         let penalty_txn = {
8323                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8324                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8325                 check_spends!(node_txn[0], revoked_local_txn[0]);
8326                 check_spends!(node_txn[1], revoked_local_txn[0]);
8327                 check_spends!(node_txn[2], revoked_local_txn[0]);
8328                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8329                 node_txn.clear();
8330                 penalty_txn
8331         };
8332         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8333         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8334         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8335         {
8336                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8337                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8338                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8339                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8340                 }
8341         }
8342 }
8343
8344 #[test]
8345 fn test_override_channel_config() {
8346         let chanmon_cfgs = create_chanmon_cfgs(2);
8347         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8348         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8349         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8350
8351         // Node0 initiates a channel to node1 using the override config.
8352         let mut override_config = UserConfig::default();
8353         override_config.own_channel_config.our_to_self_delay = 200;
8354
8355         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8356
8357         // Assert the channel created by node0 is using the override config.
8358         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8359         assert_eq!(res.channel_flags, 0);
8360         assert_eq!(res.to_self_delay, 200);
8361 }
8362
8363 #[test]
8364 fn test_override_0msat_htlc_minimum() {
8365         let mut zero_config = UserConfig::default();
8366         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8367         let chanmon_cfgs = create_chanmon_cfgs(2);
8368         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8369         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8370         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8371
8372         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8373         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8374         assert_eq!(res.htlc_minimum_msat, 1);
8375
8376         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8377         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8378         assert_eq!(res.htlc_minimum_msat, 1);
8379 }
8380
8381 #[test]
8382 fn test_simple_mpp() {
8383         // Simple test of sending a multi-path payment.
8384         let chanmon_cfgs = create_chanmon_cfgs(4);
8385         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8386         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8387         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8388
8389         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8390         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8391         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8392         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8393         let logger = test_utils::TestLogger::new();
8394
8395         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8396         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8397         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();
8398         let path = route.paths[0].clone();
8399         route.paths.push(path);
8400         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8401         route.paths[0][0].short_channel_id = chan_1_id;
8402         route.paths[0][1].short_channel_id = chan_3_id;
8403         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8404         route.paths[1][0].short_channel_id = chan_2_id;
8405         route.paths[1][1].short_channel_id = chan_4_id;
8406         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8407         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8408 }
8409
8410 #[test]
8411 fn test_preimage_storage() {
8412         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8413         let chanmon_cfgs = create_chanmon_cfgs(2);
8414         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8415         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8416         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8417
8418         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8419
8420         {
8421                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8422
8423                 let logger = test_utils::TestLogger::new();
8424                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8425                 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();
8426                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8427                 check_added_monitors!(nodes[0], 1);
8428                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8429                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8430                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8431                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8432         }
8433         // Note that after leaving the above scope we have no knowledge of any arguments or return
8434         // values from previous calls.
8435         expect_pending_htlcs_forwardable!(nodes[1]);
8436         let events = nodes[1].node.get_and_clear_pending_events();
8437         assert_eq!(events.len(), 1);
8438         match events[0] {
8439                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8440                         assert_eq!(user_payment_id, 42);
8441                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8442                 },
8443                 _ => panic!("Unexpected event"),
8444         }
8445 }
8446
8447 #[test]
8448 fn test_secret_timeout() {
8449         // Simple test of payment secret storage time outs
8450         let chanmon_cfgs = create_chanmon_cfgs(2);
8451         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8452         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8453         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8454
8455         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8456
8457         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8458
8459         // We should fail to register the same payment hash twice, at least until we've connected a
8460         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8461         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8462                 assert_eq!(err, "Duplicate payment hash");
8463         } else { panic!(); }
8464         let mut block = {
8465                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8466                 Block {
8467                         header: BlockHeader {
8468                                 version: 0x2000000,
8469                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8470                                 merkle_root: Default::default(),
8471                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8472                         txdata: vec![],
8473                 }
8474         };
8475         connect_block(&nodes[1], &block);
8476         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8477                 assert_eq!(err, "Duplicate payment hash");
8478         } else { panic!(); }
8479
8480         // If we then connect the second block, we should be able to register the same payment hash
8481         // again with a different user_payment_id (this time getting a new payment secret).
8482         block.header.prev_blockhash = block.header.block_hash();
8483         block.header.time += 1;
8484         connect_block(&nodes[1], &block);
8485         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8486         assert_ne!(payment_secret_1, our_payment_secret);
8487
8488         {
8489                 let logger = test_utils::TestLogger::new();
8490                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8491                 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();
8492                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8493                 check_added_monitors!(nodes[0], 1);
8494                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8495                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8496                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8497                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8498         }
8499         // Note that after leaving the above scope we have no knowledge of any arguments or return
8500         // values from previous calls.
8501         expect_pending_htlcs_forwardable!(nodes[1]);
8502         let events = nodes[1].node.get_and_clear_pending_events();
8503         assert_eq!(events.len(), 1);
8504         match events[0] {
8505                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8506                         assert!(payment_preimage.is_none());
8507                         assert_eq!(user_payment_id, 42);
8508                         assert_eq!(payment_secret, our_payment_secret);
8509                         // We don't actually have the payment preimage with which to claim this payment!
8510                 },
8511                 _ => panic!("Unexpected event"),
8512         }
8513 }
8514
8515 #[test]
8516 fn test_bad_secret_hash() {
8517         // Simple test of unregistered payment hash/invalid payment secret handling
8518         let chanmon_cfgs = create_chanmon_cfgs(2);
8519         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8520         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8521         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8522
8523         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8524
8525         let random_payment_hash = PaymentHash([42; 32]);
8526         let random_payment_secret = PaymentSecret([43; 32]);
8527         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8528
8529         let logger = test_utils::TestLogger::new();
8530         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8531         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();
8532
8533         // All the below cases should end up being handled exactly identically, so we macro the
8534         // resulting events.
8535         macro_rules! handle_unknown_invalid_payment_data {
8536                 () => {
8537                         check_added_monitors!(nodes[0], 1);
8538                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8539                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8540                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8541                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8542
8543                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8544                         // again to process the pending backwards-failure of the HTLC
8545                         expect_pending_htlcs_forwardable!(nodes[1]);
8546                         expect_pending_htlcs_forwardable!(nodes[1]);
8547                         check_added_monitors!(nodes[1], 1);
8548
8549                         // We should fail the payment back
8550                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8551                         match events.pop().unwrap() {
8552                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8553                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8554                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8555                                 },
8556                                 _ => panic!("Unexpected event"),
8557                         }
8558                 }
8559         }
8560
8561         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8562         // Error data is the HTLC value (100,000) and current block height
8563         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8564
8565         // Send a payment with the right payment hash but the wrong payment secret
8566         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8567         handle_unknown_invalid_payment_data!();
8568         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8569
8570         // Send a payment with a random payment hash, but the right payment secret
8571         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8572         handle_unknown_invalid_payment_data!();
8573         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8574
8575         // Send a payment with a random payment hash and random payment secret
8576         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8577         handle_unknown_invalid_payment_data!();
8578         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8579 }
8580
8581 #[test]
8582 fn test_update_err_monitor_lockdown() {
8583         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8584         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8585         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8586         //
8587         // This scenario may happen in a watchtower setup, where watchtower process a block height
8588         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8589         // commitment at same time.
8590
8591         let chanmon_cfgs = create_chanmon_cfgs(2);
8592         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8593         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8594         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8595
8596         // Create some initial channel
8597         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8598         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8599
8600         // Rebalance the network to generate htlc in the two directions
8601         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8602
8603         // Route a HTLC from node 0 to node 1 (but don't settle)
8604         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8605
8606         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8607         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8608         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8609         let persister = test_utils::TestPersister::new();
8610         let watchtower = {
8611                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8612                 let monitor = monitors.get(&outpoint).unwrap();
8613                 let mut w = test_utils::TestVecWriter(Vec::new());
8614                 monitor.write(&mut w).unwrap();
8615                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8616                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8617                 assert!(new_monitor == *monitor);
8618                 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);
8619                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8620                 watchtower
8621         };
8622         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8623         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8624         // transaction lock time requirements here.
8625         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8626         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8627
8628         // Try to update ChannelMonitor
8629         assert!(nodes[1].node.claim_funds(preimage));
8630         check_added_monitors!(nodes[1], 1);
8631         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8632         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8633         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8634         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8635                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8636                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8637                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8638                 } else { assert!(false); }
8639         } else { assert!(false); };
8640         // Our local monitor is in-sync and hasn't processed yet timeout
8641         check_added_monitors!(nodes[0], 1);
8642         let events = nodes[0].node.get_and_clear_pending_events();
8643         assert_eq!(events.len(), 1);
8644 }
8645
8646 #[test]
8647 fn test_concurrent_monitor_claim() {
8648         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8649         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8650         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8651         // state N+1 confirms. Alice claims output from state N+1.
8652
8653         let chanmon_cfgs = create_chanmon_cfgs(2);
8654         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8655         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8656         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8657
8658         // Create some initial channel
8659         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8660         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8661
8662         // Rebalance the network to generate htlc in the two directions
8663         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8664
8665         // Route a HTLC from node 0 to node 1 (but don't settle)
8666         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8667
8668         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8669         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8670         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8671         let persister = test_utils::TestPersister::new();
8672         let watchtower_alice = {
8673                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8674                 let monitor = monitors.get(&outpoint).unwrap();
8675                 let mut w = test_utils::TestVecWriter(Vec::new());
8676                 monitor.write(&mut w).unwrap();
8677                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8678                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8679                 assert!(new_monitor == *monitor);
8680                 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);
8681                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8682                 watchtower
8683         };
8684         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8685         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8686         // transaction lock time requirements here.
8687         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8688         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8689
8690         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8691         {
8692                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8693                 assert_eq!(txn.len(), 2);
8694                 txn.clear();
8695         }
8696
8697         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8698         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8699         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8700         let persister = test_utils::TestPersister::new();
8701         let watchtower_bob = {
8702                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8703                 let monitor = monitors.get(&outpoint).unwrap();
8704                 let mut w = test_utils::TestVecWriter(Vec::new());
8705                 monitor.write(&mut w).unwrap();
8706                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8707                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8708                 assert!(new_monitor == *monitor);
8709                 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);
8710                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8711                 watchtower
8712         };
8713         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8714         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8715
8716         // Route another payment to generate another update with still previous HTLC pending
8717         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8718         {
8719                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8720                 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();
8721                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8722         }
8723         check_added_monitors!(nodes[1], 1);
8724
8725         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8726         assert_eq!(updates.update_add_htlcs.len(), 1);
8727         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8728         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8729                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8730                         // Watchtower Alice should already have seen the block and reject the update
8731                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8732                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8733                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8734                 } else { assert!(false); }
8735         } else { assert!(false); };
8736         // Our local monitor is in-sync and hasn't processed yet timeout
8737         check_added_monitors!(nodes[0], 1);
8738
8739         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8740         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8741         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8742
8743         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8744         let bob_state_y;
8745         {
8746                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8747                 assert_eq!(txn.len(), 2);
8748                 bob_state_y = txn[0].clone();
8749                 txn.clear();
8750         };
8751
8752         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8753         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8754         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);
8755         {
8756                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8757                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8758                 // the onchain detection of the HTLC output
8759                 assert_eq!(htlc_txn.len(), 2);
8760                 check_spends!(htlc_txn[0], bob_state_y);
8761                 check_spends!(htlc_txn[1], bob_state_y);
8762         }
8763 }
8764
8765 #[test]
8766 fn test_pre_lockin_no_chan_closed_update() {
8767         // Test that if a peer closes a channel in response to a funding_created message we don't
8768         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8769         // message).
8770         //
8771         // Doing so would imply a channel monitor update before the initial channel monitor
8772         // registration, violating our API guarantees.
8773         //
8774         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8775         // then opening a second channel with the same funding output as the first (which is not
8776         // rejected because the first channel does not exist in the ChannelManager) and closing it
8777         // before receiving funding_signed.
8778         let chanmon_cfgs = create_chanmon_cfgs(2);
8779         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8780         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8781         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8782
8783         // Create an initial channel
8784         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8785         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8786         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8787         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8788         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8789
8790         // Move the first channel through the funding flow...
8791         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8792
8793         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8794         check_added_monitors!(nodes[0], 0);
8795
8796         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8797         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8798         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8799         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8800 }
8801
8802 #[test]
8803 fn test_htlc_no_detection() {
8804         // This test is a mutation to underscore the detection logic bug we had
8805         // before #653. HTLC value routed is above the remaining balance, thus
8806         // inverting HTLC and `to_remote` output. HTLC will come second and
8807         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8808         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8809         // outputs order detection for correct spending children filtring.
8810
8811         let chanmon_cfgs = create_chanmon_cfgs(2);
8812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8814         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8815
8816         // Create some initial channels
8817         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8818
8819         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8820         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8821         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8822         assert_eq!(local_txn[0].input.len(), 1);
8823         assert_eq!(local_txn[0].output.len(), 3);
8824         check_spends!(local_txn[0], chan_1.3);
8825
8826         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8827         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8828         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8829         // We deliberately connect the local tx twice as this should provoke a failure calling
8830         // this test before #653 fix.
8831         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);
8832         check_closed_broadcast!(nodes[0], true);
8833         check_added_monitors!(nodes[0], 1);
8834         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8835
8836         let htlc_timeout = {
8837                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8838                 assert_eq!(node_txn[1].input.len(), 1);
8839                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8840                 check_spends!(node_txn[1], local_txn[0]);
8841                 node_txn[1].clone()
8842         };
8843
8844         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8845         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8846         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8847         expect_payment_failed!(nodes[0], our_payment_hash, true);
8848 }
8849
8850 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8851         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8852         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8853         // Carol, Alice would be the upstream node, and Carol the downstream.)
8854         //
8855         // Steps of the test:
8856         // 1) Alice sends a HTLC to Carol through Bob.
8857         // 2) Carol doesn't settle the HTLC.
8858         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8859         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8860         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8861         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8862         // 5) Carol release the preimage to Bob off-chain.
8863         // 6) Bob claims the offered output on the broadcasted commitment.
8864         let chanmon_cfgs = create_chanmon_cfgs(3);
8865         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8866         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8867         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8868
8869         // Create some initial channels
8870         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8871         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8872
8873         // Steps (1) and (2):
8874         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8875         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8876
8877         // Check that Alice's commitment transaction now contains an output for this HTLC.
8878         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8879         check_spends!(alice_txn[0], chan_ab.3);
8880         assert_eq!(alice_txn[0].output.len(), 2);
8881         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8882         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8883         assert_eq!(alice_txn.len(), 2);
8884
8885         // Steps (3) and (4):
8886         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8887         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8888         let mut force_closing_node = 0; // Alice force-closes
8889         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8890         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8891         check_closed_broadcast!(nodes[force_closing_node], true);
8892         check_added_monitors!(nodes[force_closing_node], 1);
8893         if go_onchain_before_fulfill {
8894                 let txn_to_broadcast = match broadcast_alice {
8895                         true => alice_txn.clone(),
8896                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8897                 };
8898                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8899                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8900                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8901                 if broadcast_alice {
8902                         check_closed_broadcast!(nodes[1], true);
8903                         check_added_monitors!(nodes[1], 1);
8904                 }
8905                 assert_eq!(bob_txn.len(), 1);
8906                 check_spends!(bob_txn[0], chan_ab.3);
8907         }
8908
8909         // Step (5):
8910         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8911         // process of removing the HTLC from their commitment transactions.
8912         assert!(nodes[2].node.claim_funds(payment_preimage));
8913         check_added_monitors!(nodes[2], 1);
8914         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8915         assert!(carol_updates.update_add_htlcs.is_empty());
8916         assert!(carol_updates.update_fail_htlcs.is_empty());
8917         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8918         assert!(carol_updates.update_fee.is_none());
8919         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8920
8921         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8922         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8923         if !go_onchain_before_fulfill && broadcast_alice {
8924                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8925                 assert_eq!(events.len(), 1);
8926                 match events[0] {
8927                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8928                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8929                         },
8930                         _ => panic!("Unexpected event"),
8931                 };
8932         }
8933         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8934         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8935         // Carol<->Bob's updated commitment transaction info.
8936         check_added_monitors!(nodes[1], 2);
8937
8938         let events = nodes[1].node.get_and_clear_pending_msg_events();
8939         assert_eq!(events.len(), 2);
8940         let bob_revocation = match events[0] {
8941                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8942                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8943                         (*msg).clone()
8944                 },
8945                 _ => panic!("Unexpected event"),
8946         };
8947         let bob_updates = match events[1] {
8948                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8949                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8950                         (*updates).clone()
8951                 },
8952                 _ => panic!("Unexpected event"),
8953         };
8954
8955         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8956         check_added_monitors!(nodes[2], 1);
8957         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8958         check_added_monitors!(nodes[2], 1);
8959
8960         let events = nodes[2].node.get_and_clear_pending_msg_events();
8961         assert_eq!(events.len(), 1);
8962         let carol_revocation = match events[0] {
8963                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8964                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8965                         (*msg).clone()
8966                 },
8967                 _ => panic!("Unexpected event"),
8968         };
8969         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8970         check_added_monitors!(nodes[1], 1);
8971
8972         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8973         // here's where we put said channel's commitment tx on-chain.
8974         let mut txn_to_broadcast = alice_txn.clone();
8975         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8976         if !go_onchain_before_fulfill {
8977                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8978                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8979                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8980                 if broadcast_alice {
8981                         check_closed_broadcast!(nodes[1], true);
8982                         check_added_monitors!(nodes[1], 1);
8983                 }
8984                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8985                 if broadcast_alice {
8986                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8987                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8988                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8989                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8990                         // broadcasted.
8991                         assert_eq!(bob_txn.len(), 3);
8992                         check_spends!(bob_txn[1], chan_ab.3);
8993                 } else {
8994                         assert_eq!(bob_txn.len(), 2);
8995                         check_spends!(bob_txn[0], chan_ab.3);
8996                 }
8997         }
8998
8999         // Step (6):
9000         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9001         // broadcasted commitment transaction.
9002         {
9003                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9004                 if go_onchain_before_fulfill {
9005                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9006                         assert_eq!(bob_txn.len(), 2);
9007                 }
9008                 let script_weight = match broadcast_alice {
9009                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9010                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9011                 };
9012                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9013                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9014                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9015                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9016                 if broadcast_alice && !go_onchain_before_fulfill {
9017                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9018                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9019                 } else {
9020                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9021                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9022                 }
9023         }
9024 }
9025
9026 #[test]
9027 fn test_onchain_htlc_settlement_after_close() {
9028         do_test_onchain_htlc_settlement_after_close(true, true);
9029         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9030         do_test_onchain_htlc_settlement_after_close(true, false);
9031         do_test_onchain_htlc_settlement_after_close(false, false);
9032 }
9033
9034 #[test]
9035 fn test_duplicate_chan_id() {
9036         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9037         // already open we reject it and keep the old channel.
9038         //
9039         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9040         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9041         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9042         // updating logic for the existing channel.
9043         let chanmon_cfgs = create_chanmon_cfgs(2);
9044         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9045         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9046         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9047
9048         // Create an initial channel
9049         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9050         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9051         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9052         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()));
9053
9054         // Try to create a second channel with the same temporary_channel_id as the first and check
9055         // that it is rejected.
9056         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9057         {
9058                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9059                 assert_eq!(events.len(), 1);
9060                 match events[0] {
9061                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9062                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9063                                 // first (valid) and second (invalid) channels are closed, given they both have
9064                                 // the same non-temporary channel_id. However, currently we do not, so we just
9065                                 // move forward with it.
9066                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9067                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9068                         },
9069                         _ => panic!("Unexpected event"),
9070                 }
9071         }
9072
9073         // Move the first channel through the funding flow...
9074         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9075
9076         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9077         check_added_monitors!(nodes[0], 0);
9078
9079         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9080         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9081         {
9082                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9083                 assert_eq!(added_monitors.len(), 1);
9084                 assert_eq!(added_monitors[0].0, funding_output);
9085                 added_monitors.clear();
9086         }
9087         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9088
9089         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9090         let channel_id = funding_outpoint.to_channel_id();
9091
9092         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9093         // temporary one).
9094
9095         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9096         // Technically this is allowed by the spec, but we don't support it and there's little reason
9097         // to. Still, it shouldn't cause any other issues.
9098         open_chan_msg.temporary_channel_id = channel_id;
9099         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9100         {
9101                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9102                 assert_eq!(events.len(), 1);
9103                 match events[0] {
9104                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9105                                 // Technically, at this point, nodes[1] would be justified in thinking both
9106                                 // channels are closed, but currently we do not, so we just move forward with it.
9107                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9108                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9109                         },
9110                         _ => panic!("Unexpected event"),
9111                 }
9112         }
9113
9114         // Now try to create a second channel which has a duplicate funding output.
9115         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9116         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9117         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9118         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()));
9119         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9120
9121         let funding_created = {
9122                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9123                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9124                 let logger = test_utils::TestLogger::new();
9125                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9126         };
9127         check_added_monitors!(nodes[0], 0);
9128         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9129         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9130         // still needs to be cleared here.
9131         check_added_monitors!(nodes[1], 1);
9132
9133         // ...still, nodes[1] will reject the duplicate channel.
9134         {
9135                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9136                 assert_eq!(events.len(), 1);
9137                 match events[0] {
9138                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9139                                 // Technically, at this point, nodes[1] would be justified in thinking both
9140                                 // channels are closed, but currently we do not, so we just move forward with it.
9141                                 assert_eq!(msg.channel_id, channel_id);
9142                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9143                         },
9144                         _ => panic!("Unexpected event"),
9145                 }
9146         }
9147
9148         // finally, finish creating the original channel and send a payment over it to make sure
9149         // everything is functional.
9150         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9151         {
9152                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9153                 assert_eq!(added_monitors.len(), 1);
9154                 assert_eq!(added_monitors[0].0, funding_output);
9155                 added_monitors.clear();
9156         }
9157
9158         let events_4 = nodes[0].node.get_and_clear_pending_events();
9159         assert_eq!(events_4.len(), 0);
9160         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9161         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9162
9163         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9164         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9165         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9166         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9167 }
9168
9169 #[test]
9170 fn test_error_chans_closed() {
9171         // Test that we properly handle error messages, closing appropriate channels.
9172         //
9173         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9174         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9175         // we can test various edge cases around it to ensure we don't regress.
9176         let chanmon_cfgs = create_chanmon_cfgs(3);
9177         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9178         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9179         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9180
9181         // Create some initial channels
9182         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9183         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9184         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9185
9186         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9187         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9188         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9189
9190         // Closing a channel from a different peer has no effect
9191         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9192         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9193
9194         // Closing one channel doesn't impact others
9195         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9196         check_added_monitors!(nodes[0], 1);
9197         check_closed_broadcast!(nodes[0], false);
9198         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9199         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9200         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);
9201         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);
9202
9203         // A null channel ID should close all channels
9204         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9205         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9206         check_added_monitors!(nodes[0], 2);
9207         let events = nodes[0].node.get_and_clear_pending_msg_events();
9208         assert_eq!(events.len(), 2);
9209         match events[0] {
9210                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9211                         assert_eq!(msg.contents.flags & 2, 2);
9212                 },
9213                 _ => panic!("Unexpected event"),
9214         }
9215         match events[1] {
9216                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9217                         assert_eq!(msg.contents.flags & 2, 2);
9218                 },
9219                 _ => panic!("Unexpected event"),
9220         }
9221         // Note that at this point users of a standard PeerHandler will end up calling
9222         // peer_disconnected with no_connection_possible set to false, duplicating the
9223         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9224         // users with their own peer handling logic. We duplicate the call here, however.
9225         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9226         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9227
9228         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9229         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9230         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9231 }
9232
9233 #[test]
9234 fn test_invalid_funding_tx() {
9235         // Test that we properly handle invalid funding transactions sent to us from a peer.
9236         //
9237         // Previously, all other major lightning implementations had failed to properly sanitize
9238         // funding transactions from their counterparties, leading to a multi-implementation critical
9239         // security vulnerability (though we always sanitized properly, we've previously had
9240         // un-released crashes in the sanitization process).
9241         let chanmon_cfgs = create_chanmon_cfgs(2);
9242         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9243         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9244         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9245
9246         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9247         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()));
9248         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()));
9249
9250         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9251         for output in tx.output.iter_mut() {
9252                 // Make the confirmed funding transaction have a bogus script_pubkey
9253                 output.script_pubkey = bitcoin::Script::new();
9254         }
9255
9256         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9257         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()));
9258         check_added_monitors!(nodes[1], 1);
9259
9260         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()));
9261         check_added_monitors!(nodes[0], 1);
9262
9263         let events_1 = nodes[0].node.get_and_clear_pending_events();
9264         assert_eq!(events_1.len(), 0);
9265
9266         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9267         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9268         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9269
9270         confirm_transaction_at(&nodes[1], &tx, 1);
9271         check_added_monitors!(nodes[1], 1);
9272         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9273         assert_eq!(events_2.len(), 1);
9274         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9275                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9276                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9277                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9278                 } else { panic!(); }
9279         } else { panic!(); }
9280         assert_eq!(nodes[1].node.list_channels().len(), 0);
9281 }