_ 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::{Confirm, Listen, Watch};
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface::{KeysInterface, BaseSign};
  20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
  26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route};
  27 use routing::network_graph::RoutingFees;
  28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  29 use ln::msgs;
  30 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  31 use util::enforcing_trait_impls::EnforcingSigner;
  32 use util::{byte_utils, test_utils};
  33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
  34 use util::errors::APIError;
  35 use util::ser::{Writeable, ReadableArgs};
  36 use util::config::UserConfig;
  37
  38 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  39 use bitcoin::hash_types::{Txid, BlockHash};
  40 use bitcoin::blockdata::block::{Block, BlockHeader};
  41 use bitcoin::blockdata::script::Builder;
  42 use bitcoin::blockdata::opcodes;
  43 use bitcoin::blockdata::constants::genesis_block;
  44 use bitcoin::network::constants::Network;
  45
  46 use bitcoin::hashes::sha256::Hash as Sha256;
  47 use bitcoin::hashes::Hash;
  48
  49 use bitcoin::secp256k1::{Secp256k1, Message};
  50 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  51
  52 use regex;
  53
  54 use prelude::*;
  55 use alloc::collections::BTreeSet;
  56 use core::default::Default;
  57 use sync::{Arc, Mutex};
  58
  59 use ln::functional_test_utils::*;
  60 use ln::chan_utils::CommitmentTransaction;
  61 use ln::msgs::OptionalField::Present;
  62
  63 #[test]
  64 fn test_insane_channel_opens() {
  65         // Stand up a network of 2 nodes
  66         let chanmon_cfgs = create_chanmon_cfgs(2);
  67         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  68         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  69         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  70
  71         // Instantiate channel parameters where we push the maximum msats given our
  72         // funding satoshis
  73         let channel_value_sat = 31337; // same as funding satoshis
  74         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  75         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  76
  77         // Have node0 initiate a channel to node1 with aforementioned parameters
  78         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  79
  80         // Extract the channel open message from node0 to node1
  81         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  82
  83         // Test helper that asserts we get the correct error string given a mutator
  84         // that supposedly makes the channel open message insane
  85         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  86                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  87                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  88                 assert_eq!(msg_events.len(), 1);
  89                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  90                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  91                         match action {
  92                                 &ErrorAction::SendErrorMessage { .. } => {
  93                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  94                                 },
  95                                 _ => panic!("unexpected event!"),
  96                         }
  97                 } else { assert!(false); }
  98         };
  99
 100         use ln::channel::MAX_FUNDING_SATOSHIS;
 101         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 102
 103         // Test all mutations that would make the channel open message insane
 104         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 });
 105
 106         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 107
 108         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 });
 109
 110         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 111
 112         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 });
 113
 114         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 });
 115
 116         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 });
 117
 118         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 119
 120         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 121 }
 122
 123 #[test]
 124 fn test_async_inbound_update_fee() {
 125         let chanmon_cfgs = create_chanmon_cfgs(2);
 126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 128         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 129         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 130         let logger = test_utils::TestLogger::new();
 131         let channel_id = chan.2;
 132
 133         // balancing
 134         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 135
 136         // A                                        B
 137         // update_fee                            ->
 138         // send (1) commitment_signed            -.
 139         //                                       <- update_add_htlc/commitment_signed
 140         // send (2) RAA (awaiting remote revoke) -.
 141         // (1) commitment_signed is delivered    ->
 142         //                                       .- send (3) RAA (awaiting remote revoke)
 143         // (2) RAA is delivered                  ->
 144         //                                       .- send (4) commitment_signed
 145         //                                       <- (3) RAA is delivered
 146         // send (5) commitment_signed            -.
 147         //                                       <- (4) commitment_signed is delivered
 148         // send (6) RAA                          -.
 149         // (5) commitment_signed is delivered    ->
 150         //                                       <- RAA
 151         // (6) RAA is delivered                  ->
 152
 153         // First nodes[0] generates an update_fee
 154         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 155         check_added_monitors!(nodes[0], 1);
 156
 157         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 158         assert_eq!(events_0.len(), 1);
 159         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 160                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 161                         (update_fee.as_ref(), commitment_signed)
 162                 },
 163                 _ => panic!("Unexpected event"),
 164         };
 165
 166         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 167
 168         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 169         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 170         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 171         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();
 172         check_added_monitors!(nodes[1], 1);
 173
 174         let payment_event = {
 175                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 176                 assert_eq!(events_1.len(), 1);
 177                 SendEvent::from_event(events_1.remove(0))
 178         };
 179         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 180         assert_eq!(payment_event.msgs.len(), 1);
 181
 182         // ...now when the messages get delivered everyone should be happy
 183         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 184         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 185         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 186         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 187         check_added_monitors!(nodes[0], 1);
 188
 189         // deliver(1), generate (3):
 190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 191         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 192         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 193         check_added_monitors!(nodes[1], 1);
 194
 195         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 196         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 197         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fee.is_none()); // (4)
 202         check_added_monitors!(nodes[1], 1);
 203
 204         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 205         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 206         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fee.is_none()); // (5)
 211         check_added_monitors!(nodes[0], 1);
 212
 213         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 214         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 215         // only (6) so get_event_msg's assert(len == 1) passes
 216         check_added_monitors!(nodes[0], 1);
 217
 218         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 219         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 220         check_added_monitors!(nodes[1], 1);
 221
 222         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 223         check_added_monitors!(nodes[0], 1);
 224
 225         let events_2 = nodes[0].node.get_and_clear_pending_events();
 226         assert_eq!(events_2.len(), 1);
 227         match events_2[0] {
 228                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 229                 _ => panic!("Unexpected event"),
 230         }
 231
 232         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 233         check_added_monitors!(nodes[1], 1);
 234 }
 235
 236 #[test]
 237 fn test_update_fee_unordered_raa() {
 238         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 239         // crash in an earlier version of the update_fee patch)
 240         let chanmon_cfgs = create_chanmon_cfgs(2);
 241         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 242         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 243         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 244         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 245         let channel_id = chan.2;
 246         let logger = test_utils::TestLogger::new();
 247
 248         // balancing
 249         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 250
 251         // First nodes[0] generates an update_fee
 252         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 253         check_added_monitors!(nodes[0], 1);
 254
 255         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 256         assert_eq!(events_0.len(), 1);
 257         let update_msg = match events_0[0] { // (1)
 258                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 259                         update_fee.as_ref()
 260                 },
 261                 _ => panic!("Unexpected event"),
 262         };
 263
 264         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 265
 266         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 267         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 268         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 269         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();
 270         check_added_monitors!(nodes[1], 1);
 271
 272         let payment_event = {
 273                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 274                 assert_eq!(events_1.len(), 1);
 275                 SendEvent::from_event(events_1.remove(0))
 276         };
 277         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 278         assert_eq!(payment_event.msgs.len(), 1);
 279
 280         // ...now when the messages get delivered everyone should be happy
 281         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 282         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 283         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 284         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 285         check_added_monitors!(nodes[0], 1);
 286
 287         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 288         check_added_monitors!(nodes[1], 1);
 289
 290         // We can't continue, sadly, because our (1) now has a bogus signature
 291 }
 292
 293 #[test]
 294 fn test_multi_flight_update_fee() {
 295         let chanmon_cfgs = create_chanmon_cfgs(2);
 296         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 297         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 298         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 299         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 300         let channel_id = chan.2;
 301
 302         // A                                        B
 303         // update_fee/commitment_signed          ->
 304         //                                       .- send (1) RAA and (2) commitment_signed
 305         // update_fee (never committed)          ->
 306         // (3) update_fee                        ->
 307         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 308         // don't track which updates correspond to which revoke_and_ack responses so we're in
 309         // AwaitingRAA mode and will not generate the update_fee yet.
 310         //                                       <- (1) RAA delivered
 311         // (3) is generated and send (4) CS      -.
 312         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 313         // know the per_commitment_point to use for it.
 314         //                                       <- (2) commitment_signed delivered
 315         // revoke_and_ack                        ->
 316         //                                          B should send no response here
 317         // (4) commitment_signed delivered       ->
 318         //                                       <- RAA/commitment_signed delivered
 319         // revoke_and_ack                        ->
 320
 321         // First nodes[0] generates an update_fee
 322         let initial_feerate = get_feerate!(nodes[0], channel_id);
 323         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 324         check_added_monitors!(nodes[0], 1);
 325
 326         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 327         assert_eq!(events_0.len(), 1);
 328         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 329                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 330                         (update_fee.as_ref().unwrap(), commitment_signed)
 331                 },
 332                 _ => panic!("Unexpected event"),
 333         };
 334
 335         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 336         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 337         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 338         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 339         check_added_monitors!(nodes[1], 1);
 340
 341         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 342         // transaction:
 343         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 344         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 346
 347         // Create the (3) update_fee message that nodes[0] will generate before it does...
 348         let mut update_msg_2 = msgs::UpdateFee {
 349                 channel_id: update_msg_1.channel_id.clone(),
 350                 feerate_per_kw: (initial_feerate + 30) as u32,
 351         };
 352
 353         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 354
 355         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 356         // Deliver (3)
 357         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 358
 359         // Deliver (1), generating (3) and (4)
 360         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 361         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 362         check_added_monitors!(nodes[0], 1);
 363         assert!(as_second_update.update_add_htlcs.is_empty());
 364         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 365         assert!(as_second_update.update_fail_htlcs.is_empty());
 366         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 367         // Check that the update_fee newly generated matches what we delivered:
 368         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 369         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 370
 371         // Deliver (2) commitment_signed
 372         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 373         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 374         check_added_monitors!(nodes[0], 1);
 375         // No commitment_signed so get_event_msg's assert(len == 1) passes
 376
 377         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 378         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 379         check_added_monitors!(nodes[1], 1);
 380
 381         // Delever (4)
 382         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 383         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 384         check_added_monitors!(nodes[1], 1);
 385
 386         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 387         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 388         check_added_monitors!(nodes[0], 1);
 389
 390         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 391         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 392         // No commitment_signed so get_event_msg's assert(len == 1) passes
 393         check_added_monitors!(nodes[0], 1);
 394
 395         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 396         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 397         check_added_monitors!(nodes[1], 1);
 398 }
 399
 400 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 401         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 402         // tests that we properly send one in that case.
 403         let mut alice_config = UserConfig::default();
 404         alice_config.own_channel_config.minimum_depth = 1;
 405         alice_config.channel_options.announced_channel = true;
 406         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 407         let mut bob_config = UserConfig::default();
 408         bob_config.own_channel_config.minimum_depth = 1;
 409         bob_config.channel_options.announced_channel = true;
 410         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 411         let chanmon_cfgs = create_chanmon_cfgs(2);
 412         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 413         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 414         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 415         *nodes[0].connect_style.borrow_mut() = connect_style;
 416
 417         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 418         mine_transaction(&nodes[1], &tx);
 419         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()));
 420
 421         mine_transaction(&nodes[0], &tx);
 422         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 423         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 424
 425         for node in nodes {
 426                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 427                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 428                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 429         }
 430 }
 431 #[test]
 432 fn test_1_conf_open() {
 433         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 434         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 435         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 436 }
 437
 438 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 439         // Previously, we had issues deserializing channels when we hadn't connected the first block
 440         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 441         // serialization round-trips and simply do steps towards opening a channel and then drop the
 442         // Node objects.
 443
 444         let chanmon_cfgs = create_chanmon_cfgs(2);
 445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 448
 449         if steps & 0b1000_0000 != 0{
 450                 let block = Block {
 451                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 452                         txdata: vec![],
 453                 };
 454                 connect_block(&nodes[0], &block);
 455                 connect_block(&nodes[1], &block);
 456         }
 457
 458         if steps & 0x0f == 0 { return; }
 459         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 460         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 461
 462         if steps & 0x0f == 1 { return; }
 463         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 464         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 465
 466         if steps & 0x0f == 2 { return; }
 467         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 468
 469         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 470
 471         if steps & 0x0f == 3 { return; }
 472         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 473         check_added_monitors!(nodes[0], 0);
 474         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 475
 476         if steps & 0x0f == 4 { return; }
 477         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 478         {
 479                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 480                 assert_eq!(added_monitors.len(), 1);
 481                 assert_eq!(added_monitors[0].0, funding_output);
 482                 added_monitors.clear();
 483         }
 484         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 485
 486         if steps & 0x0f == 5 { return; }
 487         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 488         {
 489                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 490                 assert_eq!(added_monitors.len(), 1);
 491                 assert_eq!(added_monitors[0].0, funding_output);
 492                 added_monitors.clear();
 493         }
 494
 495         let events_4 = nodes[0].node.get_and_clear_pending_events();
 496         assert_eq!(events_4.len(), 0);
 497
 498         if steps & 0x0f == 6 { return; }
 499         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 500
 501         if steps & 0x0f == 7 { return; }
 502         confirm_transaction_at(&nodes[0], &tx, 2);
 503         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 504         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 505 }
 506
 507 #[test]
 508 fn test_sanity_on_in_flight_opens() {
 509         do_test_sanity_on_in_flight_opens(0);
 510         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(1);
 512         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(2);
 514         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(3);
 516         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(4);
 518         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(5);
 520         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(6);
 522         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(7);
 524         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(8);
 526         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 527 }
 528
 529 #[test]
 530 fn test_update_fee_vanilla() {
 531         let chanmon_cfgs = create_chanmon_cfgs(2);
 532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 535         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 536         let channel_id = chan.2;
 537
 538         let feerate = get_feerate!(nodes[0], channel_id);
 539         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 540         check_added_monitors!(nodes[0], 1);
 541
 542         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 543         assert_eq!(events_0.len(), 1);
 544         let (update_msg, commitment_signed) = match events_0[0] {
 545                         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 } } => {
 546                         (update_fee.as_ref(), commitment_signed)
 547                 },
 548                 _ => panic!("Unexpected event"),
 549         };
 550         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 551
 552         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 553         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 554         check_added_monitors!(nodes[1], 1);
 555
 556         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[0], 1);
 559
 560         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 561         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 562         // No commitment_signed so get_event_msg's assert(len == 1) passes
 563         check_added_monitors!(nodes[0], 1);
 564
 565         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 567         check_added_monitors!(nodes[1], 1);
 568 }
 569
 570 #[test]
 571 fn test_update_fee_that_funder_cannot_afford() {
 572         let chanmon_cfgs = create_chanmon_cfgs(2);
 573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 575         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 576         let channel_value = 1888;
 577         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 578         let channel_id = chan.2;
 579
 580         let feerate = 260;
 581         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 582         check_added_monitors!(nodes[0], 1);
 583         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 584
 585         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 586
 587         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 588
 589         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 590         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 591         {
 592                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 593
 594                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 595                 let num_htlcs = commitment_tx.output.len() - 2;
 596                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 597                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 598                 actual_fee = channel_value - actual_fee;
 599                 assert_eq!(total_fee, actual_fee);
 600         }
 601
 602         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 603         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 604         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 605         check_added_monitors!(nodes[0], 1);
 606
 607         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 608
 609         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 610
 611         //While producing the commitment_signed response after handling a received update_fee request the
 612         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 613         //Should produce and error.
 614         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 615         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 616         check_added_monitors!(nodes[1], 1);
 617         check_closed_broadcast!(nodes[1], true);
 618 }
 619
 620 #[test]
 621 fn test_update_fee_with_fundee_update_add_htlc() {
 622         let chanmon_cfgs = create_chanmon_cfgs(2);
 623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 626         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 627         let channel_id = chan.2;
 628         let logger = test_utils::TestLogger::new();
 629
 630         // balancing
 631         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 632
 633         let feerate = get_feerate!(nodes[0], channel_id);
 634         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 635         check_added_monitors!(nodes[0], 1);
 636
 637         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 638         assert_eq!(events_0.len(), 1);
 639         let (update_msg, commitment_signed) = match events_0[0] {
 640                         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 } } => {
 641                         (update_fee.as_ref(), commitment_signed)
 642                 },
 643                 _ => panic!("Unexpected event"),
 644         };
 645         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 646         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 647         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         check_added_monitors!(nodes[1], 1);
 649
 650         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 651         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 652         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();
 653
 654         // nothing happens since node[1] is in AwaitingRemoteRevoke
 655         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 656         {
 657                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 658                 assert_eq!(added_monitors.len(), 0);
 659                 added_monitors.clear();
 660         }
 661         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 663         // node[1] has nothing to do
 664
 665         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         check_added_monitors!(nodes[0], 1);
 668
 669         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 670         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 671         // No commitment_signed so get_event_msg's assert(len == 1) passes
 672         check_added_monitors!(nodes[0], 1);
 673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 674         check_added_monitors!(nodes[1], 1);
 675         // AwaitingRemoteRevoke ends here
 676
 677         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 678         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 679         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 681         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 682         assert_eq!(commitment_update.update_fee.is_none(), true);
 683
 684         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 685         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 686         check_added_monitors!(nodes[0], 1);
 687         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 688
 689         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 690         check_added_monitors!(nodes[1], 1);
 691         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 692
 693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 694         check_added_monitors!(nodes[1], 1);
 695         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 696         // No commitment_signed so get_event_msg's assert(len == 1) passes
 697
 698         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 699         check_added_monitors!(nodes[0], 1);
 700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 701
 702         expect_pending_htlcs_forwardable!(nodes[0]);
 703
 704         let events = nodes[0].node.get_and_clear_pending_events();
 705         assert_eq!(events.len(), 1);
 706         match events[0] {
 707                 Event::PaymentReceived { .. } => { },
 708                 _ => panic!("Unexpected event"),
 709         };
 710
 711         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 712
 713         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 714         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 715         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 716 }
 717
 718 #[test]
 719 fn test_update_fee() {
 720         let chanmon_cfgs = create_chanmon_cfgs(2);
 721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 724         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 725         let channel_id = chan.2;
 726
 727         // A                                        B
 728         // (1) update_fee/commitment_signed      ->
 729         //                                       <- (2) revoke_and_ack
 730         //                                       .- send (3) commitment_signed
 731         // (4) update_fee/commitment_signed      ->
 732         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 733         //                                       <- (3) commitment_signed delivered
 734         // send (6) revoke_and_ack               -.
 735         //                                       <- (5) deliver revoke_and_ack
 736         // (6) deliver revoke_and_ack            ->
 737         //                                       .- send (7) commitment_signed in response to (4)
 738         //                                       <- (7) deliver commitment_signed
 739         // revoke_and_ack                        ->
 740
 741         // Create and deliver (1)...
 742         let feerate = get_feerate!(nodes[0], channel_id);
 743         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 744         check_added_monitors!(nodes[0], 1);
 745
 746         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(events_0.len(), 1);
 748         let (update_msg, commitment_signed) = match events_0[0] {
 749                         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 } } => {
 750                         (update_fee.as_ref(), commitment_signed)
 751                 },
 752                 _ => panic!("Unexpected event"),
 753         };
 754         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 755
 756         // Generate (2) and (3):
 757         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 758         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 759         check_added_monitors!(nodes[1], 1);
 760
 761         // Deliver (2):
 762         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 763         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 764         check_added_monitors!(nodes[0], 1);
 765
 766         // Create and deliver (4)...
 767         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 768         check_added_monitors!(nodes[0], 1);
 769         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 770         assert_eq!(events_0.len(), 1);
 771         let (update_msg, commitment_signed) = match events_0[0] {
 772                         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 } } => {
 773                         (update_fee.as_ref(), commitment_signed)
 774                 },
 775                 _ => panic!("Unexpected event"),
 776         };
 777
 778         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 779         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 780         check_added_monitors!(nodes[1], 1);
 781         // ... creating (5)
 782         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 783         // No commitment_signed so get_event_msg's assert(len == 1) passes
 784
 785         // Handle (3), creating (6):
 786         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 787         check_added_monitors!(nodes[0], 1);
 788         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 789         // No commitment_signed so get_event_msg's assert(len == 1) passes
 790
 791         // Deliver (5):
 792         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 793         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 794         check_added_monitors!(nodes[0], 1);
 795
 796         // Deliver (6), creating (7):
 797         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 798         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 799         assert!(commitment_update.update_add_htlcs.is_empty());
 800         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 801         assert!(commitment_update.update_fail_htlcs.is_empty());
 802         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 803         assert!(commitment_update.update_fee.is_none());
 804         check_added_monitors!(nodes[1], 1);
 805
 806         // Deliver (7)
 807         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 808         check_added_monitors!(nodes[0], 1);
 809         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 810         // No commitment_signed so get_event_msg's assert(len == 1) passes
 811
 812         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 813         check_added_monitors!(nodes[1], 1);
 814         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 815
 816         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 817         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 818         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 819 }
 820
 821 #[test]
 822 fn pre_funding_lock_shutdown_test() {
 823         // Test sending a shutdown prior to funding_locked after funding generation
 824         let chanmon_cfgs = create_chanmon_cfgs(2);
 825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 828         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 829         mine_transaction(&nodes[0], &tx);
 830         mine_transaction(&nodes[1], &tx);
 831
 832         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 833         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 834         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 835         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 836         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 837
 838         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 840         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 842         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 843         assert!(node_0_none.is_none());
 844
 845         assert!(nodes[0].node.list_channels().is_empty());
 846         assert!(nodes[1].node.list_channels().is_empty());
 847 }
 848
 849 #[test]
 850 fn updates_shutdown_wait() {
 851         // Test sending a shutdown with outstanding updates pending
 852         let chanmon_cfgs = create_chanmon_cfgs(3);
 853         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 854         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 855         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 856         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 857         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 858         let logger = test_utils::TestLogger::new();
 859
 860         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 861
 862         nodes[0].node.close_channel(&chan_1.2).unwrap();
 863         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 864         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 865         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 866         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 867
 868         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 869         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 870
 871         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 872
 873         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 874         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 875         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();
 876         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();
 877         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 878         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 879
 880         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 881         check_added_monitors!(nodes[2], 1);
 882         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 883         assert!(updates.update_add_htlcs.is_empty());
 884         assert!(updates.update_fail_htlcs.is_empty());
 885         assert!(updates.update_fail_malformed_htlcs.is_empty());
 886         assert!(updates.update_fee.is_none());
 887         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 888         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 889         check_added_monitors!(nodes[1], 1);
 890         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 891         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 892
 893         assert!(updates_2.update_add_htlcs.is_empty());
 894         assert!(updates_2.update_fail_htlcs.is_empty());
 895         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 896         assert!(updates_2.update_fee.is_none());
 897         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 898         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 899         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 900
 901         let events = nodes[0].node.get_and_clear_pending_events();
 902         assert_eq!(events.len(), 1);
 903         match events[0] {
 904                 Event::PaymentSent { ref payment_preimage } => {
 905                         assert_eq!(our_payment_preimage, *payment_preimage);
 906                 },
 907                 _ => panic!("Unexpected event"),
 908         }
 909
 910         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 911         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 912         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 913         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 914         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 915         assert!(node_0_none.is_none());
 916
 917         assert!(nodes[0].node.list_channels().is_empty());
 918
 919         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 920         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 921         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 922         assert!(nodes[1].node.list_channels().is_empty());
 923         assert!(nodes[2].node.list_channels().is_empty());
 924 }
 925
 926 #[test]
 927 fn htlc_fail_async_shutdown() {
 928         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 929         let chanmon_cfgs = create_chanmon_cfgs(3);
 930         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 931         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 932         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 933         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 934         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 935         let logger = test_utils::TestLogger::new();
 936
 937         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 938         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 939         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();
 940         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 941         check_added_monitors!(nodes[0], 1);
 942         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 943         assert_eq!(updates.update_add_htlcs.len(), 1);
 944         assert!(updates.update_fulfill_htlcs.is_empty());
 945         assert!(updates.update_fail_htlcs.is_empty());
 946         assert!(updates.update_fail_malformed_htlcs.is_empty());
 947         assert!(updates.update_fee.is_none());
 948
 949         nodes[1].node.close_channel(&chan_1.2).unwrap();
 950         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 951         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 952         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 953
 954         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 955         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 956         check_added_monitors!(nodes[1], 1);
 957         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 958         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 959
 960         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 961         assert!(updates_2.update_add_htlcs.is_empty());
 962         assert!(updates_2.update_fulfill_htlcs.is_empty());
 963         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 964         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 965         assert!(updates_2.update_fee.is_none());
 966
 967         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 968         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 969
 970         expect_payment_failed!(nodes[0], our_payment_hash, false);
 971
 972         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 973         assert_eq!(msg_events.len(), 2);
 974         let node_0_closing_signed = match msg_events[0] {
 975                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 976                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 977                         (*msg).clone()
 978                 },
 979                 _ => panic!("Unexpected event"),
 980         };
 981         match msg_events[1] {
 982                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 983                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 984                 },
 985                 _ => panic!("Unexpected event"),
 986         }
 987
 988         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 989         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 990         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 991         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 992         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 993         assert!(node_0_none.is_none());
 994
 995         assert!(nodes[0].node.list_channels().is_empty());
 996
 997         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 998         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 999         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1000         assert!(nodes[1].node.list_channels().is_empty());
1001         assert!(nodes[2].node.list_channels().is_empty());
1002 }
1003
1004 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1005         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1006         // messages delivered prior to disconnect
1007         let chanmon_cfgs = create_chanmon_cfgs(3);
1008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1010         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1011         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1012         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013
1014         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1015
1016         nodes[1].node.close_channel(&chan_1.2).unwrap();
1017         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1018         if recv_count > 0 {
1019                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1020                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1021                 if recv_count > 1 {
1022                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1023                 }
1024         }
1025
1026         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1027         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1028
1029         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1031         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1032         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1033
1034         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1035         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1036         assert!(node_1_shutdown == node_1_2nd_shutdown);
1037
1038         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1039         let node_0_2nd_shutdown = if recv_count > 0 {
1040                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1041                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1042                 node_0_2nd_shutdown
1043         } else {
1044                 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1045                 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1047                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1048         };
1049         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1050
1051         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1052         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1053
1054         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1055         check_added_monitors!(nodes[2], 1);
1056         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1057         assert!(updates.update_add_htlcs.is_empty());
1058         assert!(updates.update_fail_htlcs.is_empty());
1059         assert!(updates.update_fail_malformed_htlcs.is_empty());
1060         assert!(updates.update_fee.is_none());
1061         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1062         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1063         check_added_monitors!(nodes[1], 1);
1064         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1065         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1066
1067         assert!(updates_2.update_add_htlcs.is_empty());
1068         assert!(updates_2.update_fail_htlcs.is_empty());
1069         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1070         assert!(updates_2.update_fee.is_none());
1071         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1072         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1073         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1074
1075         let events = nodes[0].node.get_and_clear_pending_events();
1076         assert_eq!(events.len(), 1);
1077         match events[0] {
1078                 Event::PaymentSent { ref payment_preimage } => {
1079                         assert_eq!(our_payment_preimage, *payment_preimage);
1080                 },
1081                 _ => panic!("Unexpected event"),
1082         }
1083
1084         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1085         if recv_count > 0 {
1086                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1087                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1088                 assert!(node_1_closing_signed.is_some());
1089         }
1090
1091         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1092         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1093
1094         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1096         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1097         if recv_count == 0 {
1098                 // If all closing_signeds weren't delivered we can just resume where we left off...
1099                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1100
1101                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1102                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1103                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1104
1105                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1106                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1107                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1108
1109                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1110                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1111
1112                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1113                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1115
1116                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1117                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1118                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1119                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1120                 assert!(node_0_none.is_none());
1121         } else {
1122                 // If one node, however, received + responded with an identical closing_signed we end
1123                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1124                 // There isn't really anything better we can do simply, but in the future we might
1125                 // explore storing a set of recently-closed channels that got disconnected during
1126                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1127                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1128                 // transaction.
1129                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1130
1131                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1132                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1133                 assert_eq!(msg_events.len(), 1);
1134                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1135                         match action {
1136                                 &ErrorAction::SendErrorMessage { ref msg } => {
1137                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1138                                         assert_eq!(msg.channel_id, chan_1.2);
1139                                 },
1140                                 _ => panic!("Unexpected event!"),
1141                         }
1142                 } else { panic!("Needed SendErrorMessage close"); }
1143
1144                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1145                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1146                 // closing_signed so we do it ourselves
1147                 check_closed_broadcast!(nodes[0], false);
1148                 check_added_monitors!(nodes[0], 1);
1149         }
1150
1151         assert!(nodes[0].node.list_channels().is_empty());
1152
1153         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1154         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1155         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1156         assert!(nodes[1].node.list_channels().is_empty());
1157         assert!(nodes[2].node.list_channels().is_empty());
1158 }
1159
1160 #[test]
1161 fn test_shutdown_rebroadcast() {
1162         do_test_shutdown_rebroadcast(0);
1163         do_test_shutdown_rebroadcast(1);
1164         do_test_shutdown_rebroadcast(2);
1165 }
1166
1167 #[test]
1168 fn fake_network_test() {
1169         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1170         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1171         let chanmon_cfgs = create_chanmon_cfgs(4);
1172         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1173         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1174         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1175
1176         // Create some initial channels
1177         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1178         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1179         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1180
1181         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1185         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1186
1187         // Send some more payments
1188         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1189         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1190         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1191
1192         // Test failure packets
1193         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1194         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1195
1196         // Add a new channel that skips 3
1197         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1198
1199         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1200         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1206
1207         // Do some rebalance loop payments, simultaneously
1208         let mut hops = Vec::with_capacity(3);
1209         hops.push(RouteHop {
1210                 pubkey: nodes[2].node.get_our_node_id(),
1211                 node_features: NodeFeatures::empty(),
1212                 short_channel_id: chan_2.0.contents.short_channel_id,
1213                 channel_features: ChannelFeatures::empty(),
1214                 fee_msat: 0,
1215                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1216         });
1217         hops.push(RouteHop {
1218                 pubkey: nodes[3].node.get_our_node_id(),
1219                 node_features: NodeFeatures::empty(),
1220                 short_channel_id: chan_3.0.contents.short_channel_id,
1221                 channel_features: ChannelFeatures::empty(),
1222                 fee_msat: 0,
1223                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1224         });
1225         hops.push(RouteHop {
1226                 pubkey: nodes[1].node.get_our_node_id(),
1227                 node_features: NodeFeatures::known(),
1228                 short_channel_id: chan_4.0.contents.short_channel_id,
1229                 channel_features: ChannelFeatures::known(),
1230                 fee_msat: 1000000,
1231                 cltv_expiry_delta: TEST_FINAL_CLTV,
1232         });
1233         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;
1234         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;
1235         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1236
1237         let mut hops = Vec::with_capacity(3);
1238         hops.push(RouteHop {
1239                 pubkey: nodes[3].node.get_our_node_id(),
1240                 node_features: NodeFeatures::empty(),
1241                 short_channel_id: chan_4.0.contents.short_channel_id,
1242                 channel_features: ChannelFeatures::empty(),
1243                 fee_msat: 0,
1244                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1245         });
1246         hops.push(RouteHop {
1247                 pubkey: nodes[2].node.get_our_node_id(),
1248                 node_features: NodeFeatures::empty(),
1249                 short_channel_id: chan_3.0.contents.short_channel_id,
1250                 channel_features: ChannelFeatures::empty(),
1251                 fee_msat: 0,
1252                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1253         });
1254         hops.push(RouteHop {
1255                 pubkey: nodes[1].node.get_our_node_id(),
1256                 node_features: NodeFeatures::known(),
1257                 short_channel_id: chan_2.0.contents.short_channel_id,
1258                 channel_features: ChannelFeatures::known(),
1259                 fee_msat: 1000000,
1260                 cltv_expiry_delta: TEST_FINAL_CLTV,
1261         });
1262         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;
1263         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;
1264         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1265
1266         // Claim the rebalances...
1267         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1268         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1269
1270         // Add a duplicate new channel from 2 to 4
1271         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1272
1273         // Send some payments across both channels
1274         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1277
1278
1279         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1280         let events = nodes[0].node.get_and_clear_pending_msg_events();
1281         assert_eq!(events.len(), 0);
1282         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);
1283
1284         //TODO: Test that routes work again here as we've been notified that the channel is full
1285
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1287         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1288         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1289
1290         // Close down the channels...
1291         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1292         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1293         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1294         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1295         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1296 }
1297
1298 #[test]
1299 fn holding_cell_htlc_counting() {
1300         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1301         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1302         // commitment dance rounds.
1303         let chanmon_cfgs = create_chanmon_cfgs(3);
1304         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1305         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1306         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1307         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1308         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1309         let logger = test_utils::TestLogger::new();
1310
1311         let mut payments = Vec::new();
1312         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1313                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1314                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1315                 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();
1316                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1317                 payments.push((payment_preimage, payment_hash));
1318         }
1319         check_added_monitors!(nodes[1], 1);
1320
1321         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1322         assert_eq!(events.len(), 1);
1323         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1324         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1325
1326         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1327         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1328         // another HTLC.
1329         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1330         {
1331                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1332                 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();
1333                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1334                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1335                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1336                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1337         }
1338
1339         // This should also be true if we try to forward a payment.
1340         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1341         {
1342                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1343                 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();
1344                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1345                 check_added_monitors!(nodes[0], 1);
1346         }
1347
1348         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1349         assert_eq!(events.len(), 1);
1350         let payment_event = SendEvent::from_event(events.pop().unwrap());
1351         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1352
1353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1354         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1355         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1356         // fails), the second will process the resulting failure and fail the HTLC backward.
1357         expect_pending_htlcs_forwardable!(nodes[1]);
1358         expect_pending_htlcs_forwardable!(nodes[1]);
1359         check_added_monitors!(nodes[1], 1);
1360
1361         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1362         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1363         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1364
1365         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1366         expect_payment_failed!(nodes[0], payment_hash_2, false);
1367
1368         // Now forward all the pending HTLCs and claim them back
1369         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1370         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1371         check_added_monitors!(nodes[2], 1);
1372
1373         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1374         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1375         check_added_monitors!(nodes[1], 1);
1376         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1377
1378         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1379         check_added_monitors!(nodes[1], 1);
1380         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1381
1382         for ref update in as_updates.update_add_htlcs.iter() {
1383                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1384         }
1385         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1386         check_added_monitors!(nodes[2], 1);
1387         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1388         check_added_monitors!(nodes[2], 1);
1389         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1390
1391         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1392         check_added_monitors!(nodes[1], 1);
1393         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1394         check_added_monitors!(nodes[1], 1);
1395         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1396
1397         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1398         check_added_monitors!(nodes[2], 1);
1399
1400         expect_pending_htlcs_forwardable!(nodes[2]);
1401
1402         let events = nodes[2].node.get_and_clear_pending_events();
1403         assert_eq!(events.len(), payments.len());
1404         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1405                 match event {
1406                         &Event::PaymentReceived { ref payment_hash, .. } => {
1407                                 assert_eq!(*payment_hash, *hash);
1408                         },
1409                         _ => panic!("Unexpected event"),
1410                 };
1411         }
1412
1413         for (preimage, _) in payments.drain(..) {
1414                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1415         }
1416
1417         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1418 }
1419
1420 #[test]
1421 fn duplicate_htlc_test() {
1422         // Test that we accept duplicate payment_hash HTLCs across the network and that
1423         // claiming/failing them are all separate and don't affect each other
1424         let chanmon_cfgs = create_chanmon_cfgs(6);
1425         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1426         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1427         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1428
1429         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1430         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1431         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1432         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1433         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1434         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1435
1436         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1437
1438         *nodes[0].network_payment_count.borrow_mut() -= 1;
1439         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1443
1444         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1445         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1446         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1447 }
1448
1449 #[test]
1450 fn test_duplicate_htlc_different_direction_onchain() {
1451         // Test that ChannelMonitor doesn't generate 2 preimage txn
1452         // when we have 2 HTLCs with same preimage that go across a node
1453         // in opposite directions, even with the same payment secret.
1454         let chanmon_cfgs = create_chanmon_cfgs(2);
1455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1457         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1458
1459         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1460         let logger = test_utils::TestLogger::new();
1461
1462         // balancing
1463         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1464
1465         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1466
1467         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1468         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();
1469         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1470         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1471
1472         // Provide preimage to node 0 by claiming payment
1473         nodes[0].node.claim_funds(payment_preimage);
1474         check_added_monitors!(nodes[0], 1);
1475
1476         // Broadcast node 1 commitment txn
1477         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1478
1479         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1480         let mut has_both_htlcs = 0; // check htlcs match ones committed
1481         for outp in remote_txn[0].output.iter() {
1482                 if outp.value == 800_000 / 1000 {
1483                         has_both_htlcs += 1;
1484                 } else if outp.value == 900_000 / 1000 {
1485                         has_both_htlcs += 1;
1486                 }
1487         }
1488         assert_eq!(has_both_htlcs, 2);
1489
1490         mine_transaction(&nodes[0], &remote_txn[0]);
1491         check_added_monitors!(nodes[0], 1);
1492         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1493
1494         // Check we only broadcast 1 timeout tx
1495         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1496         assert_eq!(claim_txn.len(), 8);
1497         assert_eq!(claim_txn[1], claim_txn[4]);
1498         assert_eq!(claim_txn[2], claim_txn[5]);
1499         check_spends!(claim_txn[1], chan_1.3);
1500         check_spends!(claim_txn[2], claim_txn[1]);
1501         check_spends!(claim_txn[7], claim_txn[1]);
1502
1503         assert_eq!(claim_txn[0].input.len(), 1);
1504         assert_eq!(claim_txn[3].input.len(), 1);
1505         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1506
1507         assert_eq!(claim_txn[0].input.len(), 1);
1508         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1509         check_spends!(claim_txn[0], remote_txn[0]);
1510         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1511         assert_eq!(claim_txn[6].input.len(), 1);
1512         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1513         check_spends!(claim_txn[6], remote_txn[0]);
1514         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1515
1516         let events = nodes[0].node.get_and_clear_pending_msg_events();
1517         assert_eq!(events.len(), 3);
1518         for e in events {
1519                 match e {
1520                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1521                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1522                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1523                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1524                         },
1525                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1526                                 assert!(update_add_htlcs.is_empty());
1527                                 assert!(update_fail_htlcs.is_empty());
1528                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1529                                 assert!(update_fail_malformed_htlcs.is_empty());
1530                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1531                         },
1532                         _ => panic!("Unexpected event"),
1533                 }
1534         }
1535 }
1536
1537 #[test]
1538 fn test_basic_channel_reserve() {
1539         let chanmon_cfgs = create_chanmon_cfgs(2);
1540         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1541         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1542         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1543         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1544         let logger = test_utils::TestLogger::new();
1545
1546         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1547         let channel_reserve = chan_stat.channel_reserve_msat;
1548
1549         // The 2* and +1 are for the fee spike reserve.
1550         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1551         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1552         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1553         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1554         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1555         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1556         match err {
1557                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1558                         match &fails[0] {
1559                                 &APIError::ChannelUnavailable{ref err} =>
1560                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1561                                 _ => panic!("Unexpected error variant"),
1562                         }
1563                 },
1564                 _ => panic!("Unexpected error variant"),
1565         }
1566         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1567         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1568
1569         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1570 }
1571
1572 #[test]
1573 fn test_fee_spike_violation_fails_htlc() {
1574         let chanmon_cfgs = create_chanmon_cfgs(2);
1575         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1576         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1577         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1578         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1579
1580         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1581         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1582         let secp_ctx = Secp256k1::new();
1583         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1584
1585         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1586
1587         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1588         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1589         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1590         let msg = msgs::UpdateAddHTLC {
1591                 channel_id: chan.2,
1592                 htlc_id: 0,
1593                 amount_msat: htlc_msat,
1594                 payment_hash: payment_hash,
1595                 cltv_expiry: htlc_cltv,
1596                 onion_routing_packet: onion_packet,
1597         };
1598
1599         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1600
1601         // Now manually create the commitment_signed message corresponding to the update_add
1602         // nodes[0] just sent. In the code for construction of this message, "local" refers
1603         // to the sender of the message, and "remote" refers to the receiver.
1604
1605         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1606
1607         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1608
1609         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1610         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1611         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1612                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1613                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1614                 let chan_signer = local_chan.get_signer();
1615                 let pubkeys = chan_signer.pubkeys();
1616                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1617                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1618                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1619         };
1620         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1621                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1622                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1623                 let chan_signer = remote_chan.get_signer();
1624                 let pubkeys = chan_signer.pubkeys();
1625                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1626                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1627         };
1628
1629         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1630         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1631                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1632
1633         // Build the remote commitment transaction so we can sign it, and then later use the
1634         // signature for the commitment_signed message.
1635         let local_chan_balance = 1313;
1636
1637         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1638                 offered: false,
1639                 amount_msat: 3460001,
1640                 cltv_expiry: htlc_cltv,
1641                 payment_hash,
1642                 transaction_output_index: Some(1),
1643         };
1644
1645         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1646
1647         let res = {
1648                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1649                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1650                 let local_chan_signer = local_chan.get_signer();
1651                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1652                         commitment_number,
1653                         95000,
1654                         local_chan_balance,
1655                         commit_tx_keys.clone(),
1656                         feerate_per_kw,
1657                         &mut vec![(accepted_htlc_info, ())],
1658                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1659                 );
1660                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1661         };
1662
1663         let commit_signed_msg = msgs::CommitmentSigned {
1664                 channel_id: chan.2,
1665                 signature: res.0,
1666                 htlc_signatures: res.1
1667         };
1668
1669         // Send the commitment_signed message to the nodes[1].
1670         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1671         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1672
1673         // Send the RAA to nodes[1].
1674         let raa_msg = msgs::RevokeAndACK {
1675                 channel_id: chan.2,
1676                 per_commitment_secret: local_secret,
1677                 next_per_commitment_point: next_local_point
1678         };
1679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1680
1681         let events = nodes[1].node.get_and_clear_pending_msg_events();
1682         assert_eq!(events.len(), 1);
1683         // Make sure the HTLC failed in the way we expect.
1684         match events[0] {
1685                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1686                         assert_eq!(update_fail_htlcs.len(), 1);
1687                         update_fail_htlcs[0].clone()
1688                 },
1689                 _ => panic!("Unexpected event"),
1690         };
1691         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1692                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1693
1694         check_added_monitors!(nodes[1], 2);
1695 }
1696
1697 #[test]
1698 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1699         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1700         // Set the fee rate for the channel very high, to the point where the fundee
1701         // sending any above-dust amount would result in a channel reserve violation.
1702         // In this test we check that we would be prevented from sending an HTLC in
1703         // this situation.
1704         let feerate_per_kw = 253;
1705         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1706         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1707         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1708         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1709         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1710
1711         let mut push_amt = 100_000_000;
1712         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1713         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1714
1715         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1716
1717         // Sending exactly enough to hit the reserve amount should be accepted
1718         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1719
1720         // However one more HTLC should be significantly over the reserve amount and fail.
1721         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1722         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1723                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1724         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1725         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);
1726 }
1727
1728 #[test]
1729 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1730         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1731         // Set the fee rate for the channel very high, to the point where the funder
1732         // receiving 1 update_add_htlc would result in them closing the channel due
1733         // to channel reserve violation. This close could also happen if the fee went
1734         // up a more realistic amount, but many HTLCs were outstanding at the time of
1735         // the update_add_htlc.
1736         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1737         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1738         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1739         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1740         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1741         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1742
1743         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1744         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1745         let secp_ctx = Secp256k1::new();
1746         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1747         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1748         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1749         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1750         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1751         let msg = msgs::UpdateAddHTLC {
1752                 channel_id: chan.2,
1753                 htlc_id: 1,
1754                 amount_msat: htlc_msat + 1,
1755                 payment_hash: payment_hash,
1756                 cltv_expiry: htlc_cltv,
1757                 onion_routing_packet: onion_packet,
1758         };
1759
1760         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1761         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1762         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);
1763         assert_eq!(nodes[0].node.list_channels().len(), 0);
1764         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1765         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1766         check_added_monitors!(nodes[0], 1);
1767 }
1768
1769 #[test]
1770 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1771         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1772         // calculating our commitment transaction fee (this was previously broken).
1773         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1774         let feerate_per_kw = 253;
1775         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1776         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1777
1778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1780         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1781
1782         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1783         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1784         // transaction fee with 0 HTLCs (183 sats)).
1785         let mut push_amt = 100_000_000;
1786         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1787         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1788         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1789
1790         let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1791                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1792         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1793         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1794         // commitment transaction fee.
1795         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1796
1797         // One more than the dust amt should fail, however.
1798         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1799         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1800                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1801 }
1802
1803 #[test]
1804 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1805         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1806         // calculating our counterparty's commitment transaction fee (this was previously broken).
1807         let chanmon_cfgs = create_chanmon_cfgs(2);
1808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1810         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1811         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1812
1813         let payment_amt = 46000; // Dust amount
1814         // In the previous code, these first four payments would succeed.
1815         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1816         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1817         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1818         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819
1820         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1821         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1822         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1823         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1824         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1825         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1826
1827         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1828         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1829         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1830         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1831 }
1832
1833 #[test]
1834 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1835         let chanmon_cfgs = create_chanmon_cfgs(3);
1836         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1837         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1838         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1839         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1840         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1841
1842         let feemsat = 239;
1843         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1844         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1845         let feerate = get_feerate!(nodes[0], chan.2);
1846
1847         // Add a 2* and +1 for the fee spike reserve.
1848         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1849         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;
1850         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1851
1852         // Add a pending HTLC.
1853         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1854         let payment_event_1 = {
1855                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1856                 check_added_monitors!(nodes[0], 1);
1857
1858                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1859                 assert_eq!(events.len(), 1);
1860                 SendEvent::from_event(events.remove(0))
1861         };
1862         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1863
1864         // Attempt to trigger a channel reserve violation --> payment failure.
1865         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1866         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;
1867         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1868         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1869
1870         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1871         let secp_ctx = Secp256k1::new();
1872         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1873         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1874         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1875         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1876         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1877         let msg = msgs::UpdateAddHTLC {
1878                 channel_id: chan.2,
1879                 htlc_id: 1,
1880                 amount_msat: htlc_msat + 1,
1881                 payment_hash: our_payment_hash_1,
1882                 cltv_expiry: htlc_cltv,
1883                 onion_routing_packet: onion_packet,
1884         };
1885
1886         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1887         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1888         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1889         assert_eq!(nodes[1].node.list_channels().len(), 1);
1890         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1891         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1892         check_added_monitors!(nodes[1], 1);
1893 }
1894
1895 #[test]
1896 fn test_inbound_outbound_capacity_is_not_zero() {
1897         let chanmon_cfgs = create_chanmon_cfgs(2);
1898         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1899         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1900         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1901         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1902         let channels0 = node_chanmgrs[0].list_channels();
1903         let channels1 = node_chanmgrs[1].list_channels();
1904         assert_eq!(channels0.len(), 1);
1905         assert_eq!(channels1.len(), 1);
1906
1907         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1908         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1909         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1910
1911         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1912         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1913 }
1914
1915 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1916         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1917 }
1918
1919 #[test]
1920 fn test_channel_reserve_holding_cell_htlcs() {
1921         let chanmon_cfgs = create_chanmon_cfgs(3);
1922         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1923         // When this test was written, the default base fee floated based on the HTLC count.
1924         // It is now fixed, so we simply set the fee to the expected value here.
1925         let mut config = test_default_channel_config();
1926         config.channel_options.forwarding_fee_base_msat = 239;
1927         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1928         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1929         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1930         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1931
1932         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1933         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1934
1935         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1936         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1937
1938         macro_rules! expect_forward {
1939                 ($node: expr) => {{
1940                         let mut events = $node.node.get_and_clear_pending_msg_events();
1941                         assert_eq!(events.len(), 1);
1942                         check_added_monitors!($node, 1);
1943                         let payment_event = SendEvent::from_event(events.remove(0));
1944                         payment_event
1945                 }}
1946         }
1947
1948         let feemsat = 239; // set above
1949         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1950         let feerate = get_feerate!(nodes[0], chan_1.2);
1951
1952         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1953
1954         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1955         {
1956                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1957                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1958                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1959                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1960                         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)));
1961                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1962                 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);
1963         }
1964
1965         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1966         // nodes[0]'s wealth
1967         loop {
1968                 let amt_msat = recv_value_0 + total_fee_msat;
1969                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1970                 // Also, ensure that each payment has enough to be over the dust limit to
1971                 // ensure it'll be included in each commit tx fee calculation.
1972                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1973                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1974                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1975                         break;
1976                 }
1977                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1978
1979                 let (stat01_, stat11_, stat12_, stat22_) = (
1980                         get_channel_value_stat!(nodes[0], chan_1.2),
1981                         get_channel_value_stat!(nodes[1], chan_1.2),
1982                         get_channel_value_stat!(nodes[1], chan_2.2),
1983                         get_channel_value_stat!(nodes[2], chan_2.2),
1984                 );
1985
1986                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1987                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1988                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1989                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1990                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1991         }
1992
1993         // adding pending output.
1994         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1995         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1996         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1997         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1998         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1999         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2000         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2001         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2002         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2003         // policy.
2004         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2005         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2006         let amt_msat_1 = recv_value_1 + total_fee_msat;
2007
2008         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);
2009         let payment_event_1 = {
2010                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
2011                 check_added_monitors!(nodes[0], 1);
2012
2013                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2014                 assert_eq!(events.len(), 1);
2015                 SendEvent::from_event(events.remove(0))
2016         };
2017         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2018
2019         // channel reserve test with htlc pending output > 0
2020         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2021         {
2022                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2023                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2024                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2025                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2026         }
2027
2028         // split the rest to test holding cell
2029         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2030         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2031         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2032         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2033         {
2034                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2035                 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);
2036         }
2037
2038         // now see if they go through on both sides
2039         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);
2040         // but this will stuck in the holding cell
2041         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2042         check_added_monitors!(nodes[0], 0);
2043         let events = nodes[0].node.get_and_clear_pending_events();
2044         assert_eq!(events.len(), 0);
2045
2046         // test with outbound holding cell amount > 0
2047         {
2048                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2049                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2050                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2051                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2052                 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);
2053         }
2054
2055         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);
2056         // this will also stuck in the holding cell
2057         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2058         check_added_monitors!(nodes[0], 0);
2059         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2060         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2061
2062         // flush the pending htlc
2063         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2064         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2065         check_added_monitors!(nodes[1], 1);
2066
2067         // the pending htlc should be promoted to committed
2068         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2069         check_added_monitors!(nodes[0], 1);
2070         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2071
2072         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2073         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2074         // No commitment_signed so get_event_msg's assert(len == 1) passes
2075         check_added_monitors!(nodes[0], 1);
2076
2077         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2078         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2079         check_added_monitors!(nodes[1], 1);
2080
2081         expect_pending_htlcs_forwardable!(nodes[1]);
2082
2083         let ref payment_event_11 = expect_forward!(nodes[1]);
2084         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2085         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2086
2087         expect_pending_htlcs_forwardable!(nodes[2]);
2088         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2089
2090         // flush the htlcs in the holding cell
2091         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2092         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2093         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2094         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2095         expect_pending_htlcs_forwardable!(nodes[1]);
2096
2097         let ref payment_event_3 = expect_forward!(nodes[1]);
2098         assert_eq!(payment_event_3.msgs.len(), 2);
2099         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2100         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2101
2102         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2103         expect_pending_htlcs_forwardable!(nodes[2]);
2104
2105         let events = nodes[2].node.get_and_clear_pending_events();
2106         assert_eq!(events.len(), 2);
2107         match events[0] {
2108                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2109                         assert_eq!(our_payment_hash_21, *payment_hash);
2110                         assert_eq!(recv_value_21, amt);
2111                         match &purpose {
2112                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2113                                         assert!(payment_preimage.is_none());
2114                                         assert_eq!(our_payment_secret_21, *payment_secret);
2115                                 },
2116                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
2117                         }
2118                 },
2119                 _ => panic!("Unexpected event"),
2120         }
2121         match events[1] {
2122                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2123                         assert_eq!(our_payment_hash_22, *payment_hash);
2124                         assert_eq!(recv_value_22, amt);
2125                         match &purpose {
2126                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2127                                         assert!(payment_preimage.is_none());
2128                                         assert_eq!(our_payment_secret_22, *payment_secret);
2129                                 },
2130                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
2131                         }
2132                 },
2133                 _ => panic!("Unexpected event"),
2134         }
2135
2136         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2137         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2138         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2139
2140         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2141         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2142         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2143
2144         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2145         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);
2146         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2147         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2148         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2149
2150         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2151         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2152 }
2153
2154 #[test]
2155 fn channel_reserve_in_flight_removes() {
2156         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2157         // can send to its counterparty, but due to update ordering, the other side may not yet have
2158         // considered those HTLCs fully removed.
2159         // This tests that we don't count HTLCs which will not be included in the next remote
2160         // commitment transaction towards the reserve value (as it implies no commitment transaction
2161         // will be generated which violates the remote reserve value).
2162         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2163         // To test this we:
2164         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2165         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2166         //    you only consider the value of the first HTLC, it may not),
2167         //  * start routing a third HTLC from A to B,
2168         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2169         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2170         //  * deliver the first fulfill from B
2171         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2172         //    claim,
2173         //  * deliver A's response CS and RAA.
2174         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2175         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2176         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2177         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2178         let chanmon_cfgs = create_chanmon_cfgs(2);
2179         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2180         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2181         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2182         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2183         let logger = test_utils::TestLogger::new();
2184
2185         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2186         // Route the first two HTLCs.
2187         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2188         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2189
2190         // Start routing the third HTLC (this is just used to get everyone in the right state).
2191         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2192         let send_1 = {
2193                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2194                 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();
2195                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2196                 check_added_monitors!(nodes[0], 1);
2197                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2198                 assert_eq!(events.len(), 1);
2199                 SendEvent::from_event(events.remove(0))
2200         };
2201
2202         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2203         // initial fulfill/CS.
2204         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2205         check_added_monitors!(nodes[1], 1);
2206         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2207
2208         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2209         // remove the second HTLC when we send the HTLC back from B to A.
2210         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2211         check_added_monitors!(nodes[1], 1);
2212         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2213
2214         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2215         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2216         check_added_monitors!(nodes[0], 1);
2217         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2218         expect_payment_sent!(nodes[0], payment_preimage_1);
2219
2220         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2221         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2222         check_added_monitors!(nodes[1], 1);
2223         // B is already AwaitingRAA, so cant generate a CS here
2224         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2225
2226         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2227         check_added_monitors!(nodes[1], 1);
2228         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2229
2230         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2231         check_added_monitors!(nodes[0], 1);
2232         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2233
2234         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2235         check_added_monitors!(nodes[1], 1);
2236         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2237
2238         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2239         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2240         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2241         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2242         // on-chain as necessary).
2243         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2244         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2245         check_added_monitors!(nodes[0], 1);
2246         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2247         expect_payment_sent!(nodes[0], payment_preimage_2);
2248
2249         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2250         check_added_monitors!(nodes[1], 1);
2251         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2252
2253         expect_pending_htlcs_forwardable!(nodes[1]);
2254         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2255
2256         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2257         // resolve the second HTLC from A's point of view.
2258         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2259         check_added_monitors!(nodes[0], 1);
2260         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2261
2262         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2263         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2264         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2265         let send_2 = {
2266                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2267                 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();
2268                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2269                 check_added_monitors!(nodes[1], 1);
2270                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2271                 assert_eq!(events.len(), 1);
2272                 SendEvent::from_event(events.remove(0))
2273         };
2274
2275         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2276         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2277         check_added_monitors!(nodes[0], 1);
2278         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2279
2280         // Now just resolve all the outstanding messages/HTLCs for completeness...
2281
2282         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2283         check_added_monitors!(nodes[1], 1);
2284         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2285
2286         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2287         check_added_monitors!(nodes[1], 1);
2288
2289         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2290         check_added_monitors!(nodes[0], 1);
2291         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2292
2293         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2294         check_added_monitors!(nodes[1], 1);
2295         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2296
2297         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2298         check_added_monitors!(nodes[0], 1);
2299
2300         expect_pending_htlcs_forwardable!(nodes[0]);
2301         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2302
2303         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2304         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2305 }
2306
2307 #[test]
2308 fn channel_monitor_network_test() {
2309         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2310         // tests that ChannelMonitor is able to recover from various states.
2311         let chanmon_cfgs = create_chanmon_cfgs(5);
2312         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2313         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2314         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2315
2316         // Create some initial channels
2317         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2318         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2319         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2320         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2321
2322         // Make sure all nodes are at the same starting height
2323         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2324         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2325         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2326         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2327         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2328
2329         // Rebalance the network a bit by relaying one payment through all the channels...
2330         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2331         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2332         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2333         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2334
2335         // Simple case with no pending HTLCs:
2336         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2337         check_added_monitors!(nodes[1], 1);
2338         check_closed_broadcast!(nodes[1], false);
2339         {
2340                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2341                 assert_eq!(node_txn.len(), 1);
2342                 mine_transaction(&nodes[0], &node_txn[0]);
2343                 check_added_monitors!(nodes[0], 1);
2344                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2345         }
2346         check_closed_broadcast!(nodes[0], true);
2347         assert_eq!(nodes[0].node.list_channels().len(), 0);
2348         assert_eq!(nodes[1].node.list_channels().len(), 1);
2349
2350         // One pending HTLC is discarded by the force-close:
2351         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2352
2353         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2354         // broadcasted until we reach the timelock time).
2355         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2356         check_closed_broadcast!(nodes[1], false);
2357         check_added_monitors!(nodes[1], 1);
2358         {
2359                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2360                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2361                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2362                 mine_transaction(&nodes[2], &node_txn[0]);
2363                 check_added_monitors!(nodes[2], 1);
2364                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2365         }
2366         check_closed_broadcast!(nodes[2], true);
2367         assert_eq!(nodes[1].node.list_channels().len(), 0);
2368         assert_eq!(nodes[2].node.list_channels().len(), 1);
2369
2370         macro_rules! claim_funds {
2371                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2372                         {
2373                                 assert!($node.node.claim_funds($preimage));
2374                                 check_added_monitors!($node, 1);
2375
2376                                 let events = $node.node.get_and_clear_pending_msg_events();
2377                                 assert_eq!(events.len(), 1);
2378                                 match events[0] {
2379                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2380                                                 assert!(update_add_htlcs.is_empty());
2381                                                 assert!(update_fail_htlcs.is_empty());
2382                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2383                                         },
2384                                         _ => panic!("Unexpected event"),
2385                                 };
2386                         }
2387                 }
2388         }
2389
2390         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2391         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2392         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2393         check_added_monitors!(nodes[2], 1);
2394         check_closed_broadcast!(nodes[2], false);
2395         let node2_commitment_txid;
2396         {
2397                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2398                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2399                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2400                 node2_commitment_txid = node_txn[0].txid();
2401
2402                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2403                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2404                 mine_transaction(&nodes[3], &node_txn[0]);
2405                 check_added_monitors!(nodes[3], 1);
2406                 check_preimage_claim(&nodes[3], &node_txn);
2407         }
2408         check_closed_broadcast!(nodes[3], true);
2409         assert_eq!(nodes[2].node.list_channels().len(), 0);
2410         assert_eq!(nodes[3].node.list_channels().len(), 1);
2411
2412         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2413         // confusing us in the following tests.
2414         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2415
2416         // One pending HTLC to time out:
2417         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2418         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2419         // buffer space).
2420
2421         let (close_chan_update_1, close_chan_update_2) = {
2422                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2423                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2424                 assert_eq!(events.len(), 2);
2425                 let close_chan_update_1 = match events[0] {
2426                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2427                                 msg.clone()
2428                         },
2429                         _ => panic!("Unexpected event"),
2430                 };
2431                 match events[1] {
2432                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2433                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2434                         },
2435                         _ => panic!("Unexpected event"),
2436                 }
2437                 check_added_monitors!(nodes[3], 1);
2438
2439                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2440                 {
2441                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2442                         node_txn.retain(|tx| {
2443                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2444                                         false
2445                                 } else { true }
2446                         });
2447                 }
2448
2449                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2450
2451                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2452                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2453
2454                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2455                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2456                 assert_eq!(events.len(), 2);
2457                 let close_chan_update_2 = match events[0] {
2458                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2459                                 msg.clone()
2460                         },
2461                         _ => panic!("Unexpected event"),
2462                 };
2463                 match events[1] {
2464                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2465                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2466                         },
2467                         _ => panic!("Unexpected event"),
2468                 }
2469                 check_added_monitors!(nodes[4], 1);
2470                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2471
2472                 mine_transaction(&nodes[4], &node_txn[0]);
2473                 check_preimage_claim(&nodes[4], &node_txn);
2474                 (close_chan_update_1, close_chan_update_2)
2475         };
2476         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2477         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2478         assert_eq!(nodes[3].node.list_channels().len(), 0);
2479         assert_eq!(nodes[4].node.list_channels().len(), 0);
2480
2481         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2482 }
2483
2484 #[test]
2485 fn test_justice_tx() {
2486         // Test justice txn built on revoked HTLC-Success tx, against both sides
2487         let mut alice_config = UserConfig::default();
2488         alice_config.channel_options.announced_channel = true;
2489         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2490         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2491         let mut bob_config = UserConfig::default();
2492         bob_config.channel_options.announced_channel = true;
2493         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2494         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2495         let user_cfgs = [Some(alice_config), Some(bob_config)];
2496         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2497         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2498         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2499         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2500         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2501         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2502         // Create some new channels:
2503         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2504
2505         // A pending HTLC which will be revoked:
2506         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2507         // Get the will-be-revoked local txn from nodes[0]
2508         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2509         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2510         assert_eq!(revoked_local_txn[0].input.len(), 1);
2511         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2512         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2513         assert_eq!(revoked_local_txn[1].input.len(), 1);
2514         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2515         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2516         // Revoke the old state
2517         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2518
2519         {
2520                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2521                 {
2522                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2523                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2524                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2525
2526                         check_spends!(node_txn[0], revoked_local_txn[0]);
2527                         node_txn.swap_remove(0);
2528                         node_txn.truncate(1);
2529                 }
2530                 check_added_monitors!(nodes[1], 1);
2531                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2532
2533                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2534                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2535                 // Verify broadcast of revoked HTLC-timeout
2536                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2537                 check_added_monitors!(nodes[0], 1);
2538                 // Broadcast revoked HTLC-timeout on node 1
2539                 mine_transaction(&nodes[1], &node_txn[1]);
2540                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2541         }
2542         get_announce_close_broadcast_events(&nodes, 0, 1);
2543
2544         assert_eq!(nodes[0].node.list_channels().len(), 0);
2545         assert_eq!(nodes[1].node.list_channels().len(), 0);
2546
2547         // We test justice_tx build by A on B's revoked HTLC-Success tx
2548         // Create some new channels:
2549         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2550         {
2551                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2552                 node_txn.clear();
2553         }
2554
2555         // A pending HTLC which will be revoked:
2556         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2557         // Get the will-be-revoked local txn from B
2558         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2559         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2560         assert_eq!(revoked_local_txn[0].input.len(), 1);
2561         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2562         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2563         // Revoke the old state
2564         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2565         {
2566                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2567                 {
2568                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2569                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2570                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2571
2572                         check_spends!(node_txn[0], revoked_local_txn[0]);
2573                         node_txn.swap_remove(0);
2574                 }
2575                 check_added_monitors!(nodes[0], 1);
2576                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2577
2578                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2579                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2580                 check_added_monitors!(nodes[1], 1);
2581                 mine_transaction(&nodes[0], &node_txn[1]);
2582                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2583         }
2584         get_announce_close_broadcast_events(&nodes, 0, 1);
2585         assert_eq!(nodes[0].node.list_channels().len(), 0);
2586         assert_eq!(nodes[1].node.list_channels().len(), 0);
2587 }
2588
2589 #[test]
2590 fn revoked_output_claim() {
2591         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2592         // transaction is broadcast by its counterparty
2593         let chanmon_cfgs = create_chanmon_cfgs(2);
2594         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2595         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2596         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2597         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2598         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2599         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2600         assert_eq!(revoked_local_txn.len(), 1);
2601         // Only output is the full channel value back to nodes[0]:
2602         assert_eq!(revoked_local_txn[0].output.len(), 1);
2603         // Send a payment through, updating everyone's latest commitment txn
2604         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2605
2606         // Inform nodes[1] that nodes[0] broadcast a stale tx
2607         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2608         check_added_monitors!(nodes[1], 1);
2609         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2610         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2611
2612         check_spends!(node_txn[0], revoked_local_txn[0]);
2613         check_spends!(node_txn[1], chan_1.3);
2614
2615         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2616         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2617         get_announce_close_broadcast_events(&nodes, 0, 1);
2618         check_added_monitors!(nodes[0], 1)
2619 }
2620
2621 #[test]
2622 fn claim_htlc_outputs_shared_tx() {
2623         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2624         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2625         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2626         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2627         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2628         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2629
2630         // Create some new channel:
2631         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2632
2633         // Rebalance the network to generate htlc in the two directions
2634         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2635         // 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
2636         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2637         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2638
2639         // Get the will-be-revoked local txn from node[0]
2640         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2641         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2642         assert_eq!(revoked_local_txn[0].input.len(), 1);
2643         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2644         assert_eq!(revoked_local_txn[1].input.len(), 1);
2645         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2646         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2647         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2648
2649         //Revoke the old state
2650         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2651
2652         {
2653                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2654                 check_added_monitors!(nodes[0], 1);
2655                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2656                 check_added_monitors!(nodes[1], 1);
2657                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2658                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2659
2660                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2661                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2662
2663                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2664                 check_spends!(node_txn[0], revoked_local_txn[0]);
2665
2666                 let mut witness_lens = BTreeSet::new();
2667                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2668                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2669                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2670                 assert_eq!(witness_lens.len(), 3);
2671                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2672                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2673                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2674
2675                 // Next nodes[1] broadcasts its current local tx state:
2676                 assert_eq!(node_txn[1].input.len(), 1);
2677                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2678         }
2679         get_announce_close_broadcast_events(&nodes, 0, 1);
2680         assert_eq!(nodes[0].node.list_channels().len(), 0);
2681         assert_eq!(nodes[1].node.list_channels().len(), 0);
2682 }
2683
2684 #[test]
2685 fn claim_htlc_outputs_single_tx() {
2686         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2687         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2688         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2689         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2690         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2691         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2692
2693         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2694
2695         // Rebalance the network to generate htlc in the two directions
2696         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2697         // 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
2698         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2699         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2700         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2701
2702         // Get the will-be-revoked local txn from node[0]
2703         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2704
2705         //Revoke the old state
2706         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2707
2708         {
2709                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2710                 check_added_monitors!(nodes[0], 1);
2711                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2712                 check_added_monitors!(nodes[1], 1);
2713                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2714
2715                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2716                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2717
2718                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2719                 assert_eq!(node_txn.len(), 9);
2720                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2721                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2722                 // 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)
2723                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2724
2725                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2726                 assert_eq!(node_txn[0].input.len(), 1);
2727                 check_spends!(node_txn[0], chan_1.3);
2728                 assert_eq!(node_txn[1].input.len(), 1);
2729                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2730                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2731                 check_spends!(node_txn[1], node_txn[0]);
2732
2733                 // Justice transactions are indices 1-2-4
2734                 assert_eq!(node_txn[2].input.len(), 1);
2735                 assert_eq!(node_txn[3].input.len(), 1);
2736                 assert_eq!(node_txn[4].input.len(), 1);
2737
2738                 check_spends!(node_txn[2], revoked_local_txn[0]);
2739                 check_spends!(node_txn[3], revoked_local_txn[0]);
2740                 check_spends!(node_txn[4], revoked_local_txn[0]);
2741
2742                 let mut witness_lens = BTreeSet::new();
2743                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2744                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2745                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2746                 assert_eq!(witness_lens.len(), 3);
2747                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2748                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2749                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2750         }
2751         get_announce_close_broadcast_events(&nodes, 0, 1);
2752         assert_eq!(nodes[0].node.list_channels().len(), 0);
2753         assert_eq!(nodes[1].node.list_channels().len(), 0);
2754 }
2755
2756 #[test]
2757 fn test_htlc_on_chain_success() {
2758         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2759         // the preimage backward accordingly. So here we test that ChannelManager is
2760         // broadcasting the right event to other nodes in payment path.
2761         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2762         // A --------------------> B ----------------------> C (preimage)
2763         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2764         // commitment transaction was broadcast.
2765         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2766         // towards B.
2767         // B should be able to claim via preimage if A then broadcasts its local tx.
2768         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2769         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2770         // PaymentSent event).
2771
2772         let chanmon_cfgs = create_chanmon_cfgs(3);
2773         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2774         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2775         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2776
2777         // Create some initial channels
2778         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2779         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2780
2781         // Ensure all nodes are at the same height
2782         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2783         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2784         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2785         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2786
2787         // Rebalance the network a bit by relaying one payment through all the channels...
2788         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2789         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2790
2791         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2792         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2793
2794         // Broadcast legit commitment tx from C on B's chain
2795         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2796         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2797         assert_eq!(commitment_tx.len(), 1);
2798         check_spends!(commitment_tx[0], chan_2.3);
2799         nodes[2].node.claim_funds(our_payment_preimage);
2800         nodes[2].node.claim_funds(our_payment_preimage_2);
2801         check_added_monitors!(nodes[2], 2);
2802         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2803         assert!(updates.update_add_htlcs.is_empty());
2804         assert!(updates.update_fail_htlcs.is_empty());
2805         assert!(updates.update_fail_malformed_htlcs.is_empty());
2806         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2807
2808         mine_transaction(&nodes[2], &commitment_tx[0]);
2809         check_closed_broadcast!(nodes[2], true);
2810         check_added_monitors!(nodes[2], 1);
2811         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)
2812         assert_eq!(node_txn.len(), 5);
2813         assert_eq!(node_txn[0], node_txn[3]);
2814         assert_eq!(node_txn[1], node_txn[4]);
2815         assert_eq!(node_txn[2], commitment_tx[0]);
2816         check_spends!(node_txn[0], commitment_tx[0]);
2817         check_spends!(node_txn[1], commitment_tx[0]);
2818         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2819         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2820         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2821         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2822         assert_eq!(node_txn[0].lock_time, 0);
2823         assert_eq!(node_txn[1].lock_time, 0);
2824
2825         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2826         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2827         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2828         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2829         {
2830                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2831                 assert_eq!(added_monitors.len(), 1);
2832                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2833                 added_monitors.clear();
2834         }
2835         let events = nodes[1].node.get_and_clear_pending_msg_events();
2836         {
2837                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2838                 assert_eq!(added_monitors.len(), 2);
2839                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2840                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2841                 added_monitors.clear();
2842         }
2843         assert_eq!(events.len(), 3);
2844         match events[0] {
2845                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2846                 _ => panic!("Unexpected event"),
2847         }
2848         match events[1] {
2849                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2850                 _ => panic!("Unexpected event"),
2851         }
2852
2853         match events[2] {
2854                 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, .. } } => {
2855                         assert!(update_add_htlcs.is_empty());
2856                         assert!(update_fail_htlcs.is_empty());
2857                         assert_eq!(update_fulfill_htlcs.len(), 1);
2858                         assert!(update_fail_malformed_htlcs.is_empty());
2859                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2860                 },
2861                 _ => panic!("Unexpected event"),
2862         };
2863         macro_rules! check_tx_local_broadcast {
2864                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2865                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2866                         assert_eq!(node_txn.len(), 3);
2867                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2868                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2869                         check_spends!(node_txn[1], $commitment_tx);
2870                         check_spends!(node_txn[2], $commitment_tx);
2871                         assert_ne!(node_txn[1].lock_time, 0);
2872                         assert_ne!(node_txn[2].lock_time, 0);
2873                         if $htlc_offered {
2874                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2875                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2876                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2877                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2878                         } else {
2879                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2880                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2881                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2882                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2883                         }
2884                         check_spends!(node_txn[0], $chan_tx);
2885                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2886                         node_txn.clear();
2887                 } }
2888         }
2889         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2890         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2891         // timeout-claim of the output that nodes[2] just claimed via success.
2892         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2893
2894         // Broadcast legit commitment tx from A on B's chain
2895         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2896         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2897         check_spends!(node_a_commitment_tx[0], chan_1.3);
2898         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2899         check_closed_broadcast!(nodes[1], true);
2900         check_added_monitors!(nodes[1], 1);
2901         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2902         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2903         let commitment_spend =
2904                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2905                         check_spends!(node_txn[1], commitment_tx[0]);
2906                         check_spends!(node_txn[2], commitment_tx[0]);
2907                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2908                         &node_txn[0]
2909                 } else {
2910                         check_spends!(node_txn[0], commitment_tx[0]);
2911                         check_spends!(node_txn[1], commitment_tx[0]);
2912                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2913                         &node_txn[2]
2914                 };
2915
2916         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2917         assert_eq!(commitment_spend.input.len(), 2);
2918         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2919         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2920         assert_eq!(commitment_spend.lock_time, 0);
2921         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2922         check_spends!(node_txn[3], chan_1.3);
2923         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2924         check_spends!(node_txn[4], node_txn[3]);
2925         check_spends!(node_txn[5], node_txn[3]);
2926         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2927         // we already checked the same situation with A.
2928
2929         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2930         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2931         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2932         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2933         check_closed_broadcast!(nodes[0], true);
2934         check_added_monitors!(nodes[0], 1);
2935         let events = nodes[0].node.get_and_clear_pending_events();
2936         assert_eq!(events.len(), 2);
2937         let mut first_claimed = false;
2938         for event in events {
2939                 match event {
2940                         Event::PaymentSent { payment_preimage } => {
2941                                 if payment_preimage == our_payment_preimage {
2942                                         assert!(!first_claimed);
2943                                         first_claimed = true;
2944                                 } else {
2945                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2946                                 }
2947                         },
2948                         _ => panic!("Unexpected event"),
2949                 }
2950         }
2951         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2952 }
2953
2954 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2955         // Test that in case of a unilateral close onchain, we detect the state of output and
2956         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2957         // broadcasting the right event to other nodes in payment path.
2958         // A ------------------> B ----------------------> C (timeout)
2959         //    B's commitment tx                 C's commitment tx
2960         //            \                                  \
2961         //         B's HTLC timeout tx               B's timeout tx
2962
2963         let chanmon_cfgs = create_chanmon_cfgs(3);
2964         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2965         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2966         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2967         *nodes[0].connect_style.borrow_mut() = connect_style;
2968         *nodes[1].connect_style.borrow_mut() = connect_style;
2969         *nodes[2].connect_style.borrow_mut() = connect_style;
2970
2971         // Create some intial channels
2972         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2973         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2974
2975         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2976         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2977         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2978
2979         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2980
2981         // Broadcast legit commitment tx from C on B's chain
2982         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2983         check_spends!(commitment_tx[0], chan_2.3);
2984         nodes[2].node.fail_htlc_backwards(&payment_hash);
2985         check_added_monitors!(nodes[2], 0);
2986         expect_pending_htlcs_forwardable!(nodes[2]);
2987         check_added_monitors!(nodes[2], 1);
2988
2989         let events = nodes[2].node.get_and_clear_pending_msg_events();
2990         assert_eq!(events.len(), 1);
2991         match events[0] {
2992                 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, .. } } => {
2993                         assert!(update_add_htlcs.is_empty());
2994                         assert!(!update_fail_htlcs.is_empty());
2995                         assert!(update_fulfill_htlcs.is_empty());
2996                         assert!(update_fail_malformed_htlcs.is_empty());
2997                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2998                 },
2999                 _ => panic!("Unexpected event"),
3000         };
3001         mine_transaction(&nodes[2], &commitment_tx[0]);
3002         check_closed_broadcast!(nodes[2], true);
3003         check_added_monitors!(nodes[2], 1);
3004         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
3005         assert_eq!(node_txn.len(), 1);
3006         check_spends!(node_txn[0], chan_2.3);
3007         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
3008
3009         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3010         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3011         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3012         mine_transaction(&nodes[1], &commitment_tx[0]);
3013         let timeout_tx;
3014         {
3015                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3016                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3017                 assert_eq!(node_txn[0], node_txn[3]);
3018                 assert_eq!(node_txn[1], node_txn[4]);
3019
3020                 check_spends!(node_txn[2], commitment_tx[0]);
3021                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3022
3023                 check_spends!(node_txn[0], chan_2.3);
3024                 check_spends!(node_txn[1], node_txn[0]);
3025                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3026                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3027
3028                 timeout_tx = node_txn[2].clone();
3029                 node_txn.clear();
3030         }
3031
3032         mine_transaction(&nodes[1], &timeout_tx);
3033         check_added_monitors!(nodes[1], 1);
3034         check_closed_broadcast!(nodes[1], true);
3035         {
3036                 // B will rebroadcast a fee-bumped timeout transaction here.
3037                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3038                 assert_eq!(node_txn.len(), 1);
3039                 check_spends!(node_txn[0], commitment_tx[0]);
3040         }
3041
3042         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3043         {
3044                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3045                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3046                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3047                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3048                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3049                 if node_txn.len() == 1 {
3050                         check_spends!(node_txn[0], chan_2.3);
3051                 } else {
3052                         assert_eq!(node_txn.len(), 0);
3053                 }
3054         }
3055
3056         expect_pending_htlcs_forwardable!(nodes[1]);
3057         check_added_monitors!(nodes[1], 1);
3058         let events = nodes[1].node.get_and_clear_pending_msg_events();
3059         assert_eq!(events.len(), 1);
3060         match events[0] {
3061                 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, .. } } => {
3062                         assert!(update_add_htlcs.is_empty());
3063                         assert!(!update_fail_htlcs.is_empty());
3064                         assert!(update_fulfill_htlcs.is_empty());
3065                         assert!(update_fail_malformed_htlcs.is_empty());
3066                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3067                 },
3068                 _ => panic!("Unexpected event"),
3069         };
3070
3071         // Broadcast legit commitment tx from B on A's chain
3072         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3073         check_spends!(commitment_tx[0], chan_1.3);
3074
3075         mine_transaction(&nodes[0], &commitment_tx[0]);
3076         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3077
3078         check_closed_broadcast!(nodes[0], true);
3079         check_added_monitors!(nodes[0], 1);
3080         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3081         assert_eq!(node_txn.len(), 2);
3082         check_spends!(node_txn[0], chan_1.3);
3083         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3084         check_spends!(node_txn[1], commitment_tx[0]);
3085         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3086 }
3087
3088 #[test]
3089 fn test_htlc_on_chain_timeout() {
3090         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3091         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3092         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3093 }
3094
3095 #[test]
3096 fn test_simple_commitment_revoked_fail_backward() {
3097         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3098         // and fail backward accordingly.
3099
3100         let chanmon_cfgs = create_chanmon_cfgs(3);
3101         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3102         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3103         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3104
3105         // Create some initial channels
3106         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3107         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3108
3109         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3110         // Get the will-be-revoked local txn from nodes[2]
3111         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3112         // Revoke the old state
3113         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3114
3115         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3116
3117         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3118         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3119         check_added_monitors!(nodes[1], 1);
3120         check_closed_broadcast!(nodes[1], true);
3121
3122         expect_pending_htlcs_forwardable!(nodes[1]);
3123         check_added_monitors!(nodes[1], 1);
3124         let events = nodes[1].node.get_and_clear_pending_msg_events();
3125         assert_eq!(events.len(), 1);
3126         match events[0] {
3127                 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, .. } } => {
3128                         assert!(update_add_htlcs.is_empty());
3129                         assert_eq!(update_fail_htlcs.len(), 1);
3130                         assert!(update_fulfill_htlcs.is_empty());
3131                         assert!(update_fail_malformed_htlcs.is_empty());
3132                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3133
3134                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3135                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3136                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3137                         expect_payment_failed!(nodes[0], payment_hash, false);
3138                 },
3139                 _ => panic!("Unexpected event"),
3140         }
3141 }
3142
3143 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3144         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3145         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3146         // commitment transaction anymore.
3147         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3148         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3149         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3150         // technically disallowed and we should probably handle it reasonably.
3151         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3152         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3153         // transactions:
3154         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3155         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3156         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3157         //   and once they revoke the previous commitment transaction (allowing us to send a new
3158         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3159         let chanmon_cfgs = create_chanmon_cfgs(3);
3160         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3161         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3162         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3163
3164         // Create some initial channels
3165         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3166         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3167
3168         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 });
3169         // Get the will-be-revoked local txn from nodes[2]
3170         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3171         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3172         // Revoke the old state
3173         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3174
3175         let value = if use_dust {
3176                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3177                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3178                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3179         } else { 3000000 };
3180
3181         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3182         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3183         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3184
3185         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3186         expect_pending_htlcs_forwardable!(nodes[2]);
3187         check_added_monitors!(nodes[2], 1);
3188         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3189         assert!(updates.update_add_htlcs.is_empty());
3190         assert!(updates.update_fulfill_htlcs.is_empty());
3191         assert!(updates.update_fail_malformed_htlcs.is_empty());
3192         assert_eq!(updates.update_fail_htlcs.len(), 1);
3193         assert!(updates.update_fee.is_none());
3194         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3195         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3196         // Drop the last RAA from 3 -> 2
3197
3198         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3199         expect_pending_htlcs_forwardable!(nodes[2]);
3200         check_added_monitors!(nodes[2], 1);
3201         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3202         assert!(updates.update_add_htlcs.is_empty());
3203         assert!(updates.update_fulfill_htlcs.is_empty());
3204         assert!(updates.update_fail_malformed_htlcs.is_empty());
3205         assert_eq!(updates.update_fail_htlcs.len(), 1);
3206         assert!(updates.update_fee.is_none());
3207         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3208         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3209         check_added_monitors!(nodes[1], 1);
3210         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3211         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3212         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3213         check_added_monitors!(nodes[2], 1);
3214
3215         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3216         expect_pending_htlcs_forwardable!(nodes[2]);
3217         check_added_monitors!(nodes[2], 1);
3218         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3219         assert!(updates.update_add_htlcs.is_empty());
3220         assert!(updates.update_fulfill_htlcs.is_empty());
3221         assert!(updates.update_fail_malformed_htlcs.is_empty());
3222         assert_eq!(updates.update_fail_htlcs.len(), 1);
3223         assert!(updates.update_fee.is_none());
3224         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3225         // At this point first_payment_hash has dropped out of the latest two commitment
3226         // transactions that nodes[1] is tracking...
3227         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3228         check_added_monitors!(nodes[1], 1);
3229         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3230         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3231         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3232         check_added_monitors!(nodes[2], 1);
3233
3234         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3235         // on nodes[2]'s RAA.
3236         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3237         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3238         let logger = test_utils::TestLogger::new();
3239         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();
3240         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3241         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3242         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3243         check_added_monitors!(nodes[1], 0);
3244
3245         if deliver_bs_raa {
3246                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3247                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3248                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3249                 check_added_monitors!(nodes[1], 1);
3250                 let events = nodes[1].node.get_and_clear_pending_events();
3251                 assert_eq!(events.len(), 1);
3252                 match events[0] {
3253                         Event::PendingHTLCsForwardable { .. } => { },
3254                         _ => panic!("Unexpected event"),
3255                 };
3256                 // Deliberately don't process the pending fail-back so they all fail back at once after
3257                 // block connection just like the !deliver_bs_raa case
3258         }
3259
3260         let mut failed_htlcs = HashSet::new();
3261         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3262
3263         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3264         check_added_monitors!(nodes[1], 1);
3265         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3266
3267         let events = nodes[1].node.get_and_clear_pending_events();
3268         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3269         match events[0] {
3270                 Event::PaymentFailed { ref payment_hash, .. } => {
3271                         assert_eq!(*payment_hash, fourth_payment_hash);
3272                 },
3273                 _ => panic!("Unexpected event"),
3274         }
3275         if !deliver_bs_raa {
3276                 match events[1] {
3277                         Event::PendingHTLCsForwardable { .. } => { },
3278                         _ => panic!("Unexpected event"),
3279                 };
3280         }
3281         nodes[1].node.process_pending_htlc_forwards();
3282         check_added_monitors!(nodes[1], 1);
3283
3284         let events = nodes[1].node.get_and_clear_pending_msg_events();
3285         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3286         match events[if deliver_bs_raa { 1 } else { 0 }] {
3287                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3288                 _ => panic!("Unexpected event"),
3289         }
3290         match events[if deliver_bs_raa { 2 } else { 1 }] {
3291                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3292                         assert_eq!(channel_id, chan_2.2);
3293                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3294                 },
3295                 _ => panic!("Unexpected event"),
3296         }
3297         if deliver_bs_raa {
3298                 match events[0] {
3299                         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, .. } } => {
3300                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3301                                 assert_eq!(update_add_htlcs.len(), 1);
3302                                 assert!(update_fulfill_htlcs.is_empty());
3303                                 assert!(update_fail_htlcs.is_empty());
3304                                 assert!(update_fail_malformed_htlcs.is_empty());
3305                         },
3306                         _ => panic!("Unexpected event"),
3307                 }
3308         }
3309         match events[if deliver_bs_raa { 3 } else { 2 }] {
3310                 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, .. } } => {
3311                         assert!(update_add_htlcs.is_empty());
3312                         assert_eq!(update_fail_htlcs.len(), 3);
3313                         assert!(update_fulfill_htlcs.is_empty());
3314                         assert!(update_fail_malformed_htlcs.is_empty());
3315                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3316
3317                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3318                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3319                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3320
3321                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3322
3323                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3324                         // If we delivered B's RAA we got an unknown preimage error, not something
3325                         // that we should update our routing table for.
3326                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3327                         for event in events {
3328                                 match event {
3329                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3330                                         _ => panic!("Unexpected event"),
3331                                 }
3332                         }
3333                         let events = nodes[0].node.get_and_clear_pending_events();
3334                         assert_eq!(events.len(), 3);
3335                         match events[0] {
3336                                 Event::PaymentFailed { ref payment_hash, .. } => {
3337                                         assert!(failed_htlcs.insert(payment_hash.0));
3338                                 },
3339                                 _ => panic!("Unexpected event"),
3340                         }
3341                         match events[1] {
3342                                 Event::PaymentFailed { ref payment_hash, .. } => {
3343                                         assert!(failed_htlcs.insert(payment_hash.0));
3344                                 },
3345                                 _ => panic!("Unexpected event"),
3346                         }
3347                         match events[2] {
3348                                 Event::PaymentFailed { ref payment_hash, .. } => {
3349                                         assert!(failed_htlcs.insert(payment_hash.0));
3350                                 },
3351                                 _ => panic!("Unexpected event"),
3352                         }
3353                 },
3354                 _ => panic!("Unexpected event"),
3355         }
3356
3357         assert!(failed_htlcs.contains(&first_payment_hash.0));
3358         assert!(failed_htlcs.contains(&second_payment_hash.0));
3359         assert!(failed_htlcs.contains(&third_payment_hash.0));
3360 }
3361
3362 #[test]
3363 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3364         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3365         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3366         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3367         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3368 }
3369
3370 #[test]
3371 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3372         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3373         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3374         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3375         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3376 }
3377
3378 #[test]
3379 fn fail_backward_pending_htlc_upon_channel_failure() {
3380         let chanmon_cfgs = create_chanmon_cfgs(2);
3381         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3382         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3383         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3384         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3385         let logger = test_utils::TestLogger::new();
3386
3387         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3388         {
3389                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3390                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3391                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3392                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3393                 check_added_monitors!(nodes[0], 1);
3394
3395                 let payment_event = {
3396                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3397                         assert_eq!(events.len(), 1);
3398                         SendEvent::from_event(events.remove(0))
3399                 };
3400                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3401                 assert_eq!(payment_event.msgs.len(), 1);
3402         }
3403
3404         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3405         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3406         {
3407                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3408                 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();
3409                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3410                 check_added_monitors!(nodes[0], 0);
3411
3412                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3413         }
3414
3415         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3416         {
3417                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3418
3419                 let secp_ctx = Secp256k1::new();
3420                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3421                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3422                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3423                 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();
3424                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3425                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3426                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3427
3428                 // Send a 0-msat update_add_htlc to fail the channel.
3429                 let update_add_htlc = msgs::UpdateAddHTLC {
3430                         channel_id: chan.2,
3431                         htlc_id: 0,
3432                         amount_msat: 0,
3433                         payment_hash,
3434                         cltv_expiry,
3435                         onion_routing_packet,
3436                 };
3437                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3438         }
3439
3440         // Check that Alice fails backward the pending HTLC from the second payment.
3441         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3442         check_closed_broadcast!(nodes[0], true);
3443         check_added_monitors!(nodes[0], 1);
3444 }
3445
3446 #[test]
3447 fn test_htlc_ignore_latest_remote_commitment() {
3448         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3449         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3450         let chanmon_cfgs = create_chanmon_cfgs(2);
3451         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3452         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3453         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3454         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3455
3456         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3457         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3458         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3459         check_closed_broadcast!(nodes[0], true);
3460         check_added_monitors!(nodes[0], 1);
3461
3462         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3463         assert_eq!(node_txn.len(), 3);
3464         assert_eq!(node_txn[0], node_txn[1]);
3465
3466         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3467         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3468         check_closed_broadcast!(nodes[1], true);
3469         check_added_monitors!(nodes[1], 1);
3470
3471         // Duplicate the connect_block call since this may happen due to other listeners
3472         // registering new transactions
3473         header.prev_blockhash = header.block_hash();
3474         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3475 }
3476
3477 #[test]
3478 fn test_force_close_fail_back() {
3479         // Check which HTLCs are failed-backwards on channel force-closure
3480         let chanmon_cfgs = create_chanmon_cfgs(3);
3481         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3482         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3483         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3484         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3485         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3486         let logger = test_utils::TestLogger::new();
3487
3488         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3489
3490         let mut payment_event = {
3491                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3492                 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();
3493                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3494                 check_added_monitors!(nodes[0], 1);
3495
3496                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3497                 assert_eq!(events.len(), 1);
3498                 SendEvent::from_event(events.remove(0))
3499         };
3500
3501         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3502         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3503
3504         expect_pending_htlcs_forwardable!(nodes[1]);
3505
3506         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3507         assert_eq!(events_2.len(), 1);
3508         payment_event = SendEvent::from_event(events_2.remove(0));
3509         assert_eq!(payment_event.msgs.len(), 1);
3510
3511         check_added_monitors!(nodes[1], 1);
3512         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3513         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3514         check_added_monitors!(nodes[2], 1);
3515         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3516
3517         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3518         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3519         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3520
3521         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3522         check_closed_broadcast!(nodes[2], true);
3523         check_added_monitors!(nodes[2], 1);
3524         let tx = {
3525                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3526                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3527                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3528                 // back to nodes[1] upon timeout otherwise.
3529                 assert_eq!(node_txn.len(), 1);
3530                 node_txn.remove(0)
3531         };
3532
3533         mine_transaction(&nodes[1], &tx);
3534
3535         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3536         check_closed_broadcast!(nodes[1], true);
3537         check_added_monitors!(nodes[1], 1);
3538
3539         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3540         {
3541                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3542                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3543                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3544         }
3545         mine_transaction(&nodes[2], &tx);
3546         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3547         assert_eq!(node_txn.len(), 1);
3548         assert_eq!(node_txn[0].input.len(), 1);
3549         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3550         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3551         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3552
3553         check_spends!(node_txn[0], tx);
3554 }
3555
3556 #[test]
3557 fn test_dup_events_on_peer_disconnect() {
3558         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3559         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3560         // as we used to generate the event immediately upon receipt of the payment preimage in the
3561         // update_fulfill_htlc message.
3562
3563         let chanmon_cfgs = create_chanmon_cfgs(2);
3564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3567         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3568
3569         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3570
3571         assert!(nodes[1].node.claim_funds(payment_preimage));
3572         check_added_monitors!(nodes[1], 1);
3573         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3574         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3575         expect_payment_sent!(nodes[0], payment_preimage);
3576
3577         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3578         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3579
3580         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3581         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3582 }
3583
3584 #[test]
3585 fn test_simple_peer_disconnect() {
3586         // Test that we can reconnect when there are no lost messages
3587         let chanmon_cfgs = create_chanmon_cfgs(3);
3588         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3589         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3590         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3591         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3592         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3593
3594         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3595         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3596         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3597
3598         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3599         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3600         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3601         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3602
3603         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3604         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3605         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3606
3607         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3608         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3609         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3610         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3611
3612         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3613         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3614
3615         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3616         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3617
3618         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3619         {
3620                 let events = nodes[0].node.get_and_clear_pending_events();
3621                 assert_eq!(events.len(), 2);
3622                 match events[0] {
3623                         Event::PaymentSent { payment_preimage } => {
3624                                 assert_eq!(payment_preimage, payment_preimage_3);
3625                         },
3626                         _ => panic!("Unexpected event"),
3627                 }
3628                 match events[1] {
3629                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3630                                 assert_eq!(payment_hash, payment_hash_5);
3631                                 assert!(rejected_by_dest);
3632                         },
3633                         _ => panic!("Unexpected event"),
3634                 }
3635         }
3636
3637         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3638         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3639 }
3640
3641 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3642         // Test that we can reconnect when in-flight HTLC updates get dropped
3643         let chanmon_cfgs = create_chanmon_cfgs(2);
3644         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3645         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3646         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3647
3648         let mut as_funding_locked = None;
3649         if messages_delivered == 0 {
3650                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3651                 as_funding_locked = Some(funding_locked);
3652                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3653                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3654                 // it before the channel_reestablish message.
3655         } else {
3656                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3657         }
3658
3659         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3660
3661         let logger = test_utils::TestLogger::new();
3662         let payment_event = {
3663                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3664                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3665                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3666                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3667                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3668                 check_added_monitors!(nodes[0], 1);
3669
3670                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3671                 assert_eq!(events.len(), 1);
3672                 SendEvent::from_event(events.remove(0))
3673         };
3674         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3675
3676         if messages_delivered < 2 {
3677                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3678         } else {
3679                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3680                 if messages_delivered >= 3 {
3681                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3682                         check_added_monitors!(nodes[1], 1);
3683                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3684
3685                         if messages_delivered >= 4 {
3686                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3687                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3688                                 check_added_monitors!(nodes[0], 1);
3689
3690                                 if messages_delivered >= 5 {
3691                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3692                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3693                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3694                                         check_added_monitors!(nodes[0], 1);
3695
3696                                         if messages_delivered >= 6 {
3697                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3698                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3699                                                 check_added_monitors!(nodes[1], 1);
3700                                         }
3701                                 }
3702                         }
3703                 }
3704         }
3705
3706         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3707         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3708         if messages_delivered < 3 {
3709                 if simulate_broken_lnd {
3710                         // lnd has a long-standing bug where they send a funding_locked prior to a
3711                         // channel_reestablish if you reconnect prior to funding_locked time.
3712                         //
3713                         // Here we simulate that behavior, delivering a funding_locked immediately on
3714                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3715                         // in `reconnect_nodes` but we currently don't fail based on that.
3716                         //
3717                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3718                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3719                 }
3720                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3721                 // received on either side, both sides will need to resend them.
3722                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3723         } else if messages_delivered == 3 {
3724                 // nodes[0] still wants its RAA + commitment_signed
3725                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3726         } else if messages_delivered == 4 {
3727                 // nodes[0] still wants its commitment_signed
3728                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3729         } else if messages_delivered == 5 {
3730                 // nodes[1] still wants its final RAA
3731                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3732         } else if messages_delivered == 6 {
3733                 // Everything was delivered...
3734                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3735         }
3736
3737         let events_1 = nodes[1].node.get_and_clear_pending_events();
3738         assert_eq!(events_1.len(), 1);
3739         match events_1[0] {
3740                 Event::PendingHTLCsForwardable { .. } => { },
3741                 _ => panic!("Unexpected event"),
3742         };
3743
3744         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3745         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3746         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3747
3748         nodes[1].node.process_pending_htlc_forwards();
3749
3750         let events_2 = nodes[1].node.get_and_clear_pending_events();
3751         assert_eq!(events_2.len(), 1);
3752         match events_2[0] {
3753                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3754                         assert_eq!(payment_hash_1, *payment_hash);
3755                         assert_eq!(amt, 1000000);
3756                         match &purpose {
3757                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3758                                         assert!(payment_preimage.is_none());
3759                                         assert_eq!(payment_secret_1, *payment_secret);
3760                                 },
3761                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3762                         }
3763                 },
3764                 _ => panic!("Unexpected event"),
3765         }
3766
3767         nodes[1].node.claim_funds(payment_preimage_1);
3768         check_added_monitors!(nodes[1], 1);
3769
3770         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3771         assert_eq!(events_3.len(), 1);
3772         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3773                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3774                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3775                         assert!(updates.update_add_htlcs.is_empty());
3776                         assert!(updates.update_fail_htlcs.is_empty());
3777                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3778                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3779                         assert!(updates.update_fee.is_none());
3780                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3781                 },
3782                 _ => panic!("Unexpected event"),
3783         };
3784
3785         if messages_delivered >= 1 {
3786                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3787
3788                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3789                 assert_eq!(events_4.len(), 1);
3790                 match events_4[0] {
3791                         Event::PaymentSent { ref payment_preimage } => {
3792                                 assert_eq!(payment_preimage_1, *payment_preimage);
3793                         },
3794                         _ => panic!("Unexpected event"),
3795                 }
3796
3797                 if messages_delivered >= 2 {
3798                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3799                         check_added_monitors!(nodes[0], 1);
3800                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3801
3802                         if messages_delivered >= 3 {
3803                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3804                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3805                                 check_added_monitors!(nodes[1], 1);
3806
3807                                 if messages_delivered >= 4 {
3808                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3809                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3810                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3811                                         check_added_monitors!(nodes[1], 1);
3812
3813                                         if messages_delivered >= 5 {
3814                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3815                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3816                                                 check_added_monitors!(nodes[0], 1);
3817                                         }
3818                                 }
3819                         }
3820                 }
3821         }
3822
3823         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3824         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3825         if messages_delivered < 2 {
3826                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3827                 if messages_delivered < 1 {
3828                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3829                         assert_eq!(events_4.len(), 1);
3830                         match events_4[0] {
3831                                 Event::PaymentSent { ref payment_preimage } => {
3832                                         assert_eq!(payment_preimage_1, *payment_preimage);
3833                                 },
3834                                 _ => panic!("Unexpected event"),
3835                         }
3836                 } else {
3837                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3838                 }
3839         } else if messages_delivered == 2 {
3840                 // nodes[0] still wants its RAA + commitment_signed
3841                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3842         } else if messages_delivered == 3 {
3843                 // nodes[0] still wants its commitment_signed
3844                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3845         } else if messages_delivered == 4 {
3846                 // nodes[1] still wants its final RAA
3847                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3848         } else if messages_delivered == 5 {
3849                 // Everything was delivered...
3850                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3851         }
3852
3853         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3854         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3855         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3856
3857         // Channel should still work fine...
3858         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3859         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3860                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3861                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3862         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3863         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3864 }
3865
3866 #[test]
3867 fn test_drop_messages_peer_disconnect_a() {
3868         do_test_drop_messages_peer_disconnect(0, true);
3869         do_test_drop_messages_peer_disconnect(0, false);
3870         do_test_drop_messages_peer_disconnect(1, false);
3871         do_test_drop_messages_peer_disconnect(2, false);
3872 }
3873
3874 #[test]
3875 fn test_drop_messages_peer_disconnect_b() {
3876         do_test_drop_messages_peer_disconnect(3, false);
3877         do_test_drop_messages_peer_disconnect(4, false);
3878         do_test_drop_messages_peer_disconnect(5, false);
3879         do_test_drop_messages_peer_disconnect(6, false);
3880 }
3881
3882 #[test]
3883 fn test_funding_peer_disconnect() {
3884         // Test that we can lock in our funding tx while disconnected
3885         let chanmon_cfgs = create_chanmon_cfgs(2);
3886         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3887         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3888         let persister: test_utils::TestPersister;
3889         let new_chain_monitor: test_utils::TestChainMonitor;
3890         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3891         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3892         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3893
3894         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3895         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896
3897         confirm_transaction(&nodes[0], &tx);
3898         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3899         assert_eq!(events_1.len(), 1);
3900         match events_1[0] {
3901                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3902                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3903                 },
3904                 _ => panic!("Unexpected event"),
3905         }
3906
3907         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3908
3909         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3910         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3911
3912         confirm_transaction(&nodes[1], &tx);
3913         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3914         assert_eq!(events_2.len(), 2);
3915         let funding_locked = match events_2[0] {
3916                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3917                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3918                         msg.clone()
3919                 },
3920                 _ => panic!("Unexpected event"),
3921         };
3922         let bs_announcement_sigs = match events_2[1] {
3923                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3924                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3925                         msg.clone()
3926                 },
3927                 _ => panic!("Unexpected event"),
3928         };
3929
3930         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3931
3932         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3933         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3934         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3935         assert_eq!(events_3.len(), 2);
3936         let as_announcement_sigs = match events_3[0] {
3937                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3938                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3939                         msg.clone()
3940                 },
3941                 _ => panic!("Unexpected event"),
3942         };
3943         let (as_announcement, as_update) = match events_3[1] {
3944                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3945                         (msg.clone(), update_msg.clone())
3946                 },
3947                 _ => panic!("Unexpected event"),
3948         };
3949
3950         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3951         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3952         assert_eq!(events_4.len(), 1);
3953         let (_, bs_update) = match events_4[0] {
3954                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3955                         (msg.clone(), update_msg.clone())
3956                 },
3957                 _ => panic!("Unexpected event"),
3958         };
3959
3960         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3961         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3962         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3963
3964         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3965         let logger = test_utils::TestLogger::new();
3966         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();
3967         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3968         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3969
3970         // Check that after deserialization and reconnection we can still generate an identical
3971         // channel_announcement from the cached signatures.
3972         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3973
3974         let nodes_0_serialized = nodes[0].node.encode();
3975         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3976         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3977
3978         persister = test_utils::TestPersister::new();
3979         let keys_manager = &chanmon_cfgs[0].keys_manager;
3980         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);
3981         nodes[0].chain_monitor = &new_chain_monitor;
3982         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3983         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3984                 &mut chan_0_monitor_read, keys_manager).unwrap();
3985         assert!(chan_0_monitor_read.is_empty());
3986
3987         let mut nodes_0_read = &nodes_0_serialized[..];
3988         let (_, nodes_0_deserialized_tmp) = {
3989                 let mut channel_monitors = HashMap::new();
3990                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3991                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3992                         default_config: UserConfig::default(),
3993                         keys_manager,
3994                         fee_estimator: node_cfgs[0].fee_estimator,
3995                         chain_monitor: nodes[0].chain_monitor,
3996                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3997                         logger: nodes[0].logger,
3998                         channel_monitors,
3999                 }).unwrap()
4000         };
4001         nodes_0_deserialized = nodes_0_deserialized_tmp;
4002         assert!(nodes_0_read.is_empty());
4003
4004         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4005         nodes[0].node = &nodes_0_deserialized;
4006         check_added_monitors!(nodes[0], 1);
4007
4008         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4009
4010         // as_announcement should be re-generated exactly by broadcast_node_announcement.
4011         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
4012         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
4013         let mut found_announcement = false;
4014         for event in msgs.iter() {
4015                 match event {
4016                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
4017                                 if *msg == as_announcement { found_announcement = true; }
4018                         },
4019                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
4020                         _ => panic!("Unexpected event"),
4021                 }
4022         }
4023         assert!(found_announcement);
4024 }
4025
4026 #[test]
4027 fn test_drop_messages_peer_disconnect_dual_htlc() {
4028         // Test that we can handle reconnecting when both sides of a channel have pending
4029         // commitment_updates when we disconnect.
4030         let chanmon_cfgs = create_chanmon_cfgs(2);
4031         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4032         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4033         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4034         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4035         let logger = test_utils::TestLogger::new();
4036
4037         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4038
4039         // Now try to send a second payment which will fail to send
4040         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4041         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4042         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();
4043         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4044         check_added_monitors!(nodes[0], 1);
4045
4046         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4047         assert_eq!(events_1.len(), 1);
4048         match events_1[0] {
4049                 MessageSendEvent::UpdateHTLCs { .. } => {},
4050                 _ => panic!("Unexpected event"),
4051         }
4052
4053         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4054         check_added_monitors!(nodes[1], 1);
4055
4056         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4057         assert_eq!(events_2.len(), 1);
4058         match events_2[0] {
4059                 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 } } => {
4060                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4061                         assert!(update_add_htlcs.is_empty());
4062                         assert_eq!(update_fulfill_htlcs.len(), 1);
4063                         assert!(update_fail_htlcs.is_empty());
4064                         assert!(update_fail_malformed_htlcs.is_empty());
4065                         assert!(update_fee.is_none());
4066
4067                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4068                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4069                         assert_eq!(events_3.len(), 1);
4070                         match events_3[0] {
4071                                 Event::PaymentSent { ref payment_preimage } => {
4072                                         assert_eq!(*payment_preimage, payment_preimage_1);
4073                                 },
4074                                 _ => panic!("Unexpected event"),
4075                         }
4076
4077                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4078                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4079                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4080                         check_added_monitors!(nodes[0], 1);
4081                 },
4082                 _ => panic!("Unexpected event"),
4083         }
4084
4085         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4086         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4087
4088         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4089         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4090         assert_eq!(reestablish_1.len(), 1);
4091         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4092         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4093         assert_eq!(reestablish_2.len(), 1);
4094
4095         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4096         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4097         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4098         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4099
4100         assert!(as_resp.0.is_none());
4101         assert!(bs_resp.0.is_none());
4102
4103         assert!(bs_resp.1.is_none());
4104         assert!(bs_resp.2.is_none());
4105
4106         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4107
4108         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4109         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4110         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4111         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4112         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4113         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4114         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4115         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4116         // No commitment_signed so get_event_msg's assert(len == 1) passes
4117         check_added_monitors!(nodes[1], 1);
4118
4119         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4120         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4121         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4122         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4123         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4124         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4125         assert!(bs_second_commitment_signed.update_fee.is_none());
4126         check_added_monitors!(nodes[1], 1);
4127
4128         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4129         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4130         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4131         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4132         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4133         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4134         assert!(as_commitment_signed.update_fee.is_none());
4135         check_added_monitors!(nodes[0], 1);
4136
4137         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4138         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4139         // No commitment_signed so get_event_msg's assert(len == 1) passes
4140         check_added_monitors!(nodes[0], 1);
4141
4142         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4143         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4144         // No commitment_signed so get_event_msg's assert(len == 1) passes
4145         check_added_monitors!(nodes[1], 1);
4146
4147         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4148         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4149         check_added_monitors!(nodes[1], 1);
4150
4151         expect_pending_htlcs_forwardable!(nodes[1]);
4152
4153         let events_5 = nodes[1].node.get_and_clear_pending_events();
4154         assert_eq!(events_5.len(), 1);
4155         match events_5[0] {
4156                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
4157                         assert_eq!(payment_hash_2, *payment_hash);
4158                         match &purpose {
4159                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4160                                         assert!(payment_preimage.is_none());
4161                                         assert_eq!(payment_secret_2, *payment_secret);
4162                                 },
4163                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
4164                         }
4165                 },
4166                 _ => panic!("Unexpected event"),
4167         }
4168
4169         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4170         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4171         check_added_monitors!(nodes[0], 1);
4172
4173         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4174 }
4175
4176 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4177         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4178         // to avoid our counterparty failing the channel.
4179         let chanmon_cfgs = create_chanmon_cfgs(2);
4180         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4181         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4182         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4183
4184         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4185         let logger = test_utils::TestLogger::new();
4186
4187         let our_payment_hash = if send_partial_mpp {
4188                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4189                 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();
4190                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4191                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4192                 // indicates there are more HTLCs coming.
4193                 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.
4194                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4195                 check_added_monitors!(nodes[0], 1);
4196                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4197                 assert_eq!(events.len(), 1);
4198                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4199                 // hop should *not* yet generate any PaymentReceived event(s).
4200                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false, None);
4201                 our_payment_hash
4202         } else {
4203                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4204         };
4205
4206         let mut block = Block {
4207                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4208                 txdata: vec![],
4209         };
4210         connect_block(&nodes[0], &block);
4211         connect_block(&nodes[1], &block);
4212         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4213         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4214                 block.header.prev_blockhash = block.block_hash();
4215                 connect_block(&nodes[0], &block);
4216                 connect_block(&nodes[1], &block);
4217         }
4218
4219         expect_pending_htlcs_forwardable!(nodes[1]);
4220
4221         check_added_monitors!(nodes[1], 1);
4222         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4223         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4224         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4225         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4226         assert!(htlc_timeout_updates.update_fee.is_none());
4227
4228         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4229         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4230         // 100_000 msat as u64, followed by the height at which we failed back above
4231         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4232         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4233         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4234 }
4235
4236 #[test]
4237 fn test_htlc_timeout() {
4238         do_test_htlc_timeout(true);
4239         do_test_htlc_timeout(false);
4240 }
4241
4242 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4243         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4244         let chanmon_cfgs = create_chanmon_cfgs(3);
4245         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4246         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4247         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4248         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4249         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4250
4251         // Make sure all nodes are at the same starting height
4252         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4253         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4254         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4255
4256         let logger = test_utils::TestLogger::new();
4257
4258         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4259         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4260         {
4261                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4262                 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();
4263                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4264         }
4265         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4266         check_added_monitors!(nodes[1], 1);
4267
4268         // Now attempt to route a second payment, which should be placed in the holding cell
4269         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4270         if forwarded_htlc {
4271                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4272                 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();
4273                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4274                 check_added_monitors!(nodes[0], 1);
4275                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4276                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4277                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4278                 expect_pending_htlcs_forwardable!(nodes[1]);
4279                 check_added_monitors!(nodes[1], 0);
4280         } else {
4281                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4282                 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();
4283                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4284                 check_added_monitors!(nodes[1], 0);
4285         }
4286
4287         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4288         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4289         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4290         connect_blocks(&nodes[1], 1);
4291
4292         if forwarded_htlc {
4293                 expect_pending_htlcs_forwardable!(nodes[1]);
4294                 check_added_monitors!(nodes[1], 1);
4295                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4296                 assert_eq!(fail_commit.len(), 1);
4297                 match fail_commit[0] {
4298                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4299                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4300                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4301                         },
4302                         _ => unreachable!(),
4303                 }
4304                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4305                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4306         } else {
4307                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4308         }
4309 }
4310
4311 #[test]
4312 fn test_holding_cell_htlc_add_timeouts() {
4313         do_test_holding_cell_htlc_add_timeouts(false);
4314         do_test_holding_cell_htlc_add_timeouts(true);
4315 }
4316
4317 #[test]
4318 fn test_invalid_channel_announcement() {
4319         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4320         let secp_ctx = Secp256k1::new();
4321         let chanmon_cfgs = create_chanmon_cfgs(2);
4322         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4323         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4324         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4325
4326         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4327
4328         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4329         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4330         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4331         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4332
4333         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 } );
4334
4335         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4336         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4337
4338         let as_network_key = nodes[0].node.get_our_node_id();
4339         let bs_network_key = nodes[1].node.get_our_node_id();
4340
4341         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4342
4343         let mut chan_announcement;
4344
4345         macro_rules! dummy_unsigned_msg {
4346                 () => {
4347                         msgs::UnsignedChannelAnnouncement {
4348                                 features: ChannelFeatures::known(),
4349                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4350                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4351                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4352                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4353                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4354                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4355                                 excess_data: Vec::new(),
4356                         };
4357                 }
4358         }
4359
4360         macro_rules! sign_msg {
4361                 ($unsigned_msg: expr) => {
4362                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4363                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4364                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4365                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4366                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4367                         chan_announcement = msgs::ChannelAnnouncement {
4368                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4369                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4370                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4371                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4372                                 contents: $unsigned_msg
4373                         }
4374                 }
4375         }
4376
4377         let unsigned_msg = dummy_unsigned_msg!();
4378         sign_msg!(unsigned_msg);
4379         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4380         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 } );
4381
4382         // Configured with Network::Testnet
4383         let mut unsigned_msg = dummy_unsigned_msg!();
4384         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4385         sign_msg!(unsigned_msg);
4386         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4387
4388         let mut unsigned_msg = dummy_unsigned_msg!();
4389         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4390         sign_msg!(unsigned_msg);
4391         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4392 }
4393
4394 #[test]
4395 fn test_no_txn_manager_serialize_deserialize() {
4396         let chanmon_cfgs = create_chanmon_cfgs(2);
4397         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4398         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4399         let logger: test_utils::TestLogger;
4400         let fee_estimator: test_utils::TestFeeEstimator;
4401         let persister: test_utils::TestPersister;
4402         let new_chain_monitor: test_utils::TestChainMonitor;
4403         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4404         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4405
4406         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4407
4408         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4409
4410         let nodes_0_serialized = nodes[0].node.encode();
4411         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4412         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4413
4414         logger = test_utils::TestLogger::new();
4415         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4416         persister = test_utils::TestPersister::new();
4417         let keys_manager = &chanmon_cfgs[0].keys_manager;
4418         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4419         nodes[0].chain_monitor = &new_chain_monitor;
4420         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4421         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4422                 &mut chan_0_monitor_read, keys_manager).unwrap();
4423         assert!(chan_0_monitor_read.is_empty());
4424
4425         let mut nodes_0_read = &nodes_0_serialized[..];
4426         let config = UserConfig::default();
4427         let (_, nodes_0_deserialized_tmp) = {
4428                 let mut channel_monitors = HashMap::new();
4429                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4430                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4431                         default_config: config,
4432                         keys_manager,
4433                         fee_estimator: &fee_estimator,
4434                         chain_monitor: nodes[0].chain_monitor,
4435                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4436                         logger: &logger,
4437                         channel_monitors,
4438                 }).unwrap()
4439         };
4440         nodes_0_deserialized = nodes_0_deserialized_tmp;
4441         assert!(nodes_0_read.is_empty());
4442
4443         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4444         nodes[0].node = &nodes_0_deserialized;
4445         assert_eq!(nodes[0].node.list_channels().len(), 1);
4446         check_added_monitors!(nodes[0], 1);
4447
4448         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4449         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4450         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4451         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4452
4453         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4454         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4455         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4456         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4457
4458         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4459         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4460         for node in nodes.iter() {
4461                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4462                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4463                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4464         }
4465
4466         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4467 }
4468
4469 #[test]
4470 fn test_dup_htlc_onchain_fails_on_reload() {
4471         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4472         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4473         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4474         // the ChannelMonitor tells it to.
4475         //
4476         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4477         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4478         // PaymentFailed event appearing). However, because we may not serialize the relevant
4479         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4480         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4481         // and de-duplicates ChannelMonitor events.
4482         //
4483         // This tests that explicit tracking behavior.
4484         let chanmon_cfgs = create_chanmon_cfgs(2);
4485         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4486         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4487         let persister: test_utils::TestPersister;
4488         let new_chain_monitor: test_utils::TestChainMonitor;
4489         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4490         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4491
4492         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4493
4494         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4495         // nodes[0].
4496         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4497         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4498         check_closed_broadcast!(nodes[0], true);
4499         check_added_monitors!(nodes[0], 1);
4500
4501         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4502         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4503
4504         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4505         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4506         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4507         assert_eq!(node_txn.len(), 3);
4508         assert_eq!(node_txn[0], node_txn[1]);
4509
4510         assert!(nodes[1].node.claim_funds(payment_preimage));
4511         check_added_monitors!(nodes[1], 1);
4512
4513         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4514         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4515         check_closed_broadcast!(nodes[1], true);
4516         check_added_monitors!(nodes[1], 1);
4517         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4518
4519         header.prev_blockhash = nodes[0].best_block_hash();
4520         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4521
4522         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4523         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4524         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4525         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4526         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4527
4528         header.prev_blockhash = nodes[0].best_block_hash();
4529         let claim_block = Block { header, txdata: claim_txn};
4530         connect_block(&nodes[0], &claim_block);
4531         expect_payment_sent!(nodes[0], payment_preimage);
4532
4533         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4534         // connected a highly-relevant block, it likely gets serialized out now.
4535         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4536         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4537
4538         // Now reload nodes[0]...
4539         persister = test_utils::TestPersister::new();
4540         let keys_manager = &chanmon_cfgs[0].keys_manager;
4541         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);
4542         nodes[0].chain_monitor = &new_chain_monitor;
4543         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4544         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4545                 &mut chan_0_monitor_read, keys_manager).unwrap();
4546         assert!(chan_0_monitor_read.is_empty());
4547
4548         let (_, nodes_0_deserialized_tmp) = {
4549                 let mut channel_monitors = HashMap::new();
4550                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4551                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4552                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4553                                 default_config: Default::default(),
4554                                 keys_manager,
4555                                 fee_estimator: node_cfgs[0].fee_estimator,
4556                                 chain_monitor: nodes[0].chain_monitor,
4557                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4558                                 logger: nodes[0].logger,
4559                                 channel_monitors,
4560                         }).unwrap()
4561         };
4562         nodes_0_deserialized = nodes_0_deserialized_tmp;
4563
4564         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4565         check_added_monitors!(nodes[0], 1);
4566         nodes[0].node = &nodes_0_deserialized;
4567
4568         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4569         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4570         // payment events should kick in, leaving us with no pending events here.
4571         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4572         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4573         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4574 }
4575
4576 #[test]
4577 fn test_manager_serialize_deserialize_events() {
4578         // This test makes sure the events field in ChannelManager survives de/serialization
4579         let chanmon_cfgs = create_chanmon_cfgs(2);
4580         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4581         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4582         let fee_estimator: test_utils::TestFeeEstimator;
4583         let persister: test_utils::TestPersister;
4584         let logger: test_utils::TestLogger;
4585         let new_chain_monitor: test_utils::TestChainMonitor;
4586         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4587         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4588
4589         // Start creating a channel, but stop right before broadcasting the funding transaction
4590         let channel_value = 100000;
4591         let push_msat = 10001;
4592         let a_flags = InitFeatures::known();
4593         let b_flags = InitFeatures::known();
4594         let node_a = nodes.remove(0);
4595         let node_b = nodes.remove(0);
4596         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4597         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()));
4598         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()));
4599
4600         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4601
4602         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4603         check_added_monitors!(node_a, 0);
4604
4605         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()));
4606         {
4607                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4608                 assert_eq!(added_monitors.len(), 1);
4609                 assert_eq!(added_monitors[0].0, funding_output);
4610                 added_monitors.clear();
4611         }
4612
4613         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()));
4614         {
4615                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4616                 assert_eq!(added_monitors.len(), 1);
4617                 assert_eq!(added_monitors[0].0, funding_output);
4618                 added_monitors.clear();
4619         }
4620         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4621
4622         nodes.push(node_a);
4623         nodes.push(node_b);
4624
4625         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4626         let nodes_0_serialized = nodes[0].node.encode();
4627         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4628         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4629
4630         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4631         logger = test_utils::TestLogger::new();
4632         persister = test_utils::TestPersister::new();
4633         let keys_manager = &chanmon_cfgs[0].keys_manager;
4634         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4635         nodes[0].chain_monitor = &new_chain_monitor;
4636         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4637         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4638                 &mut chan_0_monitor_read, keys_manager).unwrap();
4639         assert!(chan_0_monitor_read.is_empty());
4640
4641         let mut nodes_0_read = &nodes_0_serialized[..];
4642         let config = UserConfig::default();
4643         let (_, nodes_0_deserialized_tmp) = {
4644                 let mut channel_monitors = HashMap::new();
4645                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4646                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4647                         default_config: config,
4648                         keys_manager,
4649                         fee_estimator: &fee_estimator,
4650                         chain_monitor: nodes[0].chain_monitor,
4651                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4652                         logger: &logger,
4653                         channel_monitors,
4654                 }).unwrap()
4655         };
4656         nodes_0_deserialized = nodes_0_deserialized_tmp;
4657         assert!(nodes_0_read.is_empty());
4658
4659         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4660
4661         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4662         nodes[0].node = &nodes_0_deserialized;
4663
4664         // After deserializing, make sure the funding_transaction is still held by the channel manager
4665         let events_4 = nodes[0].node.get_and_clear_pending_events();
4666         assert_eq!(events_4.len(), 0);
4667         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4668         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4669
4670         // Make sure the channel is functioning as though the de/serialization never happened
4671         assert_eq!(nodes[0].node.list_channels().len(), 1);
4672         check_added_monitors!(nodes[0], 1);
4673
4674         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4675         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4676         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4677         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4678
4679         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4680         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4681         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4682         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4683
4684         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4685         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4686         for node in nodes.iter() {
4687                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4688                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4689                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4690         }
4691
4692         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4693 }
4694
4695 #[test]
4696 fn test_simple_manager_serialize_deserialize() {
4697         let chanmon_cfgs = create_chanmon_cfgs(2);
4698         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4699         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4700         let logger: test_utils::TestLogger;
4701         let fee_estimator: test_utils::TestFeeEstimator;
4702         let persister: test_utils::TestPersister;
4703         let new_chain_monitor: test_utils::TestChainMonitor;
4704         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4705         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4706         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4707
4708         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4709         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4710
4711         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4712
4713         let nodes_0_serialized = nodes[0].node.encode();
4714         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4715         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4716
4717         logger = test_utils::TestLogger::new();
4718         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4719         persister = test_utils::TestPersister::new();
4720         let keys_manager = &chanmon_cfgs[0].keys_manager;
4721         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4722         nodes[0].chain_monitor = &new_chain_monitor;
4723         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4724         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4725                 &mut chan_0_monitor_read, keys_manager).unwrap();
4726         assert!(chan_0_monitor_read.is_empty());
4727
4728         let mut nodes_0_read = &nodes_0_serialized[..];
4729         let (_, nodes_0_deserialized_tmp) = {
4730                 let mut channel_monitors = HashMap::new();
4731                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4732                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4733                         default_config: UserConfig::default(),
4734                         keys_manager,
4735                         fee_estimator: &fee_estimator,
4736                         chain_monitor: nodes[0].chain_monitor,
4737                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4738                         logger: &logger,
4739                         channel_monitors,
4740                 }).unwrap()
4741         };
4742         nodes_0_deserialized = nodes_0_deserialized_tmp;
4743         assert!(nodes_0_read.is_empty());
4744
4745         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4746         nodes[0].node = &nodes_0_deserialized;
4747         check_added_monitors!(nodes[0], 1);
4748
4749         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4750
4751         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4752         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4753 }
4754
4755 #[test]
4756 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4757         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4758         let chanmon_cfgs = create_chanmon_cfgs(4);
4759         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4760         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4761         let logger: test_utils::TestLogger;
4762         let fee_estimator: test_utils::TestFeeEstimator;
4763         let persister: test_utils::TestPersister;
4764         let new_chain_monitor: test_utils::TestChainMonitor;
4765         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4766         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4767         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4768         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4769         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4770
4771         let mut node_0_stale_monitors_serialized = Vec::new();
4772         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4773                 let mut writer = test_utils::TestVecWriter(Vec::new());
4774                 monitor.1.write(&mut writer).unwrap();
4775                 node_0_stale_monitors_serialized.push(writer.0);
4776         }
4777
4778         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4779
4780         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4781         let nodes_0_serialized = nodes[0].node.encode();
4782
4783         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4784         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4785         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4786         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4787
4788         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4789         // nodes[3])
4790         let mut node_0_monitors_serialized = Vec::new();
4791         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4792                 let mut writer = test_utils::TestVecWriter(Vec::new());
4793                 monitor.1.write(&mut writer).unwrap();
4794                 node_0_monitors_serialized.push(writer.0);
4795         }
4796
4797         logger = test_utils::TestLogger::new();
4798         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4799         persister = test_utils::TestPersister::new();
4800         let keys_manager = &chanmon_cfgs[0].keys_manager;
4801         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4802         nodes[0].chain_monitor = &new_chain_monitor;
4803
4804
4805         let mut node_0_stale_monitors = Vec::new();
4806         for serialized in node_0_stale_monitors_serialized.iter() {
4807                 let mut read = &serialized[..];
4808                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4809                 assert!(read.is_empty());
4810                 node_0_stale_monitors.push(monitor);
4811         }
4812
4813         let mut node_0_monitors = Vec::new();
4814         for serialized in node_0_monitors_serialized.iter() {
4815                 let mut read = &serialized[..];
4816                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4817                 assert!(read.is_empty());
4818                 node_0_monitors.push(monitor);
4819         }
4820
4821         let mut nodes_0_read = &nodes_0_serialized[..];
4822         if let Err(msgs::DecodeError::InvalidValue) =
4823                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4824                 default_config: UserConfig::default(),
4825                 keys_manager,
4826                 fee_estimator: &fee_estimator,
4827                 chain_monitor: nodes[0].chain_monitor,
4828                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4829                 logger: &logger,
4830                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4831         }) { } else {
4832                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4833         };
4834
4835         let mut nodes_0_read = &nodes_0_serialized[..];
4836         let (_, nodes_0_deserialized_tmp) =
4837                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4838                 default_config: UserConfig::default(),
4839                 keys_manager,
4840                 fee_estimator: &fee_estimator,
4841                 chain_monitor: nodes[0].chain_monitor,
4842                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4843                 logger: &logger,
4844                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4845         }).unwrap();
4846         nodes_0_deserialized = nodes_0_deserialized_tmp;
4847         assert!(nodes_0_read.is_empty());
4848
4849         { // Channel close should result in a commitment tx
4850                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4851                 assert_eq!(txn.len(), 1);
4852                 check_spends!(txn[0], funding_tx);
4853                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4854         }
4855
4856         for monitor in node_0_monitors.drain(..) {
4857                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4858                 check_added_monitors!(nodes[0], 1);
4859         }
4860         nodes[0].node = &nodes_0_deserialized;
4861
4862         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4863         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4864         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4865         //... and we can even still claim the payment!
4866         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4867
4868         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4869         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4870         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4871         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4872         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4873         assert_eq!(msg_events.len(), 1);
4874         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4875                 match action {
4876                         &ErrorAction::SendErrorMessage { ref msg } => {
4877                                 assert_eq!(msg.channel_id, channel_id);
4878                         },
4879                         _ => panic!("Unexpected event!"),
4880                 }
4881         }
4882 }
4883
4884 macro_rules! check_spendable_outputs {
4885         ($node: expr, $keysinterface: expr) => {
4886                 {
4887                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4888                         let mut txn = Vec::new();
4889                         let mut all_outputs = Vec::new();
4890                         let secp_ctx = Secp256k1::new();
4891                         for event in events.drain(..) {
4892                                 match event {
4893                                         Event::SpendableOutputs { mut outputs } => {
4894                                                 for outp in outputs.drain(..) {
4895                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4896                                                         all_outputs.push(outp);
4897                                                 }
4898                                         },
4899                                         _ => panic!("Unexpected event"),
4900                                 };
4901                         }
4902                         if all_outputs.len() > 1 {
4903                                 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) {
4904                                         txn.push(tx);
4905                                 }
4906                         }
4907                         txn
4908                 }
4909         }
4910 }
4911
4912 #[test]
4913 fn test_claim_sizeable_push_msat() {
4914         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4915         let chanmon_cfgs = create_chanmon_cfgs(2);
4916         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4917         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4918         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4919
4920         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4921         nodes[1].node.force_close_channel(&chan.2).unwrap();
4922         check_closed_broadcast!(nodes[1], true);
4923         check_added_monitors!(nodes[1], 1);
4924         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4925         assert_eq!(node_txn.len(), 1);
4926         check_spends!(node_txn[0], chan.3);
4927         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
4928
4929         mine_transaction(&nodes[1], &node_txn[0]);
4930         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4931
4932         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4933         assert_eq!(spend_txn.len(), 1);
4934         assert_eq!(spend_txn[0].input.len(), 1);
4935         check_spends!(spend_txn[0], node_txn[0]);
4936         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4937 }
4938
4939 #[test]
4940 fn test_claim_on_remote_sizeable_push_msat() {
4941         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4942         // to_remote output is encumbered by a P2WPKH
4943         let chanmon_cfgs = create_chanmon_cfgs(2);
4944         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4945         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4946         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4947
4948         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4949         nodes[0].node.force_close_channel(&chan.2).unwrap();
4950         check_closed_broadcast!(nodes[0], true);
4951         check_added_monitors!(nodes[0], 1);
4952
4953         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4954         assert_eq!(node_txn.len(), 1);
4955         check_spends!(node_txn[0], chan.3);
4956         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
4957
4958         mine_transaction(&nodes[1], &node_txn[0]);
4959         check_closed_broadcast!(nodes[1], true);
4960         check_added_monitors!(nodes[1], 1);
4961         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4962
4963         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4964         assert_eq!(spend_txn.len(), 1);
4965         check_spends!(spend_txn[0], node_txn[0]);
4966 }
4967
4968 #[test]
4969 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4970         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4971         // to_remote output is encumbered by a P2WPKH
4972
4973         let chanmon_cfgs = create_chanmon_cfgs(2);
4974         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4975         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4976         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4977
4978         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4979         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4980         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4981         assert_eq!(revoked_local_txn[0].input.len(), 1);
4982         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4983
4984         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4985         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4986         check_closed_broadcast!(nodes[1], true);
4987         check_added_monitors!(nodes[1], 1);
4988
4989         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4990         mine_transaction(&nodes[1], &node_txn[0]);
4991         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4992
4993         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4994         assert_eq!(spend_txn.len(), 3);
4995         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4996         check_spends!(spend_txn[1], node_txn[0]);
4997         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4998 }
4999
5000 #[test]
5001 fn test_static_spendable_outputs_preimage_tx() {
5002         let chanmon_cfgs = create_chanmon_cfgs(2);
5003         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5004         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5005         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5006
5007         // Create some initial channels
5008         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5009
5010         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5011
5012         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5013         assert_eq!(commitment_tx[0].input.len(), 1);
5014         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5015
5016         // Settle A's commitment tx on B's chain
5017         assert!(nodes[1].node.claim_funds(payment_preimage));
5018         check_added_monitors!(nodes[1], 1);
5019         mine_transaction(&nodes[1], &commitment_tx[0]);
5020         check_added_monitors!(nodes[1], 1);
5021         let events = nodes[1].node.get_and_clear_pending_msg_events();
5022         match events[0] {
5023                 MessageSendEvent::UpdateHTLCs { .. } => {},
5024                 _ => panic!("Unexpected event"),
5025         }
5026         match events[1] {
5027                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5028                 _ => panic!("Unexepected event"),
5029         }
5030
5031         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5032         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
5033         assert_eq!(node_txn.len(), 3);
5034         check_spends!(node_txn[0], commitment_tx[0]);
5035         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5036         check_spends!(node_txn[1], chan_1.3);
5037         check_spends!(node_txn[2], node_txn[1]);
5038
5039         mine_transaction(&nodes[1], &node_txn[0]);
5040         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5041
5042         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5043         assert_eq!(spend_txn.len(), 1);
5044         check_spends!(spend_txn[0], node_txn[0]);
5045 }
5046
5047 #[test]
5048 fn test_static_spendable_outputs_timeout_tx() {
5049         let chanmon_cfgs = create_chanmon_cfgs(2);
5050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5053
5054         // Create some initial channels
5055         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5056
5057         // Rebalance the network a bit by relaying one payment through all the channels ...
5058         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5059
5060         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5061
5062         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5063         assert_eq!(commitment_tx[0].input.len(), 1);
5064         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5065
5066         // Settle A's commitment tx on B' chain
5067         mine_transaction(&nodes[1], &commitment_tx[0]);
5068         check_added_monitors!(nodes[1], 1);
5069         let events = nodes[1].node.get_and_clear_pending_msg_events();
5070         match events[0] {
5071                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5072                 _ => panic!("Unexpected event"),
5073         }
5074         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5075
5076         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5077         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5078         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5079         check_spends!(node_txn[0], chan_1.3.clone());
5080         check_spends!(node_txn[1],  commitment_tx[0].clone());
5081         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5082
5083         mine_transaction(&nodes[1], &node_txn[1]);
5084         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5085         expect_payment_failed!(nodes[1], our_payment_hash, true);
5086
5087         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5088         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5089         check_spends!(spend_txn[0], commitment_tx[0]);
5090         check_spends!(spend_txn[1], node_txn[1]);
5091         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5092 }
5093
5094 #[test]
5095 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5096         let chanmon_cfgs = create_chanmon_cfgs(2);
5097         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5098         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5099         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5100
5101         // Create some initial channels
5102         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5103
5104         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5105         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5106         assert_eq!(revoked_local_txn[0].input.len(), 1);
5107         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5108
5109         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5110
5111         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5112         check_closed_broadcast!(nodes[1], true);
5113         check_added_monitors!(nodes[1], 1);
5114
5115         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5116         assert_eq!(node_txn.len(), 2);
5117         assert_eq!(node_txn[0].input.len(), 2);
5118         check_spends!(node_txn[0], revoked_local_txn[0]);
5119
5120         mine_transaction(&nodes[1], &node_txn[0]);
5121         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5122
5123         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5124         assert_eq!(spend_txn.len(), 1);
5125         check_spends!(spend_txn[0], node_txn[0]);
5126 }
5127
5128 #[test]
5129 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5130         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5131         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5132         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5135
5136         // Create some initial channels
5137         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5138
5139         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5140         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5141         assert_eq!(revoked_local_txn[0].input.len(), 1);
5142         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5143
5144         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5145
5146         // A will generate HTLC-Timeout from revoked commitment tx
5147         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5148         check_closed_broadcast!(nodes[0], true);
5149         check_added_monitors!(nodes[0], 1);
5150         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5151
5152         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5153         assert_eq!(revoked_htlc_txn.len(), 2);
5154         check_spends!(revoked_htlc_txn[0], chan_1.3);
5155         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5156         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5157         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5158         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5159
5160         // B will generate justice tx from A's revoked commitment/HTLC tx
5161         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5162         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5163         check_closed_broadcast!(nodes[1], true);
5164         check_added_monitors!(nodes[1], 1);
5165
5166         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5167         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5168         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5169         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5170         // transactions next...
5171         assert_eq!(node_txn[0].input.len(), 3);
5172         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5173
5174         assert_eq!(node_txn[1].input.len(), 2);
5175         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5176         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5177                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5178         } else {
5179                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5180                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5181         }
5182
5183         assert_eq!(node_txn[2].input.len(), 1);
5184         check_spends!(node_txn[2], chan_1.3);
5185
5186         mine_transaction(&nodes[1], &node_txn[1]);
5187         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5188
5189         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5190         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5191         assert_eq!(spend_txn.len(), 1);
5192         assert_eq!(spend_txn[0].input.len(), 1);
5193         check_spends!(spend_txn[0], node_txn[1]);
5194 }
5195
5196 #[test]
5197 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5198         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5199         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5202         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5203
5204         // Create some initial channels
5205         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5206
5207         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5208         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5209         assert_eq!(revoked_local_txn[0].input.len(), 1);
5210         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5211
5212         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5213         assert_eq!(revoked_local_txn[0].output.len(), 2);
5214
5215         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5216
5217         // B will generate HTLC-Success from revoked commitment tx
5218         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5219         check_closed_broadcast!(nodes[1], true);
5220         check_added_monitors!(nodes[1], 1);
5221         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5222
5223         assert_eq!(revoked_htlc_txn.len(), 2);
5224         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5225         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5226         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5227
5228         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5229         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5230         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5231
5232         // A will generate justice tx from B's revoked commitment/HTLC tx
5233         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5234         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5235         check_closed_broadcast!(nodes[0], true);
5236         check_added_monitors!(nodes[0], 1);
5237
5238         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5239         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5240
5241         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5242         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5243         // transactions next...
5244         assert_eq!(node_txn[0].input.len(), 2);
5245         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5246         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5247                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5248         } else {
5249                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5250                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5251         }
5252
5253         assert_eq!(node_txn[1].input.len(), 1);
5254         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5255
5256         check_spends!(node_txn[2], chan_1.3);
5257
5258         mine_transaction(&nodes[0], &node_txn[1]);
5259         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5260
5261         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5262         // didn't try to generate any new transactions.
5263
5264         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5265         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5266         assert_eq!(spend_txn.len(), 3);
5267         assert_eq!(spend_txn[0].input.len(), 1);
5268         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5269         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5270         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5271         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5272 }
5273
5274 #[test]
5275 fn test_onchain_to_onchain_claim() {
5276         // Test that in case of channel closure, we detect the state of output and claim HTLC
5277         // on downstream peer's remote commitment tx.
5278         // First, have C claim an HTLC against its own latest commitment transaction.
5279         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5280         // channel.
5281         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5282         // gets broadcast.
5283
5284         let chanmon_cfgs = create_chanmon_cfgs(3);
5285         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5286         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5287         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5288
5289         // Create some initial channels
5290         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5291         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5292
5293         // Ensure all nodes are at the same height
5294         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5295         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5296         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5297         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5298
5299         // Rebalance the network a bit by relaying one payment through all the channels ...
5300         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5301         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5302
5303         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5304         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5305         check_spends!(commitment_tx[0], chan_2.3);
5306         nodes[2].node.claim_funds(payment_preimage);
5307         check_added_monitors!(nodes[2], 1);
5308         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5309         assert!(updates.update_add_htlcs.is_empty());
5310         assert!(updates.update_fail_htlcs.is_empty());
5311         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5312         assert!(updates.update_fail_malformed_htlcs.is_empty());
5313
5314         mine_transaction(&nodes[2], &commitment_tx[0]);
5315         check_closed_broadcast!(nodes[2], true);
5316         check_added_monitors!(nodes[2], 1);
5317
5318         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5319         assert_eq!(c_txn.len(), 3);
5320         assert_eq!(c_txn[0], c_txn[2]);
5321         assert_eq!(commitment_tx[0], c_txn[1]);
5322         check_spends!(c_txn[1], chan_2.3);
5323         check_spends!(c_txn[2], c_txn[1]);
5324         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5325         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5326         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5327         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5328
5329         // 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
5330         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5331         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5332         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5333         {
5334                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5335                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5336                 assert_eq!(b_txn.len(), 2);
5337                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5338                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5339                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5340                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5341                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5342                 b_txn.clear();
5343         }
5344         check_added_monitors!(nodes[1], 1);
5345         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5346         assert_eq!(msg_events.len(), 3);
5347         check_added_monitors!(nodes[1], 1);
5348         match msg_events[0] {
5349                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5350                 _ => panic!("Unexpected event"),
5351         }
5352         match msg_events[1] {
5353                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5354                 _ => panic!("Unexpected event"),
5355         }
5356         match msg_events[2] {
5357                 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, .. } } => {
5358                         assert!(update_add_htlcs.is_empty());
5359                         assert!(update_fail_htlcs.is_empty());
5360                         assert_eq!(update_fulfill_htlcs.len(), 1);
5361                         assert!(update_fail_malformed_htlcs.is_empty());
5362                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5363                 },
5364                 _ => panic!("Unexpected event"),
5365         };
5366         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5367         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5368         mine_transaction(&nodes[1], &commitment_tx[0]);
5369         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5370         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5371         assert_eq!(b_txn.len(), 4);
5372         check_spends!(b_txn[2], chan_1.3);
5373         check_spends!(b_txn[3], b_txn[2]);
5374         let (htlc_success_claim, htlc_timeout_bumped) =
5375                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5376                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5377         check_spends!(htlc_success_claim, commitment_tx[0]);
5378         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5379         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5380         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5381         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5382         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5383
5384         check_closed_broadcast!(nodes[1], true);
5385         check_added_monitors!(nodes[1], 1);
5386 }
5387
5388 #[test]
5389 fn test_duplicate_payment_hash_one_failure_one_success() {
5390         // Topology : A --> B --> C --> D
5391         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5392         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5393         // we forward one of the payments onwards to D.
5394         let chanmon_cfgs = create_chanmon_cfgs(4);
5395         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5396         // When this test was written, the default base fee floated based on the HTLC count.
5397         // It is now fixed, so we simply set the fee to the expected value here.
5398         let mut config = test_default_channel_config();
5399         config.channel_options.forwarding_fee_base_msat = 196;
5400         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5401                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5402         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5403
5404         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5405         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5406         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5407
5408         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5409         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5410         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5411         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5412         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5413
5414         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5415
5416         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5417         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5418         // script push size limit so that the below script length checks match
5419         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5420         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5421                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5422         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5423
5424         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5425         assert_eq!(commitment_txn[0].input.len(), 1);
5426         check_spends!(commitment_txn[0], chan_2.3);
5427
5428         mine_transaction(&nodes[1], &commitment_txn[0]);
5429         check_closed_broadcast!(nodes[1], true);
5430         check_added_monitors!(nodes[1], 1);
5431         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5432
5433         let htlc_timeout_tx;
5434         { // Extract one of the two HTLC-Timeout transaction
5435                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5436                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5437                 assert_eq!(node_txn.len(), 4);
5438                 check_spends!(node_txn[0], chan_2.3);
5439
5440                 check_spends!(node_txn[1], commitment_txn[0]);
5441                 assert_eq!(node_txn[1].input.len(), 1);
5442                 check_spends!(node_txn[2], commitment_txn[0]);
5443                 assert_eq!(node_txn[2].input.len(), 1);
5444                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5445                 check_spends!(node_txn[3], commitment_txn[0]);
5446                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5447
5448                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5449                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5450                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5451                 htlc_timeout_tx = node_txn[1].clone();
5452         }
5453
5454         nodes[2].node.claim_funds(our_payment_preimage);
5455         mine_transaction(&nodes[2], &commitment_txn[0]);
5456         check_added_monitors!(nodes[2], 2);
5457         let events = nodes[2].node.get_and_clear_pending_msg_events();
5458         match events[0] {
5459                 MessageSendEvent::UpdateHTLCs { .. } => {},
5460                 _ => panic!("Unexpected event"),
5461         }
5462         match events[1] {
5463                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5464                 _ => panic!("Unexepected event"),
5465         }
5466         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5467         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)
5468         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5469         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5470         assert_eq!(htlc_success_txn[0].input.len(), 1);
5471         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5472         assert_eq!(htlc_success_txn[1].input.len(), 1);
5473         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5474         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5475         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5476         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5477         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5478         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5479
5480         mine_transaction(&nodes[1], &htlc_timeout_tx);
5481         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5482         expect_pending_htlcs_forwardable!(nodes[1]);
5483         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5484         assert!(htlc_updates.update_add_htlcs.is_empty());
5485         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5486         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5487         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5488         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5489         check_added_monitors!(nodes[1], 1);
5490
5491         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5492         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5493         {
5494                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5495                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5496         }
5497         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5498
5499         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5500         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5501         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5502         assert!(updates.update_add_htlcs.is_empty());
5503         assert!(updates.update_fail_htlcs.is_empty());
5504         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5505         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5506         assert!(updates.update_fail_malformed_htlcs.is_empty());
5507         check_added_monitors!(nodes[1], 1);
5508
5509         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5510         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5511
5512         let events = nodes[0].node.get_and_clear_pending_events();
5513         match events[0] {
5514                 Event::PaymentSent { ref payment_preimage } => {
5515                         assert_eq!(*payment_preimage, our_payment_preimage);
5516                 }
5517                 _ => panic!("Unexpected event"),
5518         }
5519 }
5520
5521 #[test]
5522 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5523         let chanmon_cfgs = create_chanmon_cfgs(2);
5524         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5525         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5526         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5527
5528         // Create some initial channels
5529         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5530
5531         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5532         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5533         assert_eq!(local_txn.len(), 1);
5534         assert_eq!(local_txn[0].input.len(), 1);
5535         check_spends!(local_txn[0], chan_1.3);
5536
5537         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5538         nodes[1].node.claim_funds(payment_preimage);
5539         check_added_monitors!(nodes[1], 1);
5540         mine_transaction(&nodes[1], &local_txn[0]);
5541         check_added_monitors!(nodes[1], 1);
5542         let events = nodes[1].node.get_and_clear_pending_msg_events();
5543         match events[0] {
5544                 MessageSendEvent::UpdateHTLCs { .. } => {},
5545                 _ => panic!("Unexpected event"),
5546         }
5547         match events[1] {
5548                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5549                 _ => panic!("Unexepected event"),
5550         }
5551         let node_tx = {
5552                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5553                 assert_eq!(node_txn.len(), 3);
5554                 assert_eq!(node_txn[0], node_txn[2]);
5555                 assert_eq!(node_txn[1], local_txn[0]);
5556                 assert_eq!(node_txn[0].input.len(), 1);
5557                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5558                 check_spends!(node_txn[0], local_txn[0]);
5559                 node_txn[0].clone()
5560         };
5561
5562         mine_transaction(&nodes[1], &node_tx);
5563         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5564
5565         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5566         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5567         assert_eq!(spend_txn.len(), 1);
5568         assert_eq!(spend_txn[0].input.len(), 1);
5569         check_spends!(spend_txn[0], node_tx);
5570         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5571 }
5572
5573 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5574         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5575         // unrevoked commitment transaction.
5576         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5577         // a remote RAA before they could be failed backwards (and combinations thereof).
5578         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5579         // use the same payment hashes.
5580         // Thus, we use a six-node network:
5581         //
5582         // A \         / E
5583         //    - C - D -
5584         // B /         \ F
5585         // And test where C fails back to A/B when D announces its latest commitment transaction
5586         let chanmon_cfgs = create_chanmon_cfgs(6);
5587         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5588         // When this test was written, the default base fee floated based on the HTLC count.
5589         // It is now fixed, so we simply set the fee to the expected value here.
5590         let mut config = test_default_channel_config();
5591         config.channel_options.forwarding_fee_base_msat = 196;
5592         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5593                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5594         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5595         let logger = test_utils::TestLogger::new();
5596
5597         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5598         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5599         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5600         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5601         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5602
5603         // Rebalance and check output sanity...
5604         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5605         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5606         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5607
5608         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5609         // 0th HTLC:
5610         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
5611         // 1st HTLC:
5612         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
5613         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5614         let our_node_id = &nodes[1].node.get_our_node_id();
5615         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();
5616         // 2nd HTLC:
5617         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
5618         // 3rd HTLC:
5619         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
5620         // 4th HTLC:
5621         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5622         // 5th HTLC:
5623         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5624         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();
5625         // 6th HTLC:
5626         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());
5627         // 7th HTLC:
5628         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());
5629
5630         // 8th HTLC:
5631         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5632         // 9th HTLC:
5633         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();
5634         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
5635
5636         // 10th HTLC:
5637         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
5638         // 11th HTLC:
5639         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();
5640         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());
5641
5642         // Double-check that six of the new HTLC were added
5643         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5644         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5645         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5646         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5647
5648         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5649         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5650         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5651         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5652         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5653         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5654         check_added_monitors!(nodes[4], 0);
5655         expect_pending_htlcs_forwardable!(nodes[4]);
5656         check_added_monitors!(nodes[4], 1);
5657
5658         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5659         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5660         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5661         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5662         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5663         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5664
5665         // Fail 3rd below-dust and 7th above-dust HTLCs
5666         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5667         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5668         check_added_monitors!(nodes[5], 0);
5669         expect_pending_htlcs_forwardable!(nodes[5]);
5670         check_added_monitors!(nodes[5], 1);
5671
5672         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5673         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5674         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5675         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5676
5677         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5678
5679         expect_pending_htlcs_forwardable!(nodes[3]);
5680         check_added_monitors!(nodes[3], 1);
5681         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5682         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5683         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5684         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5685         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5686         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5687         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5688         if deliver_last_raa {
5689                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5690         } else {
5691                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5692         }
5693
5694         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5695         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5696         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5697         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5698         //
5699         // We now broadcast the latest commitment transaction, which *should* result in failures for
5700         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5701         // the non-broadcast above-dust HTLCs.
5702         //
5703         // Alternatively, we may broadcast the previous commitment transaction, which should only
5704         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5705         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5706
5707         if announce_latest {
5708                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5709         } else {
5710                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5711         }
5712         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5713         check_closed_broadcast!(nodes[2], true);
5714         expect_pending_htlcs_forwardable!(nodes[2]);
5715         check_added_monitors!(nodes[2], 3);
5716
5717         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5718         assert_eq!(cs_msgs.len(), 2);
5719         let mut a_done = false;
5720         for msg in cs_msgs {
5721                 match msg {
5722                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5723                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5724                                 // should be failed-backwards here.
5725                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5726                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5727                                         for htlc in &updates.update_fail_htlcs {
5728                                                 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 });
5729                                         }
5730                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5731                                         assert!(!a_done);
5732                                         a_done = true;
5733                                         &nodes[0]
5734                                 } else {
5735                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5736                                         for htlc in &updates.update_fail_htlcs {
5737                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5738                                         }
5739                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5740                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5741                                         &nodes[1]
5742                                 };
5743                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5744                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5745                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5746                                 if announce_latest {
5747                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5748                                         if *node_id == nodes[0].node.get_our_node_id() {
5749                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5750                                         }
5751                                 }
5752                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5753                         },
5754                         _ => panic!("Unexpected event"),
5755                 }
5756         }
5757
5758         let as_events = nodes[0].node.get_and_clear_pending_events();
5759         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5760         let mut as_failds = HashSet::new();
5761         for event in as_events.iter() {
5762                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5763                         assert!(as_failds.insert(*payment_hash));
5764                         if *payment_hash != payment_hash_2 {
5765                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5766                         } else {
5767                                 assert!(!rejected_by_dest);
5768                         }
5769                 } else { panic!("Unexpected event"); }
5770         }
5771         assert!(as_failds.contains(&payment_hash_1));
5772         assert!(as_failds.contains(&payment_hash_2));
5773         if announce_latest {
5774                 assert!(as_failds.contains(&payment_hash_3));
5775                 assert!(as_failds.contains(&payment_hash_5));
5776         }
5777         assert!(as_failds.contains(&payment_hash_6));
5778
5779         let bs_events = nodes[1].node.get_and_clear_pending_events();
5780         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5781         let mut bs_failds = HashSet::new();
5782         for event in bs_events.iter() {
5783                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5784                         assert!(bs_failds.insert(*payment_hash));
5785                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5786                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5787                         } else {
5788                                 assert!(!rejected_by_dest);
5789                         }
5790                 } else { panic!("Unexpected event"); }
5791         }
5792         assert!(bs_failds.contains(&payment_hash_1));
5793         assert!(bs_failds.contains(&payment_hash_2));
5794         if announce_latest {
5795                 assert!(bs_failds.contains(&payment_hash_4));
5796         }
5797         assert!(bs_failds.contains(&payment_hash_5));
5798
5799         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5800         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5801         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5802         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5803         // PaymentFailureNetworkUpdates.
5804         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5805         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5806         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5807         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5808         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5809                 match event {
5810                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5811                         _ => panic!("Unexpected event"),
5812                 }
5813         }
5814 }
5815
5816 #[test]
5817 fn test_fail_backwards_latest_remote_announce_a() {
5818         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5819 }
5820
5821 #[test]
5822 fn test_fail_backwards_latest_remote_announce_b() {
5823         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5824 }
5825
5826 #[test]
5827 fn test_fail_backwards_previous_remote_announce() {
5828         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5829         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5830         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5831 }
5832
5833 #[test]
5834 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5835         let chanmon_cfgs = create_chanmon_cfgs(2);
5836         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5837         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5838         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5839
5840         // Create some initial channels
5841         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5842
5843         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5844         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5845         assert_eq!(local_txn[0].input.len(), 1);
5846         check_spends!(local_txn[0], chan_1.3);
5847
5848         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5849         mine_transaction(&nodes[0], &local_txn[0]);
5850         check_closed_broadcast!(nodes[0], true);
5851         check_added_monitors!(nodes[0], 1);
5852         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5853
5854         let htlc_timeout = {
5855                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5856                 assert_eq!(node_txn.len(), 2);
5857                 check_spends!(node_txn[0], chan_1.3);
5858                 assert_eq!(node_txn[1].input.len(), 1);
5859                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5860                 check_spends!(node_txn[1], local_txn[0]);
5861                 node_txn[1].clone()
5862         };
5863
5864         mine_transaction(&nodes[0], &htlc_timeout);
5865         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5866         expect_payment_failed!(nodes[0], our_payment_hash, true);
5867
5868         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5869         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5870         assert_eq!(spend_txn.len(), 3);
5871         check_spends!(spend_txn[0], local_txn[0]);
5872         assert_eq!(spend_txn[1].input.len(), 1);
5873         check_spends!(spend_txn[1], htlc_timeout);
5874         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5875         assert_eq!(spend_txn[2].input.len(), 2);
5876         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5877         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5878                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5879 }
5880
5881 #[test]
5882 fn test_key_derivation_params() {
5883         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5884         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5885         // let us re-derive the channel key set to then derive a delayed_payment_key.
5886
5887         let chanmon_cfgs = create_chanmon_cfgs(3);
5888
5889         // We manually create the node configuration to backup the seed.
5890         let seed = [42; 32];
5891         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5892         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);
5893         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 };
5894         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5895         node_cfgs.remove(0);
5896         node_cfgs.insert(0, node);
5897
5898         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5899         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5900
5901         // Create some initial channels
5902         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5903         // for node 0
5904         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5905         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5906         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5907
5908         // Ensure all nodes are at the same height
5909         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5910         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5911         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5912         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5913
5914         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5915         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5916         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5917         assert_eq!(local_txn_1[0].input.len(), 1);
5918         check_spends!(local_txn_1[0], chan_1.3);
5919
5920         // We check funding pubkey are unique
5921         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]));
5922         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]));
5923         if from_0_funding_key_0 == from_1_funding_key_0
5924             || from_0_funding_key_0 == from_1_funding_key_1
5925             || from_0_funding_key_1 == from_1_funding_key_0
5926             || from_0_funding_key_1 == from_1_funding_key_1 {
5927                 panic!("Funding pubkeys aren't unique");
5928         }
5929
5930         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5931         mine_transaction(&nodes[0], &local_txn_1[0]);
5932         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5933         check_closed_broadcast!(nodes[0], true);
5934         check_added_monitors!(nodes[0], 1);
5935
5936         let htlc_timeout = {
5937                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5938                 assert_eq!(node_txn[1].input.len(), 1);
5939                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5940                 check_spends!(node_txn[1], local_txn_1[0]);
5941                 node_txn[1].clone()
5942         };
5943
5944         mine_transaction(&nodes[0], &htlc_timeout);
5945         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5946         expect_payment_failed!(nodes[0], our_payment_hash, true);
5947
5948         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5949         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5950         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5951         assert_eq!(spend_txn.len(), 3);
5952         check_spends!(spend_txn[0], local_txn_1[0]);
5953         assert_eq!(spend_txn[1].input.len(), 1);
5954         check_spends!(spend_txn[1], htlc_timeout);
5955         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5956         assert_eq!(spend_txn[2].input.len(), 2);
5957         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5958         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5959                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5960 }
5961
5962 #[test]
5963 fn test_static_output_closing_tx() {
5964         let chanmon_cfgs = create_chanmon_cfgs(2);
5965         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5966         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5967         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5968
5969         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5970
5971         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5972         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5973
5974         mine_transaction(&nodes[0], &closing_tx);
5975         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5976
5977         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5978         assert_eq!(spend_txn.len(), 1);
5979         check_spends!(spend_txn[0], closing_tx);
5980
5981         mine_transaction(&nodes[1], &closing_tx);
5982         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5983
5984         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5985         assert_eq!(spend_txn.len(), 1);
5986         check_spends!(spend_txn[0], closing_tx);
5987 }
5988
5989 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5990         let chanmon_cfgs = create_chanmon_cfgs(2);
5991         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5992         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5993         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5994         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5995
5996         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5997
5998         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5999         // present in B's local commitment transaction, but none of A's commitment transactions.
6000         assert!(nodes[1].node.claim_funds(our_payment_preimage));
6001         check_added_monitors!(nodes[1], 1);
6002
6003         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6004         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
6005         let events = nodes[0].node.get_and_clear_pending_events();
6006         assert_eq!(events.len(), 1);
6007         match events[0] {
6008                 Event::PaymentSent { payment_preimage } => {
6009                         assert_eq!(payment_preimage, our_payment_preimage);
6010                 },
6011                 _ => panic!("Unexpected event"),
6012         }
6013
6014         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6015         check_added_monitors!(nodes[0], 1);
6016         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6017         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6018         check_added_monitors!(nodes[1], 1);
6019
6020         let starting_block = nodes[1].best_block_info();
6021         let mut block = Block {
6022                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6023                 txdata: vec![],
6024         };
6025         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
6026                 connect_block(&nodes[1], &block);
6027                 block.header.prev_blockhash = block.block_hash();
6028         }
6029         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
6030         check_closed_broadcast!(nodes[1], true);
6031         check_added_monitors!(nodes[1], 1);
6032 }
6033
6034 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
6035         let chanmon_cfgs = create_chanmon_cfgs(2);
6036         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6037         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6038         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6039         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6040         let logger = test_utils::TestLogger::new();
6041
6042         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6043         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6044         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();
6045         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6046         check_added_monitors!(nodes[0], 1);
6047
6048         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6049
6050         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6051         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6052         // to "time out" the HTLC.
6053
6054         let starting_block = nodes[1].best_block_info();
6055         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6056
6057         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6058                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6059                 header.prev_blockhash = header.block_hash();
6060         }
6061         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6062         check_closed_broadcast!(nodes[0], true);
6063         check_added_monitors!(nodes[0], 1);
6064 }
6065
6066 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6067         let chanmon_cfgs = create_chanmon_cfgs(3);
6068         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6069         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6070         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6071         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6072
6073         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6074         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6075         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6076         // actually revoked.
6077         let htlc_value = if use_dust { 50000 } else { 3000000 };
6078         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6079         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6080         expect_pending_htlcs_forwardable!(nodes[1]);
6081         check_added_monitors!(nodes[1], 1);
6082
6083         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6084         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6085         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6086         check_added_monitors!(nodes[0], 1);
6087         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6088         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6089         check_added_monitors!(nodes[1], 1);
6090         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6091         check_added_monitors!(nodes[1], 1);
6092         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6093
6094         if check_revoke_no_close {
6095                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6096                 check_added_monitors!(nodes[0], 1);
6097         }
6098
6099         let starting_block = nodes[1].best_block_info();
6100         let mut block = Block {
6101                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6102                 txdata: vec![],
6103         };
6104         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6105                 connect_block(&nodes[0], &block);
6106                 block.header.prev_blockhash = block.block_hash();
6107         }
6108         if !check_revoke_no_close {
6109                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6110                 check_closed_broadcast!(nodes[0], true);
6111                 check_added_monitors!(nodes[0], 1);
6112         } else {
6113                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6114         }
6115 }
6116
6117 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6118 // There are only a few cases to test here:
6119 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6120 //    broadcastable commitment transactions result in channel closure,
6121 //  * its included in an unrevoked-but-previous remote commitment transaction,
6122 //  * its included in the latest remote or local commitment transactions.
6123 // We test each of the three possible commitment transactions individually and use both dust and
6124 // non-dust HTLCs.
6125 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6126 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6127 // tested for at least one of the cases in other tests.
6128 #[test]
6129 fn htlc_claim_single_commitment_only_a() {
6130         do_htlc_claim_local_commitment_only(true);
6131         do_htlc_claim_local_commitment_only(false);
6132
6133         do_htlc_claim_current_remote_commitment_only(true);
6134         do_htlc_claim_current_remote_commitment_only(false);
6135 }
6136
6137 #[test]
6138 fn htlc_claim_single_commitment_only_b() {
6139         do_htlc_claim_previous_remote_commitment_only(true, false);
6140         do_htlc_claim_previous_remote_commitment_only(false, false);
6141         do_htlc_claim_previous_remote_commitment_only(true, true);
6142         do_htlc_claim_previous_remote_commitment_only(false, true);
6143 }
6144
6145 #[test]
6146 #[should_panic]
6147 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6148         let chanmon_cfgs = create_chanmon_cfgs(2);
6149         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6150         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6151         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6152         //Force duplicate channel ids
6153         for node in nodes.iter() {
6154                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6155         }
6156
6157         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6158         let channel_value_satoshis=10000;
6159         let push_msat=10001;
6160         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6161         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6162         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6163
6164         //Create a second channel with a channel_id collision
6165         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6166 }
6167
6168 #[test]
6169 fn bolt2_open_channel_sending_node_checks_part2() {
6170         let chanmon_cfgs = create_chanmon_cfgs(2);
6171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6174
6175         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6176         let channel_value_satoshis=2^24;
6177         let push_msat=10001;
6178         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6179
6180         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6181         let channel_value_satoshis=10000;
6182         // Test when push_msat is equal to 1000 * funding_satoshis.
6183         let push_msat=1000*channel_value_satoshis+1;
6184         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6185
6186         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6187         let channel_value_satoshis=10000;
6188         let push_msat=10001;
6189         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
6190         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6191         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6192
6193         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6194         // 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
6195         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6196
6197         // 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.
6198         assert!(BREAKDOWN_TIMEOUT>0);
6199         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6200
6201         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6202         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6203         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6204
6205         // 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.
6206         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6207         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6208         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6209         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6210         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6211 }
6212
6213 #[test]
6214 fn bolt2_open_channel_sane_dust_limit() {
6215         let chanmon_cfgs = create_chanmon_cfgs(2);
6216         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6217         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6218         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6219
6220         let channel_value_satoshis=1000000;
6221         let push_msat=10001;
6222         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6223         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6224         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6225         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6226
6227         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6228         let events = nodes[1].node.get_and_clear_pending_msg_events();
6229         let err_msg = match events[0] {
6230                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6231                         msg.clone()
6232                 },
6233                 _ => panic!("Unexpected event"),
6234         };
6235         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6236 }
6237
6238 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6239 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6240 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6241 // is no longer affordable once it's freed.
6242 #[test]
6243 fn test_fail_holding_cell_htlc_upon_free() {
6244         let chanmon_cfgs = create_chanmon_cfgs(2);
6245         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6246         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6247         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6248         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6249         let logger = test_utils::TestLogger::new();
6250
6251         // First nodes[0] generates an update_fee, setting the channel's
6252         // pending_update_fee.
6253         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6254         check_added_monitors!(nodes[0], 1);
6255
6256         let events = nodes[0].node.get_and_clear_pending_msg_events();
6257         assert_eq!(events.len(), 1);
6258         let (update_msg, commitment_signed) = match events[0] {
6259                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6260                         (update_fee.as_ref(), commitment_signed)
6261                 },
6262                 _ => panic!("Unexpected event"),
6263         };
6264
6265         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6266
6267         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6268         let channel_reserve = chan_stat.channel_reserve_msat;
6269         let feerate = get_feerate!(nodes[0], chan.2);
6270
6271         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6272         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6273         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6274         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6275         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();
6276
6277         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6278         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6279         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6280         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6281
6282         // Flush the pending fee update.
6283         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6284         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6285         check_added_monitors!(nodes[1], 1);
6286         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6287         check_added_monitors!(nodes[0], 1);
6288
6289         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6290         // HTLC, but now that the fee has been raised the payment will now fail, causing
6291         // us to surface its failure to the user.
6292         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6293         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6294         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);
6295         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 {}",
6296                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6297         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6298
6299         // Check that the payment failed to be sent out.
6300         let events = nodes[0].node.get_and_clear_pending_events();
6301         assert_eq!(events.len(), 1);
6302         match &events[0] {
6303                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6304                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6305                         assert_eq!(*rejected_by_dest, false);
6306                         assert_eq!(*error_code, None);
6307                         assert_eq!(*error_data, None);
6308                 },
6309                 _ => panic!("Unexpected event"),
6310         }
6311 }
6312
6313 // Test that if multiple HTLCs are released from the holding cell and one is
6314 // valid but the other is no longer valid upon release, the valid HTLC can be
6315 // successfully completed while the other one fails as expected.
6316 #[test]
6317 fn test_free_and_fail_holding_cell_htlcs() {
6318         let chanmon_cfgs = create_chanmon_cfgs(2);
6319         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6320         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6321         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6322         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6323         let logger = test_utils::TestLogger::new();
6324
6325         // First nodes[0] generates an update_fee, setting the channel's
6326         // pending_update_fee.
6327         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6328         check_added_monitors!(nodes[0], 1);
6329
6330         let events = nodes[0].node.get_and_clear_pending_msg_events();
6331         assert_eq!(events.len(), 1);
6332         let (update_msg, commitment_signed) = match events[0] {
6333                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6334                         (update_fee.as_ref(), commitment_signed)
6335                 },
6336                 _ => panic!("Unexpected event"),
6337         };
6338
6339         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6340
6341         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6342         let channel_reserve = chan_stat.channel_reserve_msat;
6343         let feerate = get_feerate!(nodes[0], chan.2);
6344
6345         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6346         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6347         let amt_1 = 20000;
6348         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6349         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6350         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6351         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();
6352         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();
6353
6354         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6355         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6356         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6357         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6358         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6359         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6360         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6361
6362         // Flush the pending fee update.
6363         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6364         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6365         check_added_monitors!(nodes[1], 1);
6366         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6367         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6368         check_added_monitors!(nodes[0], 2);
6369
6370         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6371         // but now that the fee has been raised the second payment will now fail, causing us
6372         // to surface its failure to the user. The first payment should succeed.
6373         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6374         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6375         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);
6376         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 {}",
6377                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6378         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6379
6380         // Check that the second payment failed to be sent out.
6381         let events = nodes[0].node.get_and_clear_pending_events();
6382         assert_eq!(events.len(), 1);
6383         match &events[0] {
6384                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6385                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6386                         assert_eq!(*rejected_by_dest, false);
6387                         assert_eq!(*error_code, None);
6388                         assert_eq!(*error_data, None);
6389                 },
6390                 _ => panic!("Unexpected event"),
6391         }
6392
6393         // Complete the first payment and the RAA from the fee update.
6394         let (payment_event, send_raa_event) = {
6395                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6396                 assert_eq!(msgs.len(), 2);
6397                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6398         };
6399         let raa = match send_raa_event {
6400                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6401                 _ => panic!("Unexpected event"),
6402         };
6403         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6404         check_added_monitors!(nodes[1], 1);
6405         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6406         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6407         let events = nodes[1].node.get_and_clear_pending_events();
6408         assert_eq!(events.len(), 1);
6409         match events[0] {
6410                 Event::PendingHTLCsForwardable { .. } => {},
6411                 _ => panic!("Unexpected event"),
6412         }
6413         nodes[1].node.process_pending_htlc_forwards();
6414         let events = nodes[1].node.get_and_clear_pending_events();
6415         assert_eq!(events.len(), 1);
6416         match events[0] {
6417                 Event::PaymentReceived { .. } => {},
6418                 _ => panic!("Unexpected event"),
6419         }
6420         nodes[1].node.claim_funds(payment_preimage_1);
6421         check_added_monitors!(nodes[1], 1);
6422         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6423         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6424         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6425         let events = nodes[0].node.get_and_clear_pending_events();
6426         assert_eq!(events.len(), 1);
6427         match events[0] {
6428                 Event::PaymentSent { ref payment_preimage } => {
6429                         assert_eq!(*payment_preimage, payment_preimage_1);
6430                 }
6431                 _ => panic!("Unexpected event"),
6432         }
6433 }
6434
6435 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6436 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6437 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6438 // once it's freed.
6439 #[test]
6440 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6441         let chanmon_cfgs = create_chanmon_cfgs(3);
6442         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6443         // When this test was written, the default base fee floated based on the HTLC count.
6444         // It is now fixed, so we simply set the fee to the expected value here.
6445         let mut config = test_default_channel_config();
6446         config.channel_options.forwarding_fee_base_msat = 196;
6447         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6448         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6449         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6450         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6451         let logger = test_utils::TestLogger::new();
6452
6453         // First nodes[1] generates an update_fee, setting the channel's
6454         // pending_update_fee.
6455         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6456         check_added_monitors!(nodes[1], 1);
6457
6458         let events = nodes[1].node.get_and_clear_pending_msg_events();
6459         assert_eq!(events.len(), 1);
6460         let (update_msg, commitment_signed) = match events[0] {
6461                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6462                         (update_fee.as_ref(), commitment_signed)
6463                 },
6464                 _ => panic!("Unexpected event"),
6465         };
6466
6467         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6468
6469         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6470         let channel_reserve = chan_stat.channel_reserve_msat;
6471         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6472
6473         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6474         let feemsat = 239;
6475         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6476         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6477         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6478         let payment_event = {
6479                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6480                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6481                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6482                 check_added_monitors!(nodes[0], 1);
6483
6484                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6485                 assert_eq!(events.len(), 1);
6486
6487                 SendEvent::from_event(events.remove(0))
6488         };
6489         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6490         check_added_monitors!(nodes[1], 0);
6491         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6492         expect_pending_htlcs_forwardable!(nodes[1]);
6493
6494         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6495         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6496
6497         // Flush the pending fee update.
6498         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6499         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6500         check_added_monitors!(nodes[2], 1);
6501         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6502         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6503         check_added_monitors!(nodes[1], 2);
6504
6505         // A final RAA message is generated to finalize the fee update.
6506         let events = nodes[1].node.get_and_clear_pending_msg_events();
6507         assert_eq!(events.len(), 1);
6508
6509         let raa_msg = match &events[0] {
6510                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6511                         msg.clone()
6512                 },
6513                 _ => panic!("Unexpected event"),
6514         };
6515
6516         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6517         check_added_monitors!(nodes[2], 1);
6518         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6519
6520         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6521         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6522         assert_eq!(process_htlc_forwards_event.len(), 1);
6523         match &process_htlc_forwards_event[0] {
6524                 &Event::PendingHTLCsForwardable { .. } => {},
6525                 _ => panic!("Unexpected event"),
6526         }
6527
6528         // In response, we call ChannelManager's process_pending_htlc_forwards
6529         nodes[1].node.process_pending_htlc_forwards();
6530         check_added_monitors!(nodes[1], 1);
6531
6532         // This causes the HTLC to be failed backwards.
6533         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6534         assert_eq!(fail_event.len(), 1);
6535         let (fail_msg, commitment_signed) = match &fail_event[0] {
6536                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6537                         assert_eq!(updates.update_add_htlcs.len(), 0);
6538                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6539                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6540                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6541                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6542                 },
6543                 _ => panic!("Unexpected event"),
6544         };
6545
6546         // Pass the failure messages back to nodes[0].
6547         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6548         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6549
6550         // Complete the HTLC failure+removal process.
6551         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6552         check_added_monitors!(nodes[0], 1);
6553         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6554         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6555         check_added_monitors!(nodes[1], 2);
6556         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6557         assert_eq!(final_raa_event.len(), 1);
6558         let raa = match &final_raa_event[0] {
6559                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6560                 _ => panic!("Unexpected event"),
6561         };
6562         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6563         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6564         expect_payment_failed!(nodes[0], our_payment_hash, false);
6565         check_added_monitors!(nodes[0], 1);
6566 }
6567
6568 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6569 // 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.
6570 //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.
6571
6572 #[test]
6573 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6574         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6575         let chanmon_cfgs = create_chanmon_cfgs(2);
6576         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6577         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6578         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6579         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6580
6581         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6582         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6583         let logger = test_utils::TestLogger::new();
6584         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();
6585         route.paths[0][0].fee_msat = 100;
6586
6587         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6588                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6589         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6590         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6591 }
6592
6593 #[test]
6594 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6595         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6596         let chanmon_cfgs = create_chanmon_cfgs(2);
6597         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6598         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6599         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6600         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6601         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6602
6603         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6604         let logger = test_utils::TestLogger::new();
6605         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();
6606         route.paths[0][0].fee_msat = 0;
6607         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6608                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6609
6610         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6611         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6612 }
6613
6614 #[test]
6615 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6616         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6617         let chanmon_cfgs = create_chanmon_cfgs(2);
6618         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6619         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6620         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6621         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6622
6623         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6624         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6625         let logger = test_utils::TestLogger::new();
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         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6628         check_added_monitors!(nodes[0], 1);
6629         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6630         updates.update_add_htlcs[0].amount_msat = 0;
6631
6632         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6633         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6634         check_closed_broadcast!(nodes[1], true).unwrap();
6635         check_added_monitors!(nodes[1], 1);
6636 }
6637
6638 #[test]
6639 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6640         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6641         //It is enforced when constructing a route.
6642         let chanmon_cfgs = create_chanmon_cfgs(2);
6643         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6644         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6645         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6646         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6647         let logger = test_utils::TestLogger::new();
6648
6649         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6650
6651         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6652         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();
6653         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6654                 assert_eq!(err, &"Channel CLTV overflowed?"));
6655 }
6656
6657 #[test]
6658 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6659         //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.
6660         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6661         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6662         let chanmon_cfgs = create_chanmon_cfgs(2);
6663         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6664         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6665         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6666         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6667         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6668
6669         let logger = test_utils::TestLogger::new();
6670         for i in 0..max_accepted_htlcs {
6671                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6672                 let payment_event = {
6673                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6674                         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();
6675                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6676                         check_added_monitors!(nodes[0], 1);
6677
6678                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6679                         assert_eq!(events.len(), 1);
6680                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6681                                 assert_eq!(htlcs[0].htlc_id, i);
6682                         } else {
6683                                 assert!(false);
6684                         }
6685                         SendEvent::from_event(events.remove(0))
6686                 };
6687                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6688                 check_added_monitors!(nodes[1], 0);
6689                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6690
6691                 expect_pending_htlcs_forwardable!(nodes[1]);
6692                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6693         }
6694         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6695         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6696         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6697         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6698                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6699
6700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6701         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6702 }
6703
6704 #[test]
6705 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6706         //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.
6707         let chanmon_cfgs = create_chanmon_cfgs(2);
6708         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6710         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6711         let channel_value = 100000;
6712         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6713         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6714
6715         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6716
6717         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6718         // Manually create a route over our max in flight (which our router normally automatically
6719         // limits us to.
6720         let route = Route { paths: vec![vec![RouteHop {
6721            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6722            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6723            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6724         }]] };
6725         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6726                 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)));
6727
6728         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6729         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);
6730
6731         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6732 }
6733
6734 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6735 #[test]
6736 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6737         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6738         let chanmon_cfgs = create_chanmon_cfgs(2);
6739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6741         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6742         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6743         let htlc_minimum_msat: u64;
6744         {
6745                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6746                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6747                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6748         }
6749
6750         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6751         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6752         let logger = test_utils::TestLogger::new();
6753         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();
6754         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6755         check_added_monitors!(nodes[0], 1);
6756         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6757         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6758         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6759         assert!(nodes[1].node.list_channels().is_empty());
6760         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6761         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()));
6762         check_added_monitors!(nodes[1], 1);
6763 }
6764
6765 #[test]
6766 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6767         //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
6768         let chanmon_cfgs = create_chanmon_cfgs(2);
6769         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6770         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6771         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6772         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6773         let logger = test_utils::TestLogger::new();
6774
6775         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6776         let channel_reserve = chan_stat.channel_reserve_msat;
6777         let feerate = get_feerate!(nodes[0], chan.2);
6778         // The 2* and +1 are for the fee spike reserve.
6779         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6780
6781         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6782         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6783         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6784         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();
6785         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6786         check_added_monitors!(nodes[0], 1);
6787         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6788
6789         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6790         // at this time channel-initiatee receivers are not required to enforce that senders
6791         // respect the fee_spike_reserve.
6792         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6793         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6794
6795         assert!(nodes[1].node.list_channels().is_empty());
6796         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6797         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6798         check_added_monitors!(nodes[1], 1);
6799 }
6800
6801 #[test]
6802 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6803         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6804         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6805         let chanmon_cfgs = create_chanmon_cfgs(2);
6806         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6808         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6809         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6810         let logger = test_utils::TestLogger::new();
6811
6812         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6813         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6814
6815         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6816         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();
6817
6818         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6819         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6820         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6821         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6822
6823         let mut msg = msgs::UpdateAddHTLC {
6824                 channel_id: chan.2,
6825                 htlc_id: 0,
6826                 amount_msat: 1000,
6827                 payment_hash: our_payment_hash,
6828                 cltv_expiry: htlc_cltv,
6829                 onion_routing_packet: onion_packet.clone(),
6830         };
6831
6832         for i in 0..super::channel::OUR_MAX_HTLCS {
6833                 msg.htlc_id = i as u64;
6834                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6835         }
6836         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6837         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6838
6839         assert!(nodes[1].node.list_channels().is_empty());
6840         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6841         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6842         check_added_monitors!(nodes[1], 1);
6843 }
6844
6845 #[test]
6846 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6847         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6848         let chanmon_cfgs = create_chanmon_cfgs(2);
6849         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6850         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6851         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6852         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6853         let logger = test_utils::TestLogger::new();
6854
6855         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6856         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6857         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();
6858         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6859         check_added_monitors!(nodes[0], 1);
6860         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6861         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6862         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6863
6864         assert!(nodes[1].node.list_channels().is_empty());
6865         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6866         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6867         check_added_monitors!(nodes[1], 1);
6868 }
6869
6870 #[test]
6871 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6872         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6873         let chanmon_cfgs = create_chanmon_cfgs(2);
6874         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6875         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6876         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6877         let logger = test_utils::TestLogger::new();
6878
6879         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6880         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6881         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6882         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();
6883         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6884         check_added_monitors!(nodes[0], 1);
6885         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6886         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6887         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6888
6889         assert!(nodes[1].node.list_channels().is_empty());
6890         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6891         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6892         check_added_monitors!(nodes[1], 1);
6893 }
6894
6895 #[test]
6896 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6897         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6898         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6899         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6900         let chanmon_cfgs = create_chanmon_cfgs(2);
6901         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6902         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6903         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6904         let logger = test_utils::TestLogger::new();
6905
6906         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6907         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6908         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6909         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();
6910         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6911         check_added_monitors!(nodes[0], 1);
6912         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6913         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6914
6915         //Disconnect and Reconnect
6916         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6917         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6918         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6919         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6920         assert_eq!(reestablish_1.len(), 1);
6921         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6922         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6923         assert_eq!(reestablish_2.len(), 1);
6924         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6925         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6926         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6927         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6928
6929         //Resend HTLC
6930         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6931         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6932         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6933         check_added_monitors!(nodes[1], 1);
6934         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6935
6936         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6937
6938         assert!(nodes[1].node.list_channels().is_empty());
6939         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6940         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6941         check_added_monitors!(nodes[1], 1);
6942 }
6943
6944 #[test]
6945 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6946         //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.
6947
6948         let chanmon_cfgs = create_chanmon_cfgs(2);
6949         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6950         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6951         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6952         let logger = test_utils::TestLogger::new();
6953         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6954         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6955         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6956         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();
6957         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6958
6959         check_added_monitors!(nodes[0], 1);
6960         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6961         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6962
6963         let update_msg = msgs::UpdateFulfillHTLC{
6964                 channel_id: chan.2,
6965                 htlc_id: 0,
6966                 payment_preimage: our_payment_preimage,
6967         };
6968
6969         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6970
6971         assert!(nodes[0].node.list_channels().is_empty());
6972         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6973         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()));
6974         check_added_monitors!(nodes[0], 1);
6975 }
6976
6977 #[test]
6978 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6979         //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.
6980
6981         let chanmon_cfgs = create_chanmon_cfgs(2);
6982         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6983         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6984         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6985         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6986         let logger = test_utils::TestLogger::new();
6987
6988         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6989         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6990         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();
6991         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6992         check_added_monitors!(nodes[0], 1);
6993         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6994         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6995
6996         let update_msg = msgs::UpdateFailHTLC{
6997                 channel_id: chan.2,
6998                 htlc_id: 0,
6999                 reason: msgs::OnionErrorPacket { data: Vec::new()},
7000         };
7001
7002         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7003
7004         assert!(nodes[0].node.list_channels().is_empty());
7005         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7006         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()));
7007         check_added_monitors!(nodes[0], 1);
7008 }
7009
7010 #[test]
7011 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7012         //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.
7013
7014         let chanmon_cfgs = create_chanmon_cfgs(2);
7015         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7017         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7018         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7019         let logger = test_utils::TestLogger::new();
7020
7021         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7022         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7023         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();
7024         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7025         check_added_monitors!(nodes[0], 1);
7026         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7027         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7028         let update_msg = msgs::UpdateFailMalformedHTLC{
7029                 channel_id: chan.2,
7030                 htlc_id: 0,
7031                 sha256_of_onion: [1; 32],
7032                 failure_code: 0x8000,
7033         };
7034
7035         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7036
7037         assert!(nodes[0].node.list_channels().is_empty());
7038         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7039         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()));
7040         check_added_monitors!(nodes[0], 1);
7041 }
7042
7043 #[test]
7044 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7045         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7046
7047         let chanmon_cfgs = create_chanmon_cfgs(2);
7048         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7049         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7050         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7051         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7052
7053         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7054
7055         nodes[1].node.claim_funds(our_payment_preimage);
7056         check_added_monitors!(nodes[1], 1);
7057
7058         let events = nodes[1].node.get_and_clear_pending_msg_events();
7059         assert_eq!(events.len(), 1);
7060         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7061                 match events[0] {
7062                         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, .. } } => {
7063                                 assert!(update_add_htlcs.is_empty());
7064                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7065                                 assert!(update_fail_htlcs.is_empty());
7066                                 assert!(update_fail_malformed_htlcs.is_empty());
7067                                 assert!(update_fee.is_none());
7068                                 update_fulfill_htlcs[0].clone()
7069                         },
7070                         _ => panic!("Unexpected event"),
7071                 }
7072         };
7073
7074         update_fulfill_msg.htlc_id = 1;
7075
7076         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7077
7078         assert!(nodes[0].node.list_channels().is_empty());
7079         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7080         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7081         check_added_monitors!(nodes[0], 1);
7082 }
7083
7084 #[test]
7085 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7086         //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.
7087
7088         let chanmon_cfgs = create_chanmon_cfgs(2);
7089         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7090         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7091         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7092         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7093
7094         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7095
7096         nodes[1].node.claim_funds(our_payment_preimage);
7097         check_added_monitors!(nodes[1], 1);
7098
7099         let events = nodes[1].node.get_and_clear_pending_msg_events();
7100         assert_eq!(events.len(), 1);
7101         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7102                 match events[0] {
7103                         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, .. } } => {
7104                                 assert!(update_add_htlcs.is_empty());
7105                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7106                                 assert!(update_fail_htlcs.is_empty());
7107                                 assert!(update_fail_malformed_htlcs.is_empty());
7108                                 assert!(update_fee.is_none());
7109                                 update_fulfill_htlcs[0].clone()
7110                         },
7111                         _ => panic!("Unexpected event"),
7112                 }
7113         };
7114
7115         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7116
7117         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7118
7119         assert!(nodes[0].node.list_channels().is_empty());
7120         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7121         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7122         check_added_monitors!(nodes[0], 1);
7123 }
7124
7125 #[test]
7126 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7127         //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.
7128
7129         let chanmon_cfgs = create_chanmon_cfgs(2);
7130         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7131         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7132         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7133         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7134         let logger = test_utils::TestLogger::new();
7135
7136         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7137         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7138         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();
7139         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7140         check_added_monitors!(nodes[0], 1);
7141
7142         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7143         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7144
7145         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7146         check_added_monitors!(nodes[1], 0);
7147         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7148
7149         let events = nodes[1].node.get_and_clear_pending_msg_events();
7150
7151         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7152                 match events[0] {
7153                         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, .. } } => {
7154                                 assert!(update_add_htlcs.is_empty());
7155                                 assert!(update_fulfill_htlcs.is_empty());
7156                                 assert!(update_fail_htlcs.is_empty());
7157                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7158                                 assert!(update_fee.is_none());
7159                                 update_fail_malformed_htlcs[0].clone()
7160                         },
7161                         _ => panic!("Unexpected event"),
7162                 }
7163         };
7164         update_msg.failure_code &= !0x8000;
7165         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7166
7167         assert!(nodes[0].node.list_channels().is_empty());
7168         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7169         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7170         check_added_monitors!(nodes[0], 1);
7171 }
7172
7173 #[test]
7174 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7175         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7176         //    * 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.
7177
7178         let chanmon_cfgs = create_chanmon_cfgs(3);
7179         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7180         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7181         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7182         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7183         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7184         let logger = test_utils::TestLogger::new();
7185
7186         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7187
7188         //First hop
7189         let mut payment_event = {
7190                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7191                 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();
7192                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7193                 check_added_monitors!(nodes[0], 1);
7194                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7195                 assert_eq!(events.len(), 1);
7196                 SendEvent::from_event(events.remove(0))
7197         };
7198         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7199         check_added_monitors!(nodes[1], 0);
7200         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7201         expect_pending_htlcs_forwardable!(nodes[1]);
7202         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7203         assert_eq!(events_2.len(), 1);
7204         check_added_monitors!(nodes[1], 1);
7205         payment_event = SendEvent::from_event(events_2.remove(0));
7206         assert_eq!(payment_event.msgs.len(), 1);
7207
7208         //Second Hop
7209         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7210         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7211         check_added_monitors!(nodes[2], 0);
7212         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7213
7214         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7215         assert_eq!(events_3.len(), 1);
7216         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7217                 match events_3[0] {
7218                         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 } } => {
7219                                 assert!(update_add_htlcs.is_empty());
7220                                 assert!(update_fulfill_htlcs.is_empty());
7221                                 assert!(update_fail_htlcs.is_empty());
7222                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7223                                 assert!(update_fee.is_none());
7224                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7225                         },
7226                         _ => panic!("Unexpected event"),
7227                 }
7228         };
7229
7230         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7231
7232         check_added_monitors!(nodes[1], 0);
7233         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7234         expect_pending_htlcs_forwardable!(nodes[1]);
7235         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7236         assert_eq!(events_4.len(), 1);
7237
7238         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7239         match events_4[0] {
7240                 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, .. } } => {
7241                         assert!(update_add_htlcs.is_empty());
7242                         assert!(update_fulfill_htlcs.is_empty());
7243                         assert_eq!(update_fail_htlcs.len(), 1);
7244                         assert!(update_fail_malformed_htlcs.is_empty());
7245                         assert!(update_fee.is_none());
7246                 },
7247                 _ => panic!("Unexpected event"),
7248         };
7249
7250         check_added_monitors!(nodes[1], 1);
7251 }
7252
7253 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7254         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7255         // 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
7256         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7257
7258         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7259         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7260         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7261         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7262         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7263         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7264
7265         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7266
7267         // We route 2 dust-HTLCs between A and B
7268         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7269         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7270         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7271
7272         // Cache one local commitment tx as previous
7273         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7274
7275         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7276         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7277         check_added_monitors!(nodes[1], 0);
7278         expect_pending_htlcs_forwardable!(nodes[1]);
7279         check_added_monitors!(nodes[1], 1);
7280
7281         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7282         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7283         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7284         check_added_monitors!(nodes[0], 1);
7285
7286         // Cache one local commitment tx as lastest
7287         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7288
7289         let events = nodes[0].node.get_and_clear_pending_msg_events();
7290         match events[0] {
7291                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7292                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7293                 },
7294                 _ => panic!("Unexpected event"),
7295         }
7296         match events[1] {
7297                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7298                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7299                 },
7300                 _ => panic!("Unexpected event"),
7301         }
7302
7303         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7304         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7305         if announce_latest {
7306                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7307         } else {
7308                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7309         }
7310
7311         check_closed_broadcast!(nodes[0], true);
7312         check_added_monitors!(nodes[0], 1);
7313
7314         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7315         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7316         let events = nodes[0].node.get_and_clear_pending_events();
7317         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7318         assert_eq!(events.len(), 2);
7319         let mut first_failed = false;
7320         for event in events {
7321                 match event {
7322                         Event::PaymentFailed { payment_hash, .. } => {
7323                                 if payment_hash == payment_hash_1 {
7324                                         assert!(!first_failed);
7325                                         first_failed = true;
7326                                 } else {
7327                                         assert_eq!(payment_hash, payment_hash_2);
7328                                 }
7329                         }
7330                         _ => panic!("Unexpected event"),
7331                 }
7332         }
7333 }
7334
7335 #[test]
7336 fn test_failure_delay_dust_htlc_local_commitment() {
7337         do_test_failure_delay_dust_htlc_local_commitment(true);
7338         do_test_failure_delay_dust_htlc_local_commitment(false);
7339 }
7340
7341 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7342         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7343         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7344         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7345         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7346         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7347         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7348
7349         let chanmon_cfgs = create_chanmon_cfgs(3);
7350         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7351         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7352         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7353         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7354
7355         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7356
7357         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7358         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7359
7360         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7361         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7362
7363         // We revoked bs_commitment_tx
7364         if revoked {
7365                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7366                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7367         }
7368
7369         let mut timeout_tx = Vec::new();
7370         if local {
7371                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7372                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7373                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7374                 expect_payment_failed!(nodes[0], dust_hash, true);
7375
7376                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7377                 check_closed_broadcast!(nodes[0], true);
7378                 check_added_monitors!(nodes[0], 1);
7379                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7380                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7381                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7382                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7383                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7384                 mine_transaction(&nodes[0], &timeout_tx[0]);
7385                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7386                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7387         } else {
7388                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7389                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7390                 check_closed_broadcast!(nodes[0], true);
7391                 check_added_monitors!(nodes[0], 1);
7392                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7393                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7394                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7395                 if !revoked {
7396                         expect_payment_failed!(nodes[0], dust_hash, true);
7397                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7398                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7399                         mine_transaction(&nodes[0], &timeout_tx[0]);
7400                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7401                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7402                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7403                 } else {
7404                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7405                         // commitment tx
7406                         let events = nodes[0].node.get_and_clear_pending_events();
7407                         assert_eq!(events.len(), 2);
7408                         let first;
7409                         match events[0] {
7410                                 Event::PaymentFailed { payment_hash, .. } => {
7411                                         if payment_hash == dust_hash { first = true; }
7412                                         else { first = false; }
7413                                 },
7414                                 _ => panic!("Unexpected event"),
7415                         }
7416                         match events[1] {
7417                                 Event::PaymentFailed { payment_hash, .. } => {
7418                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7419                                         else { assert_eq!(payment_hash, dust_hash); }
7420                                 },
7421                                 _ => panic!("Unexpected event"),
7422                         }
7423                 }
7424         }
7425 }
7426
7427 #[test]
7428 fn test_sweep_outbound_htlc_failure_update() {
7429         do_test_sweep_outbound_htlc_failure_update(false, true);
7430         do_test_sweep_outbound_htlc_failure_update(false, false);
7431         do_test_sweep_outbound_htlc_failure_update(true, false);
7432 }
7433
7434 #[test]
7435 fn test_upfront_shutdown_script() {
7436         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7437         // enforce it at shutdown message
7438
7439         let mut config = UserConfig::default();
7440         config.channel_options.announced_channel = true;
7441         config.peer_channel_config_limits.force_announced_channel_preference = false;
7442         config.channel_options.commit_upfront_shutdown_pubkey = false;
7443         let user_cfgs = [None, Some(config), None];
7444         let chanmon_cfgs = create_chanmon_cfgs(3);
7445         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7446         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7447         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7448
7449         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7450         let flags = InitFeatures::known();
7451         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7452         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7453         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7454         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7455         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7456         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7457     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()));
7458         check_added_monitors!(nodes[2], 1);
7459
7460         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7461         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7462         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7463         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7464         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7465         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7466         let events = nodes[2].node.get_and_clear_pending_msg_events();
7467         assert_eq!(events.len(), 1);
7468         match events[0] {
7469                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7470                 _ => panic!("Unexpected event"),
7471         }
7472
7473         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7474         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7475         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7476         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7477         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7478         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7479         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7480         let events = nodes[1].node.get_and_clear_pending_msg_events();
7481         assert_eq!(events.len(), 1);
7482         match events[0] {
7483                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7484                 _ => panic!("Unexpected event"),
7485         }
7486
7487         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7488         // channel smoothly, opt-out is from channel initiator here
7489         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7490         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7491         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7492         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7493         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7494         let events = nodes[0].node.get_and_clear_pending_msg_events();
7495         assert_eq!(events.len(), 1);
7496         match events[0] {
7497                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7498                 _ => panic!("Unexpected event"),
7499         }
7500
7501         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7502         //// channel smoothly
7503         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7504         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7505         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7506         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7507         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7508         let events = nodes[0].node.get_and_clear_pending_msg_events();
7509         assert_eq!(events.len(), 2);
7510         match events[0] {
7511                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7512                 _ => panic!("Unexpected event"),
7513         }
7514         match events[1] {
7515                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7516                 _ => panic!("Unexpected event"),
7517         }
7518 }
7519
7520 #[test]
7521 fn test_upfront_shutdown_script_unsupport_segwit() {
7522         // We test that channel is closed early
7523         // if a segwit program is passed as upfront shutdown script,
7524         // but the peer does not support segwit.
7525         let chanmon_cfgs = create_chanmon_cfgs(2);
7526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7528         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7529
7530         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7531
7532         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7533         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7534                 .push_slice(&[0, 0])
7535                 .into_script());
7536
7537         let features = InitFeatures::known().clear_shutdown_anysegwit();
7538         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7539
7540         let events = nodes[0].node.get_and_clear_pending_msg_events();
7541         assert_eq!(events.len(), 1);
7542         match events[0] {
7543                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7544                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7545                         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));
7546                 },
7547                 _ => panic!("Unexpected event"),
7548         }
7549 }
7550
7551 #[test]
7552 fn test_shutdown_script_any_segwit_allowed() {
7553         let mut config = UserConfig::default();
7554         config.channel_options.announced_channel = true;
7555         config.peer_channel_config_limits.force_announced_channel_preference = false;
7556         config.channel_options.commit_upfront_shutdown_pubkey = false;
7557         let user_cfgs = [None, Some(config), None];
7558         let chanmon_cfgs = create_chanmon_cfgs(3);
7559         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7560         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7561         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7562
7563         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7564         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7565         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7566         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7567         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7568                 .push_slice(&[0, 0])
7569                 .into_script();
7570         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7571         let events = nodes[0].node.get_and_clear_pending_msg_events();
7572         assert_eq!(events.len(), 2);
7573         match events[0] {
7574                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7575                 _ => panic!("Unexpected event"),
7576         }
7577         match events[1] {
7578                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7579                 _ => panic!("Unexpected event"),
7580         }
7581 }
7582
7583 #[test]
7584 fn test_shutdown_script_any_segwit_not_allowed() {
7585         let mut config = UserConfig::default();
7586         config.channel_options.announced_channel = true;
7587         config.peer_channel_config_limits.force_announced_channel_preference = false;
7588         config.channel_options.commit_upfront_shutdown_pubkey = false;
7589         let user_cfgs = [None, Some(config), None];
7590         let chanmon_cfgs = create_chanmon_cfgs(3);
7591         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7592         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7593         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7594
7595         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7596         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7597         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7598         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7599         // Make an any segwit version script
7600         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7601                 .push_slice(&[0, 0])
7602                 .into_script();
7603         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7604         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7605         let events = nodes[0].node.get_and_clear_pending_msg_events();
7606         assert_eq!(events.len(), 2);
7607         match events[1] {
7608                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7609                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7610                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7611                 },
7612                 _ => panic!("Unexpected event"),
7613         }
7614         check_added_monitors!(nodes[0], 1);
7615 }
7616
7617 #[test]
7618 fn test_shutdown_script_segwit_but_not_anysegwit() {
7619         let mut config = UserConfig::default();
7620         config.channel_options.announced_channel = true;
7621         config.peer_channel_config_limits.force_announced_channel_preference = false;
7622         config.channel_options.commit_upfront_shutdown_pubkey = false;
7623         let user_cfgs = [None, Some(config), None];
7624         let chanmon_cfgs = create_chanmon_cfgs(3);
7625         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7626         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7627         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7628
7629         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7630         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7631         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7632         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7633         // Make a segwit script that is not a valid as any segwit
7634         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7635                 .push_slice(&[0, 0])
7636                 .into_script();
7637         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7638         let events = nodes[0].node.get_and_clear_pending_msg_events();
7639         assert_eq!(events.len(), 2);
7640         match events[1] {
7641                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7642                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7643                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7644                 },
7645                 _ => panic!("Unexpected event"),
7646         }
7647         check_added_monitors!(nodes[0], 1);
7648 }
7649
7650 #[test]
7651 fn test_user_configurable_csv_delay() {
7652         // We test our channel constructors yield errors when we pass them absurd csv delay
7653
7654         let mut low_our_to_self_config = UserConfig::default();
7655         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7656         let mut high_their_to_self_config = UserConfig::default();
7657         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7658         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7659         let chanmon_cfgs = create_chanmon_cfgs(2);
7660         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7661         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7662         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7663
7664         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7665         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7666                 match error {
7667                         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())); },
7668                         _ => panic!("Unexpected event"),
7669                 }
7670         } else { assert!(false) }
7671
7672         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7673         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7674         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7675         open_channel.to_self_delay = 200;
7676         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7677                 match error {
7678                         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()));  },
7679                         _ => panic!("Unexpected event"),
7680                 }
7681         } else { assert!(false); }
7682
7683         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7684         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7685         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()));
7686         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7687         accept_channel.to_self_delay = 200;
7688         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7689         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7690                 match action {
7691                         &ErrorAction::SendErrorMessage { ref msg } => {
7692                                 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()));
7693                         },
7694                         _ => { assert!(false); }
7695                 }
7696         } else { assert!(false); }
7697
7698         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7699         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7700         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7701         open_channel.to_self_delay = 200;
7702         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7703                 match error {
7704                         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())); },
7705                         _ => panic!("Unexpected event"),
7706                 }
7707         } else { assert!(false); }
7708 }
7709
7710 #[test]
7711 fn test_data_loss_protect() {
7712         // We want to be sure that :
7713         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7714         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7715         // * we close channel in case of detecting other being fallen behind
7716         // * we are able to claim our own outputs thanks to to_remote being static
7717         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7718         let persister;
7719         let logger;
7720         let fee_estimator;
7721         let tx_broadcaster;
7722         let chain_source;
7723         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7724         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7725         // during signing due to revoked tx
7726         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7727         let keys_manager = &chanmon_cfgs[0].keys_manager;
7728         let monitor;
7729         let node_state_0;
7730         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7731         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7732         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7733
7734         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7735
7736         // Cache node A state before any channel update
7737         let previous_node_state = nodes[0].node.encode();
7738         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7739         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7740
7741         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7742         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7743
7744         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7745         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7746
7747         // Restore node A from previous state
7748         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7749         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7750         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7751         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7752         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7753         persister = test_utils::TestPersister::new();
7754         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7755         node_state_0 = {
7756                 let mut channel_monitors = HashMap::new();
7757                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7758                 <(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 {
7759                         keys_manager: keys_manager,
7760                         fee_estimator: &fee_estimator,
7761                         chain_monitor: &monitor,
7762                         logger: &logger,
7763                         tx_broadcaster: &tx_broadcaster,
7764                         default_config: UserConfig::default(),
7765                         channel_monitors,
7766                 }).unwrap().1
7767         };
7768         nodes[0].node = &node_state_0;
7769         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7770         nodes[0].chain_monitor = &monitor;
7771         nodes[0].chain_source = &chain_source;
7772
7773         check_added_monitors!(nodes[0], 1);
7774
7775         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7776         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7777
7778         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7779
7780         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7781         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7782         check_added_monitors!(nodes[0], 1);
7783
7784         {
7785                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7786                 assert_eq!(node_txn.len(), 0);
7787         }
7788
7789         let mut reestablish_1 = Vec::with_capacity(1);
7790         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7791                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7792                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7793                         reestablish_1.push(msg.clone());
7794                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7795                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7796                         match action {
7797                                 &ErrorAction::SendErrorMessage { ref msg } => {
7798                                         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");
7799                                 },
7800                                 _ => panic!("Unexpected event!"),
7801                         }
7802                 } else {
7803                         panic!("Unexpected event")
7804                 }
7805         }
7806
7807         // Check we close channel detecting A is fallen-behind
7808         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7809         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7810         check_added_monitors!(nodes[1], 1);
7811
7812
7813         // Check A is able to claim to_remote output
7814         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7815         assert_eq!(node_txn.len(), 1);
7816         check_spends!(node_txn[0], chan.3);
7817         assert_eq!(node_txn[0].output.len(), 2);
7818         mine_transaction(&nodes[0], &node_txn[0]);
7819         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7820         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7821         assert_eq!(spend_txn.len(), 1);
7822         check_spends!(spend_txn[0], node_txn[0]);
7823 }
7824
7825 #[test]
7826 fn test_check_htlc_underpaying() {
7827         // Send payment through A -> B but A is maliciously
7828         // sending a probe payment (i.e less than expected value0
7829         // to B, B should refuse payment.
7830
7831         let chanmon_cfgs = create_chanmon_cfgs(2);
7832         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7833         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7834         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7835
7836         // Create some initial channels
7837         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7838
7839         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();
7840         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7841         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7842         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7843         check_added_monitors!(nodes[0], 1);
7844
7845         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7846         assert_eq!(events.len(), 1);
7847         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7848         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7849         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7850
7851         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7852         // and then will wait a second random delay before failing the HTLC back:
7853         expect_pending_htlcs_forwardable!(nodes[1]);
7854         expect_pending_htlcs_forwardable!(nodes[1]);
7855
7856         // Node 3 is expecting payment of 100_000 but received 10_000,
7857         // it should fail htlc like we didn't know the preimage.
7858         nodes[1].node.process_pending_htlc_forwards();
7859
7860         let events = nodes[1].node.get_and_clear_pending_msg_events();
7861         assert_eq!(events.len(), 1);
7862         let (update_fail_htlc, commitment_signed) = match events[0] {
7863                 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 } } => {
7864                         assert!(update_add_htlcs.is_empty());
7865                         assert!(update_fulfill_htlcs.is_empty());
7866                         assert_eq!(update_fail_htlcs.len(), 1);
7867                         assert!(update_fail_malformed_htlcs.is_empty());
7868                         assert!(update_fee.is_none());
7869                         (update_fail_htlcs[0].clone(), commitment_signed)
7870                 },
7871                 _ => panic!("Unexpected event"),
7872         };
7873         check_added_monitors!(nodes[1], 1);
7874
7875         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7876         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7877
7878         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7879         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7880         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7881         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7882 }
7883
7884 #[test]
7885 fn test_announce_disable_channels() {
7886         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7887         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7888
7889         let chanmon_cfgs = create_chanmon_cfgs(2);
7890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7892         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7893
7894         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7895         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7896         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7897
7898         // Disconnect peers
7899         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7900         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7901
7902         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7903         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7904         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7905         assert_eq!(msg_events.len(), 3);
7906         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7907         for e in msg_events {
7908                 match e {
7909                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7910                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7911                                 // Check that each channel gets updated exactly once
7912                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7913                                         panic!("Generated ChannelUpdate for wrong chan!");
7914                                 }
7915                         },
7916                         _ => panic!("Unexpected event"),
7917                 }
7918         }
7919         // Reconnect peers
7920         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7921         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7922         assert_eq!(reestablish_1.len(), 3);
7923         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7924         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7925         assert_eq!(reestablish_2.len(), 3);
7926
7927         // Reestablish chan_1
7928         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7929         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7930         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7931         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7932         // Reestablish chan_2
7933         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7934         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7935         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7936         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7937         // Reestablish chan_3
7938         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7939         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7940         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7941         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7942
7943         nodes[0].node.timer_tick_occurred();
7944         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7945         nodes[0].node.timer_tick_occurred();
7946         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7947         assert_eq!(msg_events.len(), 3);
7948         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7949         for e in msg_events {
7950                 match e {
7951                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7952                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7953                                 // Check that each channel gets updated exactly once
7954                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7955                                         panic!("Generated ChannelUpdate for wrong chan!");
7956                                 }
7957                         },
7958                         _ => panic!("Unexpected event"),
7959                 }
7960         }
7961 }
7962
7963 #[test]
7964 fn test_priv_forwarding_rejection() {
7965         // If we have a private channel with outbound liquidity, and
7966         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7967         // to forward through that channel.
7968         let chanmon_cfgs = create_chanmon_cfgs(3);
7969         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7970         let mut no_announce_cfg = test_default_channel_config();
7971         no_announce_cfg.channel_options.announced_channel = false;
7972         no_announce_cfg.accept_forwards_to_priv_channels = false;
7973         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7974         let persister: test_utils::TestPersister;
7975         let new_chain_monitor: test_utils::TestChainMonitor;
7976         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7977         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7978
7979         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7980
7981         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7982         // not send for private channels.
7983         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7984         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7985         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7986         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7987         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7988
7989         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7990         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7991         nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
7992         check_added_monitors!(nodes[2], 1);
7993
7994         nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id()));
7995         check_added_monitors!(nodes[1], 1);
7996
7997         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7998         confirm_transaction_at(&nodes[1], &tx, conf_height);
7999         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
8000         confirm_transaction_at(&nodes[2], &tx, conf_height);
8001         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
8002         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
8003         nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
8004         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8005         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
8006         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8007
8008         assert!(nodes[0].node.list_usable_channels()[0].is_public);
8009         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8010         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
8011
8012         // We should always be able to forward through nodes[1] as long as its out through a public
8013         // channel:
8014         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
8015
8016         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
8017         // to nodes[2], which should be rejected:
8018         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
8019         let route = get_route(&nodes[0].node.get_our_node_id(),
8020                 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8021                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
8022                 &[&RouteHint(vec![RouteHintHop {
8023                         src_node_id: nodes[1].node.get_our_node_id(),
8024                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
8025                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
8026                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
8027                         htlc_minimum_msat: None,
8028                         htlc_maximum_msat: None,
8029                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
8030
8031         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8032         check_added_monitors!(nodes[0], 1);
8033         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
8034         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8035         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
8036
8037         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8038         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
8039         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
8040         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
8041         assert!(htlc_fail_updates.update_fee.is_none());
8042
8043         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
8044         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
8045         expect_payment_failed!(nodes[0], our_payment_hash, false);
8046         expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
8047
8048         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
8049         // to true. Sadly there is currently no way to change it at runtime.
8050
8051         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8052         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8053
8054         let nodes_1_serialized = nodes[1].node.encode();
8055         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
8056         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
8057         {
8058                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
8059                 let mut mon_iter = mons.iter();
8060                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
8061                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
8062         }
8063
8064         persister = test_utils::TestPersister::new();
8065         let keys_manager = &chanmon_cfgs[1].keys_manager;
8066         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
8067         nodes[1].chain_monitor = &new_chain_monitor;
8068
8069         let mut monitor_a_read = &monitor_a_serialized.0[..];
8070         let mut monitor_b_read = &monitor_b_serialized.0[..];
8071         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
8072         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
8073         assert!(monitor_a_read.is_empty());
8074         assert!(monitor_b_read.is_empty());
8075
8076         no_announce_cfg.accept_forwards_to_priv_channels = true;
8077
8078         let mut nodes_1_read = &nodes_1_serialized[..];
8079         let (_, nodes_1_deserialized_tmp) = {
8080                 let mut channel_monitors = HashMap::new();
8081                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
8082                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
8083                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
8084                         default_config: no_announce_cfg,
8085                         keys_manager,
8086                         fee_estimator: node_cfgs[1].fee_estimator,
8087                         chain_monitor: nodes[1].chain_monitor,
8088                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
8089                         logger: nodes[1].logger,
8090                         channel_monitors,
8091                 }).unwrap()
8092         };
8093         assert!(nodes_1_read.is_empty());
8094         nodes_1_deserialized = nodes_1_deserialized_tmp;
8095
8096         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
8097         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
8098         check_added_monitors!(nodes[1], 2);
8099         nodes[1].node = &nodes_1_deserialized;
8100
8101         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8102         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8103         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8104         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8105         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
8106         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8107         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8108         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
8109
8110         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8111         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8112         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
8113         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8114         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8115         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
8116         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8117         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8118
8119         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8120         check_added_monitors!(nodes[0], 1);
8121         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
8122         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
8123 }
8124
8125 #[test]
8126 fn test_bump_penalty_txn_on_revoked_commitment() {
8127         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8128         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8129
8130         let chanmon_cfgs = create_chanmon_cfgs(2);
8131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8133         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8134
8135         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8136         let logger = test_utils::TestLogger::new();
8137
8138         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8139         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8140         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();
8141         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8142
8143         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8144         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8145         assert_eq!(revoked_txn[0].output.len(), 4);
8146         assert_eq!(revoked_txn[0].input.len(), 1);
8147         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8148         let revoked_txid = revoked_txn[0].txid();
8149
8150         let mut penalty_sum = 0;
8151         for outp in revoked_txn[0].output.iter() {
8152                 if outp.script_pubkey.is_v0_p2wsh() {
8153                         penalty_sum += outp.value;
8154                 }
8155         }
8156
8157         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8158         let header_114 = connect_blocks(&nodes[1], 14);
8159
8160         // Actually revoke tx by claiming a HTLC
8161         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8162         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8163         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
8164         check_added_monitors!(nodes[1], 1);
8165
8166         // One or more justice tx should have been broadcast, check it
8167         let penalty_1;
8168         let feerate_1;
8169         {
8170                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8171                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
8172                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8173                 assert_eq!(node_txn[0].output.len(), 1);
8174                 check_spends!(node_txn[0], revoked_txn[0]);
8175                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8176                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8177                 penalty_1 = node_txn[0].txid();
8178                 node_txn.clear();
8179         };
8180
8181         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8182         connect_blocks(&nodes[1], 15);
8183         let mut penalty_2 = penalty_1;
8184         let mut feerate_2 = 0;
8185         {
8186                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8187                 assert_eq!(node_txn.len(), 1);
8188                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8189                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8190                         assert_eq!(node_txn[0].output.len(), 1);
8191                         check_spends!(node_txn[0], revoked_txn[0]);
8192                         penalty_2 = node_txn[0].txid();
8193                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8194                         assert_ne!(penalty_2, penalty_1);
8195                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8196                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8197                         // Verify 25% bump heuristic
8198                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8199                         node_txn.clear();
8200                 }
8201         }
8202         assert_ne!(feerate_2, 0);
8203
8204         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8205         connect_blocks(&nodes[1], 1);
8206         let penalty_3;
8207         let mut feerate_3 = 0;
8208         {
8209                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8210                 assert_eq!(node_txn.len(), 1);
8211                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8212                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8213                         assert_eq!(node_txn[0].output.len(), 1);
8214                         check_spends!(node_txn[0], revoked_txn[0]);
8215                         penalty_3 = node_txn[0].txid();
8216                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8217                         assert_ne!(penalty_3, penalty_2);
8218                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8219                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8220                         // Verify 25% bump heuristic
8221                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8222                         node_txn.clear();
8223                 }
8224         }
8225         assert_ne!(feerate_3, 0);
8226
8227         nodes[1].node.get_and_clear_pending_events();
8228         nodes[1].node.get_and_clear_pending_msg_events();
8229 }
8230
8231 #[test]
8232 fn test_bump_penalty_txn_on_revoked_htlcs() {
8233         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8234         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8235
8236         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8237         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8238         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8239         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8240         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8241
8242         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8243         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8244         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8245                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8246         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8247         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8248                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8249         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8250
8251         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8252         assert_eq!(revoked_local_txn[0].input.len(), 1);
8253         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8254
8255         // Revoke local commitment tx
8256         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8257
8258         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8259         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8260         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8261         check_closed_broadcast!(nodes[1], true);
8262         check_added_monitors!(nodes[1], 1);
8263         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8264
8265         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8266         assert_eq!(revoked_htlc_txn.len(), 3);
8267         check_spends!(revoked_htlc_txn[1], chan.3);
8268
8269         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8270         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8271         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8272
8273         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8274         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8275         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8276         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8277
8278         // Broadcast set of revoked txn on A
8279         let hash_128 = connect_blocks(&nodes[0], 40);
8280         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8281         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8282         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8283         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8284         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8285         let first;
8286         let feerate_1;
8287         let penalty_txn;
8288         {
8289                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8290                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8291                 // Verify claim tx are spending revoked HTLC txn
8292
8293                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8294                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8295                 // which are included in the same block (they are broadcasted because we scan the
8296                 // transactions linearly and generate claims as we go, they likely should be removed in the
8297                 // future).
8298                 assert_eq!(node_txn[0].input.len(), 1);
8299                 check_spends!(node_txn[0], revoked_local_txn[0]);
8300                 assert_eq!(node_txn[1].input.len(), 1);
8301                 check_spends!(node_txn[1], revoked_local_txn[0]);
8302                 assert_eq!(node_txn[2].input.len(), 1);
8303                 check_spends!(node_txn[2], revoked_local_txn[0]);
8304
8305                 // Each of the three justice transactions claim a separate (single) output of the three
8306                 // available, which we check here:
8307                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8308                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8309                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8310
8311                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8312                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8313
8314                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8315                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8316                 // a remote commitment tx has already been confirmed).
8317                 check_spends!(node_txn[3], chan.3);
8318
8319                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8320                 // output, checked above).
8321                 assert_eq!(node_txn[4].input.len(), 2);
8322                 assert_eq!(node_txn[4].output.len(), 1);
8323                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8324
8325                 first = node_txn[4].txid();
8326                 // Store both feerates for later comparison
8327                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8328                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8329                 penalty_txn = vec![node_txn[2].clone()];
8330                 node_txn.clear();
8331         }
8332
8333         // Connect one more block to see if bumped penalty are issued for HTLC txn
8334         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8335         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8336         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8337         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8338         {
8339                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8340                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8341
8342                 check_spends!(node_txn[0], revoked_local_txn[0]);
8343                 check_spends!(node_txn[1], revoked_local_txn[0]);
8344                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8345                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8346                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8347                 } else {
8348                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8349                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8350                 }
8351
8352                 node_txn.clear();
8353         };
8354
8355         // Few more blocks to confirm penalty txn
8356         connect_blocks(&nodes[0], 4);
8357         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8358         let header_144 = connect_blocks(&nodes[0], 9);
8359         let node_txn = {
8360                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8361                 assert_eq!(node_txn.len(), 1);
8362
8363                 assert_eq!(node_txn[0].input.len(), 2);
8364                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8365                 // Verify bumped tx is different and 25% bump heuristic
8366                 assert_ne!(first, node_txn[0].txid());
8367                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8368                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8369                 assert!(feerate_2 * 100 > feerate_1 * 125);
8370                 let txn = vec![node_txn[0].clone()];
8371                 node_txn.clear();
8372                 txn
8373         };
8374         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8375         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8376         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8377         connect_blocks(&nodes[0], 20);
8378         {
8379                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8380                 // We verify than no new transaction has been broadcast because previously
8381                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8382                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8383                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8384                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8385                 // up bumped justice generation.
8386                 assert_eq!(node_txn.len(), 0);
8387                 node_txn.clear();
8388         }
8389         check_closed_broadcast!(nodes[0], true);
8390         check_added_monitors!(nodes[0], 1);
8391 }
8392
8393 #[test]
8394 fn test_bump_penalty_txn_on_remote_commitment() {
8395         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8396         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8397
8398         // Create 2 HTLCs
8399         // Provide preimage for one
8400         // Check aggregation
8401
8402         let chanmon_cfgs = create_chanmon_cfgs(2);
8403         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8404         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8405         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8406
8407         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8408         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8409         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8410
8411         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8412         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8413         assert_eq!(remote_txn[0].output.len(), 4);
8414         assert_eq!(remote_txn[0].input.len(), 1);
8415         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8416
8417         // Claim a HTLC without revocation (provide B monitor with preimage)
8418         nodes[1].node.claim_funds(payment_preimage);
8419         mine_transaction(&nodes[1], &remote_txn[0]);
8420         check_added_monitors!(nodes[1], 2);
8421         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8422
8423         // One or more claim tx should have been broadcast, check it
8424         let timeout;
8425         let preimage;
8426         let preimage_bump;
8427         let feerate_timeout;
8428         let feerate_preimage;
8429         {
8430                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8431                 // 9 transactions including:
8432                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8433                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8434                 // 2 * HTLC-Success (one RBF bump we'll check later)
8435                 // 1 * HTLC-Timeout
8436                 assert_eq!(node_txn.len(), 8);
8437                 assert_eq!(node_txn[0].input.len(), 1);
8438                 assert_eq!(node_txn[6].input.len(), 1);
8439                 check_spends!(node_txn[0], remote_txn[0]);
8440                 check_spends!(node_txn[6], remote_txn[0]);
8441                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8442                 preimage_bump = node_txn[3].clone();
8443
8444                 check_spends!(node_txn[1], chan.3);
8445                 check_spends!(node_txn[2], node_txn[1]);
8446                 assert_eq!(node_txn[1], node_txn[4]);
8447                 assert_eq!(node_txn[2], node_txn[5]);
8448
8449                 timeout = node_txn[6].txid();
8450                 let index = node_txn[6].input[0].previous_output.vout;
8451                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8452                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8453
8454                 preimage = node_txn[0].txid();
8455                 let index = node_txn[0].input[0].previous_output.vout;
8456                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8457                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8458
8459                 node_txn.clear();
8460         };
8461         assert_ne!(feerate_timeout, 0);
8462         assert_ne!(feerate_preimage, 0);
8463
8464         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8465         connect_blocks(&nodes[1], 15);
8466         {
8467                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8468                 assert_eq!(node_txn.len(), 1);
8469                 assert_eq!(node_txn[0].input.len(), 1);
8470                 assert_eq!(preimage_bump.input.len(), 1);
8471                 check_spends!(node_txn[0], remote_txn[0]);
8472                 check_spends!(preimage_bump, remote_txn[0]);
8473
8474                 let index = preimage_bump.input[0].previous_output.vout;
8475                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8476                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8477                 assert!(new_feerate * 100 > feerate_timeout * 125);
8478                 assert_ne!(timeout, preimage_bump.txid());
8479
8480                 let index = node_txn[0].input[0].previous_output.vout;
8481                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8482                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8483                 assert!(new_feerate * 100 > feerate_preimage * 125);
8484                 assert_ne!(preimage, node_txn[0].txid());
8485
8486                 node_txn.clear();
8487         }
8488
8489         nodes[1].node.get_and_clear_pending_events();
8490         nodes[1].node.get_and_clear_pending_msg_events();
8491 }
8492
8493 #[test]
8494 fn test_counterparty_raa_skip_no_crash() {
8495         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8496         // commitment transaction, we would have happily carried on and provided them the next
8497         // commitment transaction based on one RAA forward. This would probably eventually have led to
8498         // channel closure, but it would not have resulted in funds loss. Still, our
8499         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8500         // check simply that the channel is closed in response to such an RAA, but don't check whether
8501         // we decide to punish our counterparty for revoking their funds (as we don't currently
8502         // implement that).
8503         let chanmon_cfgs = create_chanmon_cfgs(2);
8504         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8505         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8506         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8507         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8508
8509         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8510         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8511         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8512         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8513         // Must revoke without gaps
8514         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8515         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8516                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8517
8518         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8519                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8520         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8521         check_added_monitors!(nodes[1], 1);
8522 }
8523
8524 #[test]
8525 fn test_bump_txn_sanitize_tracking_maps() {
8526         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8527         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8528
8529         let chanmon_cfgs = create_chanmon_cfgs(2);
8530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8533
8534         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8535         // Lock HTLC in both directions
8536         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8537         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8538
8539         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8540         assert_eq!(revoked_local_txn[0].input.len(), 1);
8541         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8542
8543         // Revoke local commitment tx
8544         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8545
8546         // Broadcast set of revoked txn on A
8547         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8548         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8549         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8550
8551         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8552         check_closed_broadcast!(nodes[0], true);
8553         check_added_monitors!(nodes[0], 1);
8554         let penalty_txn = {
8555                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8556                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8557                 check_spends!(node_txn[0], revoked_local_txn[0]);
8558                 check_spends!(node_txn[1], revoked_local_txn[0]);
8559                 check_spends!(node_txn[2], revoked_local_txn[0]);
8560                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8561                 node_txn.clear();
8562                 penalty_txn
8563         };
8564         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8565         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8566         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8567         {
8568                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8569                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8570                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8571                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8572                 }
8573         }
8574 }
8575
8576 #[test]
8577 fn test_override_channel_config() {
8578         let chanmon_cfgs = create_chanmon_cfgs(2);
8579         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8580         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8581         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8582
8583         // Node0 initiates a channel to node1 using the override config.
8584         let mut override_config = UserConfig::default();
8585         override_config.own_channel_config.our_to_self_delay = 200;
8586
8587         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8588
8589         // Assert the channel created by node0 is using the override config.
8590         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8591         assert_eq!(res.channel_flags, 0);
8592         assert_eq!(res.to_self_delay, 200);
8593 }
8594
8595 #[test]
8596 fn test_override_0msat_htlc_minimum() {
8597         let mut zero_config = UserConfig::default();
8598         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8599         let chanmon_cfgs = create_chanmon_cfgs(2);
8600         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8601         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8602         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8603
8604         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8605         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8606         assert_eq!(res.htlc_minimum_msat, 1);
8607
8608         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8609         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8610         assert_eq!(res.htlc_minimum_msat, 1);
8611 }
8612
8613 #[test]
8614 fn test_simple_mpp() {
8615         // Simple test of sending a multi-path payment.
8616         let chanmon_cfgs = create_chanmon_cfgs(4);
8617         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8618         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8619         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8620
8621         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8622         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8623         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8624         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8625         let logger = test_utils::TestLogger::new();
8626
8627         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8628         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8629         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();
8630         let path = route.paths[0].clone();
8631         route.paths.push(path);
8632         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8633         route.paths[0][0].short_channel_id = chan_1_id;
8634         route.paths[0][1].short_channel_id = chan_3_id;
8635         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8636         route.paths[1][0].short_channel_id = chan_2_id;
8637         route.paths[1][1].short_channel_id = chan_4_id;
8638         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8639         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8640 }
8641
8642 #[test]
8643 fn test_preimage_storage() {
8644         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8645         let chanmon_cfgs = create_chanmon_cfgs(2);
8646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8648         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8649
8650         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8651
8652         {
8653                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8654
8655                 let logger = test_utils::TestLogger::new();
8656                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8657                 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();
8658                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8659                 check_added_monitors!(nodes[0], 1);
8660                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8661                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8662                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8663                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8664         }
8665         // Note that after leaving the above scope we have no knowledge of any arguments or return
8666         // values from previous calls.
8667         expect_pending_htlcs_forwardable!(nodes[1]);
8668         let events = nodes[1].node.get_and_clear_pending_events();
8669         assert_eq!(events.len(), 1);
8670         match events[0] {
8671                 Event::PaymentReceived { ref purpose, .. } => {
8672                         match &purpose {
8673                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8674                                         assert_eq!(*user_payment_id, 42);
8675                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8676                                 },
8677                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8678                         }
8679                 },
8680                 _ => panic!("Unexpected event"),
8681         }
8682 }
8683
8684 #[test]
8685 fn test_secret_timeout() {
8686         // Simple test of payment secret storage time outs
8687         let chanmon_cfgs = create_chanmon_cfgs(2);
8688         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8690         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8691
8692         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8693
8694         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8695
8696         // We should fail to register the same payment hash twice, at least until we've connected a
8697         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8698         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8699                 assert_eq!(err, "Duplicate payment hash");
8700         } else { panic!(); }
8701         let mut block = {
8702                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8703                 Block {
8704                         header: BlockHeader {
8705                                 version: 0x2000000,
8706                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8707                                 merkle_root: Default::default(),
8708                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8709                         txdata: vec![],
8710                 }
8711         };
8712         connect_block(&nodes[1], &block);
8713         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8714                 assert_eq!(err, "Duplicate payment hash");
8715         } else { panic!(); }
8716
8717         // If we then connect the second block, we should be able to register the same payment hash
8718         // again with a different user_payment_id (this time getting a new payment secret).
8719         block.header.prev_blockhash = block.header.block_hash();
8720         block.header.time += 1;
8721         connect_block(&nodes[1], &block);
8722         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8723         assert_ne!(payment_secret_1, our_payment_secret);
8724
8725         {
8726                 let logger = test_utils::TestLogger::new();
8727                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8728                 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();
8729                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8730                 check_added_monitors!(nodes[0], 1);
8731                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8732                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8733                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8734                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8735         }
8736         // Note that after leaving the above scope we have no knowledge of any arguments or return
8737         // values from previous calls.
8738         expect_pending_htlcs_forwardable!(nodes[1]);
8739         let events = nodes[1].node.get_and_clear_pending_events();
8740         assert_eq!(events.len(), 1);
8741         match events[0] {
8742                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8743                         assert!(payment_preimage.is_none());
8744                         assert_eq!(user_payment_id, 42);
8745                         assert_eq!(payment_secret, our_payment_secret);
8746                         // We don't actually have the payment preimage with which to claim this payment!
8747                 },
8748                 _ => panic!("Unexpected event"),
8749         }
8750 }
8751
8752 #[test]
8753 fn test_bad_secret_hash() {
8754         // Simple test of unregistered payment hash/invalid payment secret handling
8755         let chanmon_cfgs = create_chanmon_cfgs(2);
8756         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8757         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8758         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8759
8760         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8761
8762         let random_payment_hash = PaymentHash([42; 32]);
8763         let random_payment_secret = PaymentSecret([43; 32]);
8764         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8765
8766         let logger = test_utils::TestLogger::new();
8767         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8768         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();
8769
8770         // All the below cases should end up being handled exactly identically, so we macro the
8771         // resulting events.
8772         macro_rules! handle_unknown_invalid_payment_data {
8773                 () => {
8774                         check_added_monitors!(nodes[0], 1);
8775                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8776                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8777                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8778                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8779
8780                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8781                         // again to process the pending backwards-failure of the HTLC
8782                         expect_pending_htlcs_forwardable!(nodes[1]);
8783                         expect_pending_htlcs_forwardable!(nodes[1]);
8784                         check_added_monitors!(nodes[1], 1);
8785
8786                         // We should fail the payment back
8787                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8788                         match events.pop().unwrap() {
8789                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8790                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8791                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8792                                 },
8793                                 _ => panic!("Unexpected event"),
8794                         }
8795                 }
8796         }
8797
8798         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8799         // Error data is the HTLC value (100,000) and current block height
8800         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8801
8802         // Send a payment with the right payment hash but the wrong payment secret
8803         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8804         handle_unknown_invalid_payment_data!();
8805         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8806
8807         // Send a payment with a random payment hash, but the right payment secret
8808         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8809         handle_unknown_invalid_payment_data!();
8810         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8811
8812         // Send a payment with a random payment hash and random payment secret
8813         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8814         handle_unknown_invalid_payment_data!();
8815         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8816 }
8817
8818 #[test]
8819 fn test_update_err_monitor_lockdown() {
8820         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8821         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8822         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8823         //
8824         // This scenario may happen in a watchtower setup, where watchtower process a block height
8825         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8826         // commitment at same time.
8827
8828         let chanmon_cfgs = create_chanmon_cfgs(2);
8829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8831         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8832
8833         // Create some initial channel
8834         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8835         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8836
8837         // Rebalance the network to generate htlc in the two directions
8838         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8839
8840         // Route a HTLC from node 0 to node 1 (but don't settle)
8841         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8842
8843         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8844         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8845         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8846         let persister = test_utils::TestPersister::new();
8847         let watchtower = {
8848                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8849                 let monitor = monitors.get(&outpoint).unwrap();
8850                 let mut w = test_utils::TestVecWriter(Vec::new());
8851                 monitor.write(&mut w).unwrap();
8852                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8853                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8854                 assert!(new_monitor == *monitor);
8855                 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);
8856                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8857                 watchtower
8858         };
8859         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8860         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8861         // transaction lock time requirements here.
8862         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8863         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8864
8865         // Try to update ChannelMonitor
8866         assert!(nodes[1].node.claim_funds(preimage));
8867         check_added_monitors!(nodes[1], 1);
8868         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8869         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8870         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8871         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8872                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8873                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8874                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8875                 } else { assert!(false); }
8876         } else { assert!(false); };
8877         // Our local monitor is in-sync and hasn't processed yet timeout
8878         check_added_monitors!(nodes[0], 1);
8879         let events = nodes[0].node.get_and_clear_pending_events();
8880         assert_eq!(events.len(), 1);
8881 }
8882
8883 #[test]
8884 fn test_concurrent_monitor_claim() {
8885         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8886         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8887         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8888         // state N+1 confirms. Alice claims output from state N+1.
8889
8890         let chanmon_cfgs = create_chanmon_cfgs(2);
8891         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8892         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8893         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8894
8895         // Create some initial channel
8896         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8897         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8898
8899         // Rebalance the network to generate htlc in the two directions
8900         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8901
8902         // Route a HTLC from node 0 to node 1 (but don't settle)
8903         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8904
8905         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8906         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8907         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8908         let persister = test_utils::TestPersister::new();
8909         let watchtower_alice = {
8910                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8911                 let monitor = monitors.get(&outpoint).unwrap();
8912                 let mut w = test_utils::TestVecWriter(Vec::new());
8913                 monitor.write(&mut w).unwrap();
8914                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8915                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8916                 assert!(new_monitor == *monitor);
8917                 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);
8918                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8919                 watchtower
8920         };
8921         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8922         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8923         // transaction lock time requirements here.
8924         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8925         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8926
8927         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8928         {
8929                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8930                 assert_eq!(txn.len(), 2);
8931                 txn.clear();
8932         }
8933
8934         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8935         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8936         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8937         let persister = test_utils::TestPersister::new();
8938         let watchtower_bob = {
8939                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8940                 let monitor = monitors.get(&outpoint).unwrap();
8941                 let mut w = test_utils::TestVecWriter(Vec::new());
8942                 monitor.write(&mut w).unwrap();
8943                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8944                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8945                 assert!(new_monitor == *monitor);
8946                 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);
8947                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8948                 watchtower
8949         };
8950         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8951         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8952
8953         // Route another payment to generate another update with still previous HTLC pending
8954         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8955         {
8956                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8957                 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();
8958                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8959         }
8960         check_added_monitors!(nodes[1], 1);
8961
8962         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8963         assert_eq!(updates.update_add_htlcs.len(), 1);
8964         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8965         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8966                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8967                         // Watchtower Alice should already have seen the block and reject the update
8968                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8969                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8970                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8971                 } else { assert!(false); }
8972         } else { assert!(false); };
8973         // Our local monitor is in-sync and hasn't processed yet timeout
8974         check_added_monitors!(nodes[0], 1);
8975
8976         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8977         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8978         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8979
8980         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8981         let bob_state_y;
8982         {
8983                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8984                 assert_eq!(txn.len(), 2);
8985                 bob_state_y = txn[0].clone();
8986                 txn.clear();
8987         };
8988
8989         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8990         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8991         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);
8992         {
8993                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8994                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8995                 // the onchain detection of the HTLC output
8996                 assert_eq!(htlc_txn.len(), 2);
8997                 check_spends!(htlc_txn[0], bob_state_y);
8998                 check_spends!(htlc_txn[1], bob_state_y);
8999         }
9000 }
9001
9002 #[test]
9003 fn test_pre_lockin_no_chan_closed_update() {
9004         // Test that if a peer closes a channel in response to a funding_created message we don't
9005         // generate a channel update (as the channel cannot appear on chain without a funding_signed
9006         // message).
9007         //
9008         // Doing so would imply a channel monitor update before the initial channel monitor
9009         // registration, violating our API guarantees.
9010         //
9011         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
9012         // then opening a second channel with the same funding output as the first (which is not
9013         // rejected because the first channel does not exist in the ChannelManager) and closing it
9014         // before receiving funding_signed.
9015         let chanmon_cfgs = create_chanmon_cfgs(2);
9016         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9017         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9018         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9019
9020         // Create an initial channel
9021         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9022         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9023         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9024         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9025         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
9026
9027         // Move the first channel through the funding flow...
9028         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
9029
9030         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9031         check_added_monitors!(nodes[0], 0);
9032
9033         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9034         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
9035         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
9036         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
9037 }
9038
9039 #[test]
9040 fn test_htlc_no_detection() {
9041         // This test is a mutation to underscore the detection logic bug we had
9042         // before #653. HTLC value routed is above the remaining balance, thus
9043         // inverting HTLC and `to_remote` output. HTLC will come second and
9044         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
9045         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
9046         // outputs order detection for correct spending children filtring.
9047
9048         let chanmon_cfgs = create_chanmon_cfgs(2);
9049         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9050         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9051         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9052
9053         // Create some initial channels
9054         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9055
9056         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
9057         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
9058         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
9059         assert_eq!(local_txn[0].input.len(), 1);
9060         assert_eq!(local_txn[0].output.len(), 3);
9061         check_spends!(local_txn[0], chan_1.3);
9062
9063         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9064         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9065         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
9066         // We deliberately connect the local tx twice as this should provoke a failure calling
9067         // this test before #653 fix.
9068         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);
9069         check_closed_broadcast!(nodes[0], true);
9070         check_added_monitors!(nodes[0], 1);
9071         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
9072
9073         let htlc_timeout = {
9074                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9075                 assert_eq!(node_txn[1].input.len(), 1);
9076                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9077                 check_spends!(node_txn[1], local_txn[0]);
9078                 node_txn[1].clone()
9079         };
9080
9081         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9082         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
9083         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
9084         expect_payment_failed!(nodes[0], our_payment_hash, true);
9085 }
9086
9087 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
9088         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
9089         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
9090         // Carol, Alice would be the upstream node, and Carol the downstream.)
9091         //
9092         // Steps of the test:
9093         // 1) Alice sends a HTLC to Carol through Bob.
9094         // 2) Carol doesn't settle the HTLC.
9095         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
9096         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
9097         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
9098         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
9099         // 5) Carol release the preimage to Bob off-chain.
9100         // 6) Bob claims the offered output on the broadcasted commitment.
9101         let chanmon_cfgs = create_chanmon_cfgs(3);
9102         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9103         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9104         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9105
9106         // Create some initial channels
9107         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9108         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9109
9110         // Steps (1) and (2):
9111         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
9112         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
9113
9114         // Check that Alice's commitment transaction now contains an output for this HTLC.
9115         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
9116         check_spends!(alice_txn[0], chan_ab.3);
9117         assert_eq!(alice_txn[0].output.len(), 2);
9118         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
9119         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9120         assert_eq!(alice_txn.len(), 2);
9121
9122         // Steps (3) and (4):
9123         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
9124         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
9125         let mut force_closing_node = 0; // Alice force-closes
9126         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
9127         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
9128         check_closed_broadcast!(nodes[force_closing_node], true);
9129         check_added_monitors!(nodes[force_closing_node], 1);
9130         if go_onchain_before_fulfill {
9131                 let txn_to_broadcast = match broadcast_alice {
9132                         true => alice_txn.clone(),
9133                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
9134                 };
9135                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9136                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9137                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9138                 if broadcast_alice {
9139                         check_closed_broadcast!(nodes[1], true);
9140                         check_added_monitors!(nodes[1], 1);
9141                 }
9142                 assert_eq!(bob_txn.len(), 1);
9143                 check_spends!(bob_txn[0], chan_ab.3);
9144         }
9145
9146         // Step (5):
9147         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
9148         // process of removing the HTLC from their commitment transactions.
9149         assert!(nodes[2].node.claim_funds(payment_preimage));
9150         check_added_monitors!(nodes[2], 1);
9151         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
9152         assert!(carol_updates.update_add_htlcs.is_empty());
9153         assert!(carol_updates.update_fail_htlcs.is_empty());
9154         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
9155         assert!(carol_updates.update_fee.is_none());
9156         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
9157
9158         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
9159         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
9160         if !go_onchain_before_fulfill && broadcast_alice {
9161                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9162                 assert_eq!(events.len(), 1);
9163                 match events[0] {
9164                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
9165                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9166                         },
9167                         _ => panic!("Unexpected event"),
9168                 };
9169         }
9170         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
9171         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
9172         // Carol<->Bob's updated commitment transaction info.
9173         check_added_monitors!(nodes[1], 2);
9174
9175         let events = nodes[1].node.get_and_clear_pending_msg_events();
9176         assert_eq!(events.len(), 2);
9177         let bob_revocation = match events[0] {
9178                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9179                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9180                         (*msg).clone()
9181                 },
9182                 _ => panic!("Unexpected event"),
9183         };
9184         let bob_updates = match events[1] {
9185                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
9186                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9187                         (*updates).clone()
9188                 },
9189                 _ => panic!("Unexpected event"),
9190         };
9191
9192         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
9193         check_added_monitors!(nodes[2], 1);
9194         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
9195         check_added_monitors!(nodes[2], 1);
9196
9197         let events = nodes[2].node.get_and_clear_pending_msg_events();
9198         assert_eq!(events.len(), 1);
9199         let carol_revocation = match events[0] {
9200                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9201                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9202                         (*msg).clone()
9203                 },
9204                 _ => panic!("Unexpected event"),
9205         };
9206         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9207         check_added_monitors!(nodes[1], 1);
9208
9209         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9210         // here's where we put said channel's commitment tx on-chain.
9211         let mut txn_to_broadcast = alice_txn.clone();
9212         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9213         if !go_onchain_before_fulfill {
9214                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9215                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9216                 // If Bob was the one to force-close, he will have already passed these checks earlier.
9217                 if broadcast_alice {
9218                         check_closed_broadcast!(nodes[1], true);
9219                         check_added_monitors!(nodes[1], 1);
9220                 }
9221                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9222                 if broadcast_alice {
9223                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9224                         // new block being connected. The ChannelManager being notified triggers a monitor update,
9225                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9226                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9227                         // broadcasted.
9228                         assert_eq!(bob_txn.len(), 3);
9229                         check_spends!(bob_txn[1], chan_ab.3);
9230                 } else {
9231                         assert_eq!(bob_txn.len(), 2);
9232                         check_spends!(bob_txn[0], chan_ab.3);
9233                 }
9234         }
9235
9236         // Step (6):
9237         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9238         // broadcasted commitment transaction.
9239         {
9240                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9241                 if go_onchain_before_fulfill {
9242                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9243                         assert_eq!(bob_txn.len(), 2);
9244                 }
9245                 let script_weight = match broadcast_alice {
9246                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9247                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9248                 };
9249                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9250                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9251                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9252                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9253                 if broadcast_alice && !go_onchain_before_fulfill {
9254                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9255                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9256                 } else {
9257                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9258                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9259                 }
9260         }
9261 }
9262
9263 #[test]
9264 fn test_onchain_htlc_settlement_after_close() {
9265         do_test_onchain_htlc_settlement_after_close(true, true);
9266         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9267         do_test_onchain_htlc_settlement_after_close(true, false);
9268         do_test_onchain_htlc_settlement_after_close(false, false);
9269 }
9270
9271 #[test]
9272 fn test_duplicate_chan_id() {
9273         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9274         // already open we reject it and keep the old channel.
9275         //
9276         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9277         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9278         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9279         // updating logic for the existing channel.
9280         let chanmon_cfgs = create_chanmon_cfgs(2);
9281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9283         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9284
9285         // Create an initial channel
9286         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9287         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9288         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9289         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()));
9290
9291         // Try to create a second channel with the same temporary_channel_id as the first and check
9292         // that it is rejected.
9293         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9294         {
9295                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9296                 assert_eq!(events.len(), 1);
9297                 match events[0] {
9298                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9299                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9300                                 // first (valid) and second (invalid) channels are closed, given they both have
9301                                 // the same non-temporary channel_id. However, currently we do not, so we just
9302                                 // move forward with it.
9303                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9304                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9305                         },
9306                         _ => panic!("Unexpected event"),
9307                 }
9308         }
9309
9310         // Move the first channel through the funding flow...
9311         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9312
9313         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9314         check_added_monitors!(nodes[0], 0);
9315
9316         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9317         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9318         {
9319                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9320                 assert_eq!(added_monitors.len(), 1);
9321                 assert_eq!(added_monitors[0].0, funding_output);
9322                 added_monitors.clear();
9323         }
9324         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9325
9326         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9327         let channel_id = funding_outpoint.to_channel_id();
9328
9329         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9330         // temporary one).
9331
9332         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9333         // Technically this is allowed by the spec, but we don't support it and there's little reason
9334         // to. Still, it shouldn't cause any other issues.
9335         open_chan_msg.temporary_channel_id = channel_id;
9336         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9337         {
9338                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9339                 assert_eq!(events.len(), 1);
9340                 match events[0] {
9341                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9342                                 // Technically, at this point, nodes[1] would be justified in thinking both
9343                                 // channels are closed, but currently we do not, so we just move forward with it.
9344                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9345                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9346                         },
9347                         _ => panic!("Unexpected event"),
9348                 }
9349         }
9350
9351         // Now try to create a second channel which has a duplicate funding output.
9352         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9353         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9354         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9355         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()));
9356         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9357
9358         let funding_created = {
9359                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9360                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9361                 let logger = test_utils::TestLogger::new();
9362                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9363         };
9364         check_added_monitors!(nodes[0], 0);
9365         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9366         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9367         // still needs to be cleared here.
9368         check_added_monitors!(nodes[1], 1);
9369
9370         // ...still, nodes[1] will reject the duplicate channel.
9371         {
9372                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9373                 assert_eq!(events.len(), 1);
9374                 match events[0] {
9375                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9376                                 // Technically, at this point, nodes[1] would be justified in thinking both
9377                                 // channels are closed, but currently we do not, so we just move forward with it.
9378                                 assert_eq!(msg.channel_id, channel_id);
9379                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9380                         },
9381                         _ => panic!("Unexpected event"),
9382                 }
9383         }
9384
9385         // finally, finish creating the original channel and send a payment over it to make sure
9386         // everything is functional.
9387         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9388         {
9389                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9390                 assert_eq!(added_monitors.len(), 1);
9391                 assert_eq!(added_monitors[0].0, funding_output);
9392                 added_monitors.clear();
9393         }
9394
9395         let events_4 = nodes[0].node.get_and_clear_pending_events();
9396         assert_eq!(events_4.len(), 0);
9397         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9398         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9399
9400         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9401         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9402         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9403         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9404 }
9405
9406 #[test]
9407 fn test_error_chans_closed() {
9408         // Test that we properly handle error messages, closing appropriate channels.
9409         //
9410         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9411         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9412         // we can test various edge cases around it to ensure we don't regress.
9413         let chanmon_cfgs = create_chanmon_cfgs(3);
9414         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9415         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9416         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9417
9418         // Create some initial channels
9419         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9420         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9421         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9422
9423         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9424         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9425         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9426
9427         // Closing a channel from a different peer has no effect
9428         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9429         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9430
9431         // Closing one channel doesn't impact others
9432         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9433         check_added_monitors!(nodes[0], 1);
9434         check_closed_broadcast!(nodes[0], false);
9435         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9436         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9437         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);
9438         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);
9439
9440         // A null channel ID should close all channels
9441         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9442         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9443         check_added_monitors!(nodes[0], 2);
9444         let events = nodes[0].node.get_and_clear_pending_msg_events();
9445         assert_eq!(events.len(), 2);
9446         match events[0] {
9447                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9448                         assert_eq!(msg.contents.flags & 2, 2);
9449                 },
9450                 _ => panic!("Unexpected event"),
9451         }
9452         match events[1] {
9453                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9454                         assert_eq!(msg.contents.flags & 2, 2);
9455                 },
9456                 _ => panic!("Unexpected event"),
9457         }
9458         // Note that at this point users of a standard PeerHandler will end up calling
9459         // peer_disconnected with no_connection_possible set to false, duplicating the
9460         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9461         // users with their own peer handling logic. We duplicate the call here, however.
9462         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9463         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9464
9465         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9466         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9467         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9468 }
9469
9470 #[test]
9471 fn test_invalid_funding_tx() {
9472         // Test that we properly handle invalid funding transactions sent to us from a peer.
9473         //
9474         // Previously, all other major lightning implementations had failed to properly sanitize
9475         // funding transactions from their counterparties, leading to a multi-implementation critical
9476         // security vulnerability (though we always sanitized properly, we've previously had
9477         // un-released crashes in the sanitization process).
9478         let chanmon_cfgs = create_chanmon_cfgs(2);
9479         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9480         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9481         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9482
9483         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9484         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()));
9485         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()));
9486
9487         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9488         for output in tx.output.iter_mut() {
9489                 // Make the confirmed funding transaction have a bogus script_pubkey
9490                 output.script_pubkey = bitcoin::Script::new();
9491         }
9492
9493         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9494         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()));
9495         check_added_monitors!(nodes[1], 1);
9496
9497         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()));
9498         check_added_monitors!(nodes[0], 1);
9499
9500         let events_1 = nodes[0].node.get_and_clear_pending_events();
9501         assert_eq!(events_1.len(), 0);
9502
9503         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9504         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9505         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9506
9507         confirm_transaction_at(&nodes[1], &tx, 1);
9508         check_added_monitors!(nodes[1], 1);
9509         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9510         assert_eq!(events_2.len(), 1);
9511         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9512                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9513                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9514                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9515                 } else { panic!(); }
9516         } else { panic!(); }
9517         assert_eq!(nodes[1].node.list_channels().len(), 0);
9518 }
9519
9520 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9521         // In the first version of the chain::Confirm interface, after a refactor was made to not
9522         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9523         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9524         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9525         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9526         // spending transaction until height N+1 (or greater). This was due to the way
9527         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9528         // spending transaction at the height the input transaction was confirmed at, not whether we
9529         // should broadcast a spending transaction at the current height.
9530         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9531         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9532         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9533         // until we learned about an additional block.
9534         //
9535         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9536         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9537         let chanmon_cfgs = create_chanmon_cfgs(3);
9538         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9539         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9540         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9541         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9542
9543         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9544         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9545         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9546         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9547         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9548
9549         nodes[1].node.force_close_channel(&channel_id).unwrap();
9550         check_closed_broadcast!(nodes[1], true);
9551         check_added_monitors!(nodes[1], 1);
9552         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9553         assert_eq!(node_txn.len(), 1);
9554
9555         let conf_height = nodes[1].best_block_info().1;
9556         if !test_height_before_timelock {
9557                 connect_blocks(&nodes[1], 24 * 6);
9558         }
9559         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9560                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9561         if test_height_before_timelock {
9562                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9563                 // generate any events or broadcast any transactions
9564                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9565                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9566         } else {
9567                 // We should broadcast an HTLC transaction spending our funding transaction first
9568                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9569                 assert_eq!(spending_txn.len(), 2);
9570                 assert_eq!(spending_txn[0], node_txn[0]);
9571                 check_spends!(spending_txn[1], node_txn[0]);
9572                 // We should also generate a SpendableOutputs event with the to_self output (as its
9573                 // timelock is up).
9574                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9575                 assert_eq!(descriptor_spend_txn.len(), 1);
9576
9577                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9578                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9579                 // additional block built on top of the current chain.
9580                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9581                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9582                 expect_pending_htlcs_forwardable!(nodes[1]);
9583                 check_added_monitors!(nodes[1], 1);
9584
9585                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9586                 assert!(updates.update_add_htlcs.is_empty());
9587                 assert!(updates.update_fulfill_htlcs.is_empty());
9588                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9589                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9590                 assert!(updates.update_fee.is_none());
9591                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9592                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9593                 expect_payment_failed!(nodes[0], payment_hash, false);
9594                 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9595         }
9596 }
9597 #[test]
9598 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9599         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9600         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9601 }