_ 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, get_keysend_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         expect_payment_forwarded!(nodes[1], Some(1000), false);
 890         check_added_monitors!(nodes[1], 1);
 891         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 892         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 893
 894         assert!(updates_2.update_add_htlcs.is_empty());
 895         assert!(updates_2.update_fail_htlcs.is_empty());
 896         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 897         assert!(updates_2.update_fee.is_none());
 898         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 899         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 900         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 901
 902         let events = nodes[0].node.get_and_clear_pending_events();
 903         assert_eq!(events.len(), 1);
 904         match events[0] {
 905                 Event::PaymentSent { ref payment_preimage } => {
 906                         assert_eq!(our_payment_preimage, *payment_preimage);
 907                 },
 908                 _ => panic!("Unexpected event"),
 909         }
 910
 911         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 912         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 913         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 914         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 915         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 916         assert!(node_0_none.is_none());
 917
 918         assert!(nodes[0].node.list_channels().is_empty());
 919
 920         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 921         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 922         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 923         assert!(nodes[1].node.list_channels().is_empty());
 924         assert!(nodes[2].node.list_channels().is_empty());
 925 }
 926
 927 #[test]
 928 fn htlc_fail_async_shutdown() {
 929         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 930         let chanmon_cfgs = create_chanmon_cfgs(3);
 931         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 932         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 933         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 934         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 935         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 936         let logger = test_utils::TestLogger::new();
 937
 938         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 939         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 940         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();
 941         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 942         check_added_monitors!(nodes[0], 1);
 943         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 944         assert_eq!(updates.update_add_htlcs.len(), 1);
 945         assert!(updates.update_fulfill_htlcs.is_empty());
 946         assert!(updates.update_fail_htlcs.is_empty());
 947         assert!(updates.update_fail_malformed_htlcs.is_empty());
 948         assert!(updates.update_fee.is_none());
 949
 950         nodes[1].node.close_channel(&chan_1.2).unwrap();
 951         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 952         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 953         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 954
 955         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 956         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 957         check_added_monitors!(nodes[1], 1);
 958         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 959         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 960
 961         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 962         assert!(updates_2.update_add_htlcs.is_empty());
 963         assert!(updates_2.update_fulfill_htlcs.is_empty());
 964         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 965         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 966         assert!(updates_2.update_fee.is_none());
 967
 968         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 969         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 970
 971         expect_payment_failed!(nodes[0], our_payment_hash, false);
 972
 973         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 974         assert_eq!(msg_events.len(), 2);
 975         let node_0_closing_signed = match msg_events[0] {
 976                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 977                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 978                         (*msg).clone()
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         };
 982         match msg_events[1] {
 983                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 984                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 985                 },
 986                 _ => panic!("Unexpected event"),
 987         }
 988
 989         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 990         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 991         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 992         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 993         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 994         assert!(node_0_none.is_none());
 995
 996         assert!(nodes[0].node.list_channels().is_empty());
 997
 998         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 999         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1000         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1001         assert!(nodes[1].node.list_channels().is_empty());
1002         assert!(nodes[2].node.list_channels().is_empty());
1003 }
1004
1005 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1006         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1007         // messages delivered prior to disconnect
1008         let chanmon_cfgs = create_chanmon_cfgs(3);
1009         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1010         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1011         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1012         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1013         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1014
1015         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1016
1017         nodes[1].node.close_channel(&chan_1.2).unwrap();
1018         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1019         if recv_count > 0 {
1020                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1021                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1022                 if recv_count > 1 {
1023                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1024                 }
1025         }
1026
1027         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1028         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1029
1030         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1031         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1032         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1033         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1034
1035         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1036         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1037         assert!(node_1_shutdown == node_1_2nd_shutdown);
1038
1039         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1040         let node_0_2nd_shutdown = if recv_count > 0 {
1041                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1042                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1043                 node_0_2nd_shutdown
1044         } else {
1045                 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1046                 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1047                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1048                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1049         };
1050         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1051
1052         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1053         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1054
1055         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1056         check_added_monitors!(nodes[2], 1);
1057         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1058         assert!(updates.update_add_htlcs.is_empty());
1059         assert!(updates.update_fail_htlcs.is_empty());
1060         assert!(updates.update_fail_malformed_htlcs.is_empty());
1061         assert!(updates.update_fee.is_none());
1062         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1063         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1064         expect_payment_forwarded!(nodes[1], Some(1000), false);
1065         check_added_monitors!(nodes[1], 1);
1066         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1067         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1068
1069         assert!(updates_2.update_add_htlcs.is_empty());
1070         assert!(updates_2.update_fail_htlcs.is_empty());
1071         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1072         assert!(updates_2.update_fee.is_none());
1073         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1074         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1075         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1076
1077         let events = nodes[0].node.get_and_clear_pending_events();
1078         assert_eq!(events.len(), 1);
1079         match events[0] {
1080                 Event::PaymentSent { ref payment_preimage } => {
1081                         assert_eq!(our_payment_preimage, *payment_preimage);
1082                 },
1083                 _ => panic!("Unexpected event"),
1084         }
1085
1086         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1087         if recv_count > 0 {
1088                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1089                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1090                 assert!(node_1_closing_signed.is_some());
1091         }
1092
1093         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1094         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1095
1096         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1097         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1098         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1099         if recv_count == 0 {
1100                 // If all closing_signeds weren't delivered we can just resume where we left off...
1101                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1102
1103                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1104                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1105                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1106
1107                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1108                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1109                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1110
1111                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1112                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1113
1114                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1115                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1116                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1117
1118                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1119                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1120                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1121                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1122                 assert!(node_0_none.is_none());
1123         } else {
1124                 // If one node, however, received + responded with an identical closing_signed we end
1125                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1126                 // There isn't really anything better we can do simply, but in the future we might
1127                 // explore storing a set of recently-closed channels that got disconnected during
1128                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1129                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1130                 // transaction.
1131                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1132
1133                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1134                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1135                 assert_eq!(msg_events.len(), 1);
1136                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1137                         match action {
1138                                 &ErrorAction::SendErrorMessage { ref msg } => {
1139                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1140                                         assert_eq!(msg.channel_id, chan_1.2);
1141                                 },
1142                                 _ => panic!("Unexpected event!"),
1143                         }
1144                 } else { panic!("Needed SendErrorMessage close"); }
1145
1146                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1147                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1148                 // closing_signed so we do it ourselves
1149                 check_closed_broadcast!(nodes[0], false);
1150                 check_added_monitors!(nodes[0], 1);
1151         }
1152
1153         assert!(nodes[0].node.list_channels().is_empty());
1154
1155         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1156         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1157         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1158         assert!(nodes[1].node.list_channels().is_empty());
1159         assert!(nodes[2].node.list_channels().is_empty());
1160 }
1161
1162 #[test]
1163 fn test_shutdown_rebroadcast() {
1164         do_test_shutdown_rebroadcast(0);
1165         do_test_shutdown_rebroadcast(1);
1166         do_test_shutdown_rebroadcast(2);
1167 }
1168
1169 #[test]
1170 fn fake_network_test() {
1171         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1172         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1173         let chanmon_cfgs = create_chanmon_cfgs(4);
1174         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1175         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1176         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1177
1178         // Create some initial channels
1179         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1180         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1181         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1182
1183         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1187         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1188
1189         // Send some more payments
1190         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1191         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1192         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1193
1194         // Test failure packets
1195         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1196         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1197
1198         // Add a new channel that skips 3
1199         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1200
1201         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1202         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1207         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1208
1209         // Do some rebalance loop payments, simultaneously
1210         let mut hops = Vec::with_capacity(3);
1211         hops.push(RouteHop {
1212                 pubkey: nodes[2].node.get_our_node_id(),
1213                 node_features: NodeFeatures::empty(),
1214                 short_channel_id: chan_2.0.contents.short_channel_id,
1215                 channel_features: ChannelFeatures::empty(),
1216                 fee_msat: 0,
1217                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1218         });
1219         hops.push(RouteHop {
1220                 pubkey: nodes[3].node.get_our_node_id(),
1221                 node_features: NodeFeatures::empty(),
1222                 short_channel_id: chan_3.0.contents.short_channel_id,
1223                 channel_features: ChannelFeatures::empty(),
1224                 fee_msat: 0,
1225                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1226         });
1227         hops.push(RouteHop {
1228                 pubkey: nodes[1].node.get_our_node_id(),
1229                 node_features: NodeFeatures::known(),
1230                 short_channel_id: chan_4.0.contents.short_channel_id,
1231                 channel_features: ChannelFeatures::known(),
1232                 fee_msat: 1000000,
1233                 cltv_expiry_delta: TEST_FINAL_CLTV,
1234         });
1235         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;
1236         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;
1237         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1238
1239         let mut hops = Vec::with_capacity(3);
1240         hops.push(RouteHop {
1241                 pubkey: nodes[3].node.get_our_node_id(),
1242                 node_features: NodeFeatures::empty(),
1243                 short_channel_id: chan_4.0.contents.short_channel_id,
1244                 channel_features: ChannelFeatures::empty(),
1245                 fee_msat: 0,
1246                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1247         });
1248         hops.push(RouteHop {
1249                 pubkey: nodes[2].node.get_our_node_id(),
1250                 node_features: NodeFeatures::empty(),
1251                 short_channel_id: chan_3.0.contents.short_channel_id,
1252                 channel_features: ChannelFeatures::empty(),
1253                 fee_msat: 0,
1254                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1255         });
1256         hops.push(RouteHop {
1257                 pubkey: nodes[1].node.get_our_node_id(),
1258                 node_features: NodeFeatures::known(),
1259                 short_channel_id: chan_2.0.contents.short_channel_id,
1260                 channel_features: ChannelFeatures::known(),
1261                 fee_msat: 1000000,
1262                 cltv_expiry_delta: TEST_FINAL_CLTV,
1263         });
1264         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;
1265         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;
1266         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1267
1268         // Claim the rebalances...
1269         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1270         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1271
1272         // Add a duplicate new channel from 2 to 4
1273         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1274
1275         // Send some payments across both channels
1276         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1277         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1278         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1279
1280
1281         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1282         let events = nodes[0].node.get_and_clear_pending_msg_events();
1283         assert_eq!(events.len(), 0);
1284         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);
1285
1286         //TODO: Test that routes work again here as we've been notified that the channel is full
1287
1288         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1289         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1290         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1291
1292         // Close down the channels...
1293         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1294         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1295         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1296         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1297         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1298 }
1299
1300 #[test]
1301 fn holding_cell_htlc_counting() {
1302         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1303         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1304         // commitment dance rounds.
1305         let chanmon_cfgs = create_chanmon_cfgs(3);
1306         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1307         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1308         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1309         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1310         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1311         let logger = test_utils::TestLogger::new();
1312
1313         let mut payments = Vec::new();
1314         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1315                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1316                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1317                 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();
1318                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1319                 payments.push((payment_preimage, payment_hash));
1320         }
1321         check_added_monitors!(nodes[1], 1);
1322
1323         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1324         assert_eq!(events.len(), 1);
1325         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1326         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1327
1328         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1329         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1330         // another HTLC.
1331         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1332         {
1333                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1334                 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();
1335                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1336                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1337                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1338                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1339         }
1340
1341         // This should also be true if we try to forward a payment.
1342         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1343         {
1344                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1345                 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();
1346                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1347                 check_added_monitors!(nodes[0], 1);
1348         }
1349
1350         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1351         assert_eq!(events.len(), 1);
1352         let payment_event = SendEvent::from_event(events.pop().unwrap());
1353         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1354
1355         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1356         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1357         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1358         // fails), the second will process the resulting failure and fail the HTLC backward.
1359         expect_pending_htlcs_forwardable!(nodes[1]);
1360         expect_pending_htlcs_forwardable!(nodes[1]);
1361         check_added_monitors!(nodes[1], 1);
1362
1363         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1364         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1365         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1366
1367         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1368         expect_payment_failed!(nodes[0], payment_hash_2, false);
1369
1370         // Now forward all the pending HTLCs and claim them back
1371         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1372         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1373         check_added_monitors!(nodes[2], 1);
1374
1375         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1376         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1377         check_added_monitors!(nodes[1], 1);
1378         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1379
1380         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1381         check_added_monitors!(nodes[1], 1);
1382         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1383
1384         for ref update in as_updates.update_add_htlcs.iter() {
1385                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1386         }
1387         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1388         check_added_monitors!(nodes[2], 1);
1389         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1390         check_added_monitors!(nodes[2], 1);
1391         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1392
1393         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1394         check_added_monitors!(nodes[1], 1);
1395         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1396         check_added_monitors!(nodes[1], 1);
1397         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1398
1399         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1400         check_added_monitors!(nodes[2], 1);
1401
1402         expect_pending_htlcs_forwardable!(nodes[2]);
1403
1404         let events = nodes[2].node.get_and_clear_pending_events();
1405         assert_eq!(events.len(), payments.len());
1406         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1407                 match event {
1408                         &Event::PaymentReceived { ref payment_hash, .. } => {
1409                                 assert_eq!(*payment_hash, *hash);
1410                         },
1411                         _ => panic!("Unexpected event"),
1412                 };
1413         }
1414
1415         for (preimage, _) in payments.drain(..) {
1416                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1417         }
1418
1419         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1420 }
1421
1422 #[test]
1423 fn duplicate_htlc_test() {
1424         // Test that we accept duplicate payment_hash HTLCs across the network and that
1425         // claiming/failing them are all separate and don't affect each other
1426         let chanmon_cfgs = create_chanmon_cfgs(6);
1427         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1428         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1429         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1430
1431         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1432         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1433         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1434         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1435         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1437
1438         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1439
1440         *nodes[0].network_payment_count.borrow_mut() -= 1;
1441         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1442
1443         *nodes[0].network_payment_count.borrow_mut() -= 1;
1444         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1445
1446         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1447         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1448         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1449 }
1450
1451 #[test]
1452 fn test_duplicate_htlc_different_direction_onchain() {
1453         // Test that ChannelMonitor doesn't generate 2 preimage txn
1454         // when we have 2 HTLCs with same preimage that go across a node
1455         // in opposite directions, even with the same payment secret.
1456         let chanmon_cfgs = create_chanmon_cfgs(2);
1457         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1458         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1459         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1460
1461         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1462         let logger = test_utils::TestLogger::new();
1463
1464         // balancing
1465         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1466
1467         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1468
1469         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1470         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();
1471         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1472         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1473
1474         // Provide preimage to node 0 by claiming payment
1475         nodes[0].node.claim_funds(payment_preimage);
1476         check_added_monitors!(nodes[0], 1);
1477
1478         // Broadcast node 1 commitment txn
1479         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1480
1481         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1482         let mut has_both_htlcs = 0; // check htlcs match ones committed
1483         for outp in remote_txn[0].output.iter() {
1484                 if outp.value == 800_000 / 1000 {
1485                         has_both_htlcs += 1;
1486                 } else if outp.value == 900_000 / 1000 {
1487                         has_both_htlcs += 1;
1488                 }
1489         }
1490         assert_eq!(has_both_htlcs, 2);
1491
1492         mine_transaction(&nodes[0], &remote_txn[0]);
1493         check_added_monitors!(nodes[0], 1);
1494         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1495
1496         // Check we only broadcast 1 timeout tx
1497         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1498         assert_eq!(claim_txn.len(), 8);
1499         assert_eq!(claim_txn[1], claim_txn[4]);
1500         assert_eq!(claim_txn[2], claim_txn[5]);
1501         check_spends!(claim_txn[1], chan_1.3);
1502         check_spends!(claim_txn[2], claim_txn[1]);
1503         check_spends!(claim_txn[7], claim_txn[1]);
1504
1505         assert_eq!(claim_txn[0].input.len(), 1);
1506         assert_eq!(claim_txn[3].input.len(), 1);
1507         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1508
1509         assert_eq!(claim_txn[0].input.len(), 1);
1510         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1511         check_spends!(claim_txn[0], remote_txn[0]);
1512         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1513         assert_eq!(claim_txn[6].input.len(), 1);
1514         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1515         check_spends!(claim_txn[6], remote_txn[0]);
1516         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1517
1518         let events = nodes[0].node.get_and_clear_pending_msg_events();
1519         assert_eq!(events.len(), 3);
1520         for e in events {
1521                 match e {
1522                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1523                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1524                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1525                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1526                         },
1527                         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, .. } } => {
1528                                 assert!(update_add_htlcs.is_empty());
1529                                 assert!(update_fail_htlcs.is_empty());
1530                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1531                                 assert!(update_fail_malformed_htlcs.is_empty());
1532                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1533                         },
1534                         _ => panic!("Unexpected event"),
1535                 }
1536         }
1537 }
1538
1539 #[test]
1540 fn test_basic_channel_reserve() {
1541         let chanmon_cfgs = create_chanmon_cfgs(2);
1542         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1543         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1544         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1545         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1546         let logger = test_utils::TestLogger::new();
1547
1548         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1549         let channel_reserve = chan_stat.channel_reserve_msat;
1550
1551         // The 2* and +1 are for the fee spike reserve.
1552         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1553         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1554         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1555         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1556         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();
1557         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1558         match err {
1559                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1560                         match &fails[0] {
1561                                 &APIError::ChannelUnavailable{ref err} =>
1562                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1563                                 _ => panic!("Unexpected error variant"),
1564                         }
1565                 },
1566                 _ => panic!("Unexpected error variant"),
1567         }
1568         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1569         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);
1570
1571         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1572 }
1573
1574 #[test]
1575 fn test_fee_spike_violation_fails_htlc() {
1576         let chanmon_cfgs = create_chanmon_cfgs(2);
1577         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1578         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1579         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1580         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1581
1582         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1583         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1584         let secp_ctx = Secp256k1::new();
1585         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1586
1587         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1588
1589         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1590         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1591         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1592         let msg = msgs::UpdateAddHTLC {
1593                 channel_id: chan.2,
1594                 htlc_id: 0,
1595                 amount_msat: htlc_msat,
1596                 payment_hash: payment_hash,
1597                 cltv_expiry: htlc_cltv,
1598                 onion_routing_packet: onion_packet,
1599         };
1600
1601         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1602
1603         // Now manually create the commitment_signed message corresponding to the update_add
1604         // nodes[0] just sent. In the code for construction of this message, "local" refers
1605         // to the sender of the message, and "remote" refers to the receiver.
1606
1607         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1608
1609         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1610
1611         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1612         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1613         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1614                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1615                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1616                 let chan_signer = local_chan.get_signer();
1617                 let pubkeys = chan_signer.pubkeys();
1618                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1619                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1620                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1621         };
1622         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1623                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1624                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1625                 let chan_signer = remote_chan.get_signer();
1626                 let pubkeys = chan_signer.pubkeys();
1627                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1628                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1629         };
1630
1631         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1632         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1633                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1634
1635         // Build the remote commitment transaction so we can sign it, and then later use the
1636         // signature for the commitment_signed message.
1637         let local_chan_balance = 1313;
1638
1639         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1640                 offered: false,
1641                 amount_msat: 3460001,
1642                 cltv_expiry: htlc_cltv,
1643                 payment_hash,
1644                 transaction_output_index: Some(1),
1645         };
1646
1647         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1648
1649         let res = {
1650                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1651                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1652                 let local_chan_signer = local_chan.get_signer();
1653                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1654                         commitment_number,
1655                         95000,
1656                         local_chan_balance,
1657                         commit_tx_keys.clone(),
1658                         feerate_per_kw,
1659                         &mut vec![(accepted_htlc_info, ())],
1660                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1661                 );
1662                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1663         };
1664
1665         let commit_signed_msg = msgs::CommitmentSigned {
1666                 channel_id: chan.2,
1667                 signature: res.0,
1668                 htlc_signatures: res.1
1669         };
1670
1671         // Send the commitment_signed message to the nodes[1].
1672         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1673         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1674
1675         // Send the RAA to nodes[1].
1676         let raa_msg = msgs::RevokeAndACK {
1677                 channel_id: chan.2,
1678                 per_commitment_secret: local_secret,
1679                 next_per_commitment_point: next_local_point
1680         };
1681         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1682
1683         let events = nodes[1].node.get_and_clear_pending_msg_events();
1684         assert_eq!(events.len(), 1);
1685         // Make sure the HTLC failed in the way we expect.
1686         match events[0] {
1687                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1688                         assert_eq!(update_fail_htlcs.len(), 1);
1689                         update_fail_htlcs[0].clone()
1690                 },
1691                 _ => panic!("Unexpected event"),
1692         };
1693         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1694                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1695
1696         check_added_monitors!(nodes[1], 2);
1697 }
1698
1699 #[test]
1700 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1701         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1702         // Set the fee rate for the channel very high, to the point where the fundee
1703         // sending any above-dust amount would result in a channel reserve violation.
1704         // In this test we check that we would be prevented from sending an HTLC in
1705         // this situation.
1706         let feerate_per_kw = 253;
1707         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1708         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1709         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1710         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1711         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1712
1713         let mut push_amt = 100_000_000;
1714         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1715         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1716
1717         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1718
1719         // Sending exactly enough to hit the reserve amount should be accepted
1720         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1721
1722         // However one more HTLC should be significantly over the reserve amount and fail.
1723         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1724         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1725                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1726         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1727         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);
1728 }
1729
1730 #[test]
1731 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1732         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1733         // Set the fee rate for the channel very high, to the point where the funder
1734         // receiving 1 update_add_htlc would result in them closing the channel due
1735         // to channel reserve violation. This close could also happen if the fee went
1736         // up a more realistic amount, but many HTLCs were outstanding at the time of
1737         // the update_add_htlc.
1738         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1739         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1740         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1741         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1742         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1743         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1744
1745         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1746         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1747         let secp_ctx = Secp256k1::new();
1748         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1749         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1750         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1751         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1752         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1753         let msg = msgs::UpdateAddHTLC {
1754                 channel_id: chan.2,
1755                 htlc_id: 1,
1756                 amount_msat: htlc_msat + 1,
1757                 payment_hash: payment_hash,
1758                 cltv_expiry: htlc_cltv,
1759                 onion_routing_packet: onion_packet,
1760         };
1761
1762         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1763         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1764         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);
1765         assert_eq!(nodes[0].node.list_channels().len(), 0);
1766         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1767         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1768         check_added_monitors!(nodes[0], 1);
1769 }
1770
1771 #[test]
1772 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1773         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1774         // calculating our commitment transaction fee (this was previously broken).
1775         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1776         let feerate_per_kw = 253;
1777         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1778         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1779
1780         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1781         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1782         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1783
1784         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1785         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1786         // transaction fee with 0 HTLCs (183 sats)).
1787         let mut push_amt = 100_000_000;
1788         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1789         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1790         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1791
1792         let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1793                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1794         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1795         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1796         // commitment transaction fee.
1797         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1798
1799         // One more than the dust amt should fail, however.
1800         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1801         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1802                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1803 }
1804
1805 #[test]
1806 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1807         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1808         // calculating our counterparty's commitment transaction fee (this was previously broken).
1809         let chanmon_cfgs = create_chanmon_cfgs(2);
1810         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1811         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1812         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1813         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1814
1815         let payment_amt = 46000; // Dust amount
1816         // In the previous code, these first four payments would succeed.
1817         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1818         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1820         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1821
1822         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1827         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1828
1829         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1830         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1831         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1832         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1833 }
1834
1835 #[test]
1836 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1837         let chanmon_cfgs = create_chanmon_cfgs(3);
1838         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1839         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1840         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1841         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1842         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1843
1844         let feemsat = 239;
1845         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1846         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1847         let feerate = get_feerate!(nodes[0], chan.2);
1848
1849         // Add a 2* and +1 for the fee spike reserve.
1850         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1851         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;
1852         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1853
1854         // Add a pending HTLC.
1855         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1856         let payment_event_1 = {
1857                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1858                 check_added_monitors!(nodes[0], 1);
1859
1860                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1861                 assert_eq!(events.len(), 1);
1862                 SendEvent::from_event(events.remove(0))
1863         };
1864         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1865
1866         // Attempt to trigger a channel reserve violation --> payment failure.
1867         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1868         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;
1869         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1870         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1871
1872         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1873         let secp_ctx = Secp256k1::new();
1874         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1875         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1876         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1877         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1878         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1879         let msg = msgs::UpdateAddHTLC {
1880                 channel_id: chan.2,
1881                 htlc_id: 1,
1882                 amount_msat: htlc_msat + 1,
1883                 payment_hash: our_payment_hash_1,
1884                 cltv_expiry: htlc_cltv,
1885                 onion_routing_packet: onion_packet,
1886         };
1887
1888         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1889         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1890         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1891         assert_eq!(nodes[1].node.list_channels().len(), 1);
1892         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1893         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1894         check_added_monitors!(nodes[1], 1);
1895 }
1896
1897 #[test]
1898 fn test_inbound_outbound_capacity_is_not_zero() {
1899         let chanmon_cfgs = create_chanmon_cfgs(2);
1900         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1901         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1902         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1903         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1904         let channels0 = node_chanmgrs[0].list_channels();
1905         let channels1 = node_chanmgrs[1].list_channels();
1906         assert_eq!(channels0.len(), 1);
1907         assert_eq!(channels1.len(), 1);
1908
1909         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1910         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1911         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1912
1913         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1914         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1915 }
1916
1917 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1918         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1919 }
1920
1921 #[test]
1922 fn test_channel_reserve_holding_cell_htlcs() {
1923         let chanmon_cfgs = create_chanmon_cfgs(3);
1924         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1925         // When this test was written, the default base fee floated based on the HTLC count.
1926         // It is now fixed, so we simply set the fee to the expected value here.
1927         let mut config = test_default_channel_config();
1928         config.channel_options.forwarding_fee_base_msat = 239;
1929         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1930         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1931         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1932         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1933
1934         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1935         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1936
1937         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1938         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1939
1940         macro_rules! expect_forward {
1941                 ($node: expr) => {{
1942                         let mut events = $node.node.get_and_clear_pending_msg_events();
1943                         assert_eq!(events.len(), 1);
1944                         check_added_monitors!($node, 1);
1945                         let payment_event = SendEvent::from_event(events.remove(0));
1946                         payment_event
1947                 }}
1948         }
1949
1950         let feemsat = 239; // set above
1951         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1952         let feerate = get_feerate!(nodes[0], chan_1.2);
1953
1954         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1955
1956         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1957         {
1958                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1959                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1960                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1961                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1962                         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)));
1963                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1964                 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);
1965         }
1966
1967         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1968         // nodes[0]'s wealth
1969         loop {
1970                 let amt_msat = recv_value_0 + total_fee_msat;
1971                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1972                 // Also, ensure that each payment has enough to be over the dust limit to
1973                 // ensure it'll be included in each commit tx fee calculation.
1974                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1975                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1976                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1977                         break;
1978                 }
1979                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1980
1981                 let (stat01_, stat11_, stat12_, stat22_) = (
1982                         get_channel_value_stat!(nodes[0], chan_1.2),
1983                         get_channel_value_stat!(nodes[1], chan_1.2),
1984                         get_channel_value_stat!(nodes[1], chan_2.2),
1985                         get_channel_value_stat!(nodes[2], chan_2.2),
1986                 );
1987
1988                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1989                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1990                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1991                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1992                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1993         }
1994
1995         // adding pending output.
1996         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1997         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1998         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1999         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2000         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2001         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2002         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2003         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2004         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2005         // policy.
2006         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2007         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2008         let amt_msat_1 = recv_value_1 + total_fee_msat;
2009
2010         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);
2011         let payment_event_1 = {
2012                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
2013                 check_added_monitors!(nodes[0], 1);
2014
2015                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2016                 assert_eq!(events.len(), 1);
2017                 SendEvent::from_event(events.remove(0))
2018         };
2019         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2020
2021         // channel reserve test with htlc pending output > 0
2022         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2023         {
2024                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2025                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2026                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2027                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2028         }
2029
2030         // split the rest to test holding cell
2031         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2032         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2033         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2034         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2035         {
2036                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2037                 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);
2038         }
2039
2040         // now see if they go through on both sides
2041         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);
2042         // but this will stuck in the holding cell
2043         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2044         check_added_monitors!(nodes[0], 0);
2045         let events = nodes[0].node.get_and_clear_pending_events();
2046         assert_eq!(events.len(), 0);
2047
2048         // test with outbound holding cell amount > 0
2049         {
2050                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2051                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2052                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2053                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2054                 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);
2055         }
2056
2057         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);
2058         // this will also stuck in the holding cell
2059         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2060         check_added_monitors!(nodes[0], 0);
2061         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2062         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2063
2064         // flush the pending htlc
2065         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2066         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2067         check_added_monitors!(nodes[1], 1);
2068
2069         // the pending htlc should be promoted to committed
2070         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2071         check_added_monitors!(nodes[0], 1);
2072         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2073
2074         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2075         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2076         // No commitment_signed so get_event_msg's assert(len == 1) passes
2077         check_added_monitors!(nodes[0], 1);
2078
2079         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2080         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2081         check_added_monitors!(nodes[1], 1);
2082
2083         expect_pending_htlcs_forwardable!(nodes[1]);
2084
2085         let ref payment_event_11 = expect_forward!(nodes[1]);
2086         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2087         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2088
2089         expect_pending_htlcs_forwardable!(nodes[2]);
2090         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2091
2092         // flush the htlcs in the holding cell
2093         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2094         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2095         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2096         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2097         expect_pending_htlcs_forwardable!(nodes[1]);
2098
2099         let ref payment_event_3 = expect_forward!(nodes[1]);
2100         assert_eq!(payment_event_3.msgs.len(), 2);
2101         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2102         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2103
2104         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2105         expect_pending_htlcs_forwardable!(nodes[2]);
2106
2107         let events = nodes[2].node.get_and_clear_pending_events();
2108         assert_eq!(events.len(), 2);
2109         match events[0] {
2110                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2111                         assert_eq!(our_payment_hash_21, *payment_hash);
2112                         assert_eq!(recv_value_21, amt);
2113                         match &purpose {
2114                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2115                                         assert!(payment_preimage.is_none());
2116                                         assert_eq!(our_payment_secret_21, *payment_secret);
2117                                 },
2118                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
2119                         }
2120                 },
2121                 _ => panic!("Unexpected event"),
2122         }
2123         match events[1] {
2124                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2125                         assert_eq!(our_payment_hash_22, *payment_hash);
2126                         assert_eq!(recv_value_22, amt);
2127                         match &purpose {
2128                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2129                                         assert!(payment_preimage.is_none());
2130                                         assert_eq!(our_payment_secret_22, *payment_secret);
2131                                 },
2132                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
2133                         }
2134                 },
2135                 _ => panic!("Unexpected event"),
2136         }
2137
2138         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2139         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2140         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2141
2142         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2143         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2144         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2145
2146         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2147         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);
2148         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2149         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2150         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2151
2152         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2153         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2154 }
2155
2156 #[test]
2157 fn channel_reserve_in_flight_removes() {
2158         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2159         // can send to its counterparty, but due to update ordering, the other side may not yet have
2160         // considered those HTLCs fully removed.
2161         // This tests that we don't count HTLCs which will not be included in the next remote
2162         // commitment transaction towards the reserve value (as it implies no commitment transaction
2163         // will be generated which violates the remote reserve value).
2164         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2165         // To test this we:
2166         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2167         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2168         //    you only consider the value of the first HTLC, it may not),
2169         //  * start routing a third HTLC from A to B,
2170         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2171         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2172         //  * deliver the first fulfill from B
2173         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2174         //    claim,
2175         //  * deliver A's response CS and RAA.
2176         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2177         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2178         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2179         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2180         let chanmon_cfgs = create_chanmon_cfgs(2);
2181         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2182         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2183         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2184         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2185         let logger = test_utils::TestLogger::new();
2186
2187         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2188         // Route the first two HTLCs.
2189         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2190         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2191
2192         // Start routing the third HTLC (this is just used to get everyone in the right state).
2193         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2194         let send_1 = {
2195                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2196                 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();
2197                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2198                 check_added_monitors!(nodes[0], 1);
2199                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2200                 assert_eq!(events.len(), 1);
2201                 SendEvent::from_event(events.remove(0))
2202         };
2203
2204         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2205         // initial fulfill/CS.
2206         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2207         check_added_monitors!(nodes[1], 1);
2208         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2209
2210         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2211         // remove the second HTLC when we send the HTLC back from B to A.
2212         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2213         check_added_monitors!(nodes[1], 1);
2214         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2215
2216         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2217         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2218         check_added_monitors!(nodes[0], 1);
2219         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2220         expect_payment_sent!(nodes[0], payment_preimage_1);
2221
2222         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2223         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2224         check_added_monitors!(nodes[1], 1);
2225         // B is already AwaitingRAA, so cant generate a CS here
2226         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2227
2228         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2229         check_added_monitors!(nodes[1], 1);
2230         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2231
2232         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2233         check_added_monitors!(nodes[0], 1);
2234         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2235
2236         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2237         check_added_monitors!(nodes[1], 1);
2238         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2239
2240         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2241         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2242         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2243         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2244         // on-chain as necessary).
2245         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2246         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2247         check_added_monitors!(nodes[0], 1);
2248         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2249         expect_payment_sent!(nodes[0], payment_preimage_2);
2250
2251         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2252         check_added_monitors!(nodes[1], 1);
2253         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2254
2255         expect_pending_htlcs_forwardable!(nodes[1]);
2256         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2257
2258         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2259         // resolve the second HTLC from A's point of view.
2260         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2261         check_added_monitors!(nodes[0], 1);
2262         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2263
2264         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2265         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2266         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2267         let send_2 = {
2268                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2269                 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();
2270                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2271                 check_added_monitors!(nodes[1], 1);
2272                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2273                 assert_eq!(events.len(), 1);
2274                 SendEvent::from_event(events.remove(0))
2275         };
2276
2277         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2278         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2279         check_added_monitors!(nodes[0], 1);
2280         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2281
2282         // Now just resolve all the outstanding messages/HTLCs for completeness...
2283
2284         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2285         check_added_monitors!(nodes[1], 1);
2286         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2287
2288         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2289         check_added_monitors!(nodes[1], 1);
2290
2291         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2292         check_added_monitors!(nodes[0], 1);
2293         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2294
2295         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2296         check_added_monitors!(nodes[1], 1);
2297         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2298
2299         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2300         check_added_monitors!(nodes[0], 1);
2301
2302         expect_pending_htlcs_forwardable!(nodes[0]);
2303         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2304
2305         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2306         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2307 }
2308
2309 #[test]
2310 fn channel_monitor_network_test() {
2311         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2312         // tests that ChannelMonitor is able to recover from various states.
2313         let chanmon_cfgs = create_chanmon_cfgs(5);
2314         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2315         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2316         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2317
2318         // Create some initial channels
2319         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2320         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2321         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2322         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2323
2324         // Make sure all nodes are at the same starting height
2325         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2326         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2327         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2328         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2329         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2330
2331         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2335         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2336
2337         // Simple case with no pending HTLCs:
2338         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2339         check_added_monitors!(nodes[1], 1);
2340         check_closed_broadcast!(nodes[1], false);
2341         {
2342                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2343                 assert_eq!(node_txn.len(), 1);
2344                 mine_transaction(&nodes[0], &node_txn[0]);
2345                 check_added_monitors!(nodes[0], 1);
2346                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2347         }
2348         check_closed_broadcast!(nodes[0], true);
2349         assert_eq!(nodes[0].node.list_channels().len(), 0);
2350         assert_eq!(nodes[1].node.list_channels().len(), 1);
2351
2352         // One pending HTLC is discarded by the force-close:
2353         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2354
2355         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2356         // broadcasted until we reach the timelock time).
2357         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2358         check_closed_broadcast!(nodes[1], false);
2359         check_added_monitors!(nodes[1], 1);
2360         {
2361                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2362                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2363                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2364                 mine_transaction(&nodes[2], &node_txn[0]);
2365                 check_added_monitors!(nodes[2], 1);
2366                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2367         }
2368         check_closed_broadcast!(nodes[2], true);
2369         assert_eq!(nodes[1].node.list_channels().len(), 0);
2370         assert_eq!(nodes[2].node.list_channels().len(), 1);
2371
2372         macro_rules! claim_funds {
2373                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2374                         {
2375                                 assert!($node.node.claim_funds($preimage));
2376                                 check_added_monitors!($node, 1);
2377
2378                                 let events = $node.node.get_and_clear_pending_msg_events();
2379                                 assert_eq!(events.len(), 1);
2380                                 match events[0] {
2381                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2382                                                 assert!(update_add_htlcs.is_empty());
2383                                                 assert!(update_fail_htlcs.is_empty());
2384                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2385                                         },
2386                                         _ => panic!("Unexpected event"),
2387                                 };
2388                         }
2389                 }
2390         }
2391
2392         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2393         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2394         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2395         check_added_monitors!(nodes[2], 1);
2396         check_closed_broadcast!(nodes[2], false);
2397         let node2_commitment_txid;
2398         {
2399                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2400                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2401                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2402                 node2_commitment_txid = node_txn[0].txid();
2403
2404                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2405                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2406                 mine_transaction(&nodes[3], &node_txn[0]);
2407                 check_added_monitors!(nodes[3], 1);
2408                 check_preimage_claim(&nodes[3], &node_txn);
2409         }
2410         check_closed_broadcast!(nodes[3], true);
2411         assert_eq!(nodes[2].node.list_channels().len(), 0);
2412         assert_eq!(nodes[3].node.list_channels().len(), 1);
2413
2414         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2415         // confusing us in the following tests.
2416         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2417
2418         // One pending HTLC to time out:
2419         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2420         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2421         // buffer space).
2422
2423         let (close_chan_update_1, close_chan_update_2) = {
2424                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2425                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2426                 assert_eq!(events.len(), 2);
2427                 let close_chan_update_1 = match events[0] {
2428                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2429                                 msg.clone()
2430                         },
2431                         _ => panic!("Unexpected event"),
2432                 };
2433                 match events[1] {
2434                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2435                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2436                         },
2437                         _ => panic!("Unexpected event"),
2438                 }
2439                 check_added_monitors!(nodes[3], 1);
2440
2441                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2442                 {
2443                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2444                         node_txn.retain(|tx| {
2445                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2446                                         false
2447                                 } else { true }
2448                         });
2449                 }
2450
2451                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2452
2453                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2454                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2455
2456                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2457                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2458                 assert_eq!(events.len(), 2);
2459                 let close_chan_update_2 = match events[0] {
2460                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2461                                 msg.clone()
2462                         },
2463                         _ => panic!("Unexpected event"),
2464                 };
2465                 match events[1] {
2466                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2467                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2468                         },
2469                         _ => panic!("Unexpected event"),
2470                 }
2471                 check_added_monitors!(nodes[4], 1);
2472                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2473
2474                 mine_transaction(&nodes[4], &node_txn[0]);
2475                 check_preimage_claim(&nodes[4], &node_txn);
2476                 (close_chan_update_1, close_chan_update_2)
2477         };
2478         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2479         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2480         assert_eq!(nodes[3].node.list_channels().len(), 0);
2481         assert_eq!(nodes[4].node.list_channels().len(), 0);
2482
2483         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2484 }
2485
2486 #[test]
2487 fn test_justice_tx() {
2488         // Test justice txn built on revoked HTLC-Success tx, against both sides
2489         let mut alice_config = UserConfig::default();
2490         alice_config.channel_options.announced_channel = true;
2491         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2492         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2493         let mut bob_config = UserConfig::default();
2494         bob_config.channel_options.announced_channel = true;
2495         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2496         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2497         let user_cfgs = [Some(alice_config), Some(bob_config)];
2498         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2499         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2500         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2501         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2502         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2503         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2504         // Create some new channels:
2505         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2506
2507         // A pending HTLC which will be revoked:
2508         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2509         // Get the will-be-revoked local txn from nodes[0]
2510         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2511         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2512         assert_eq!(revoked_local_txn[0].input.len(), 1);
2513         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2514         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2515         assert_eq!(revoked_local_txn[1].input.len(), 1);
2516         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2517         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2518         // Revoke the old state
2519         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2520
2521         {
2522                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2523                 {
2524                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2525                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2526                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2527
2528                         check_spends!(node_txn[0], revoked_local_txn[0]);
2529                         node_txn.swap_remove(0);
2530                         node_txn.truncate(1);
2531                 }
2532                 check_added_monitors!(nodes[1], 1);
2533                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2534
2535                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2536                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2537                 // Verify broadcast of revoked HTLC-timeout
2538                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2539                 check_added_monitors!(nodes[0], 1);
2540                 // Broadcast revoked HTLC-timeout on node 1
2541                 mine_transaction(&nodes[1], &node_txn[1]);
2542                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2543         }
2544         get_announce_close_broadcast_events(&nodes, 0, 1);
2545
2546         assert_eq!(nodes[0].node.list_channels().len(), 0);
2547         assert_eq!(nodes[1].node.list_channels().len(), 0);
2548
2549         // We test justice_tx build by A on B's revoked HTLC-Success tx
2550         // Create some new channels:
2551         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2552         {
2553                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2554                 node_txn.clear();
2555         }
2556
2557         // A pending HTLC which will be revoked:
2558         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2559         // Get the will-be-revoked local txn from B
2560         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2561         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2562         assert_eq!(revoked_local_txn[0].input.len(), 1);
2563         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2564         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2565         // Revoke the old state
2566         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2567         {
2568                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2569                 {
2570                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2571                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2572                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2573
2574                         check_spends!(node_txn[0], revoked_local_txn[0]);
2575                         node_txn.swap_remove(0);
2576                 }
2577                 check_added_monitors!(nodes[0], 1);
2578                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2579
2580                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2581                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2582                 check_added_monitors!(nodes[1], 1);
2583                 mine_transaction(&nodes[0], &node_txn[1]);
2584                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2585         }
2586         get_announce_close_broadcast_events(&nodes, 0, 1);
2587         assert_eq!(nodes[0].node.list_channels().len(), 0);
2588         assert_eq!(nodes[1].node.list_channels().len(), 0);
2589 }
2590
2591 #[test]
2592 fn revoked_output_claim() {
2593         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2594         // transaction is broadcast by its counterparty
2595         let chanmon_cfgs = create_chanmon_cfgs(2);
2596         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2597         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2598         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2599         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2600         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2601         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2602         assert_eq!(revoked_local_txn.len(), 1);
2603         // Only output is the full channel value back to nodes[0]:
2604         assert_eq!(revoked_local_txn[0].output.len(), 1);
2605         // Send a payment through, updating everyone's latest commitment txn
2606         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2607
2608         // Inform nodes[1] that nodes[0] broadcast a stale tx
2609         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2610         check_added_monitors!(nodes[1], 1);
2611         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2612         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2613
2614         check_spends!(node_txn[0], revoked_local_txn[0]);
2615         check_spends!(node_txn[1], chan_1.3);
2616
2617         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2618         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2619         get_announce_close_broadcast_events(&nodes, 0, 1);
2620         check_added_monitors!(nodes[0], 1)
2621 }
2622
2623 #[test]
2624 fn claim_htlc_outputs_shared_tx() {
2625         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2626         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2627         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2628         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2629         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2630         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2631
2632         // Create some new channel:
2633         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2634
2635         // Rebalance the network to generate htlc in the two directions
2636         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2637         // 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
2638         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2639         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2640
2641         // Get the will-be-revoked local txn from node[0]
2642         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2643         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2644         assert_eq!(revoked_local_txn[0].input.len(), 1);
2645         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2646         assert_eq!(revoked_local_txn[1].input.len(), 1);
2647         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2648         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2649         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2650
2651         //Revoke the old state
2652         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2653
2654         {
2655                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2656                 check_added_monitors!(nodes[0], 1);
2657                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2658                 check_added_monitors!(nodes[1], 1);
2659                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2660                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2661
2662                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2663                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2664
2665                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2666                 check_spends!(node_txn[0], revoked_local_txn[0]);
2667
2668                 let mut witness_lens = BTreeSet::new();
2669                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2670                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2671                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2672                 assert_eq!(witness_lens.len(), 3);
2673                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2674                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2675                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2676
2677                 // Next nodes[1] broadcasts its current local tx state:
2678                 assert_eq!(node_txn[1].input.len(), 1);
2679                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2680         }
2681         get_announce_close_broadcast_events(&nodes, 0, 1);
2682         assert_eq!(nodes[0].node.list_channels().len(), 0);
2683         assert_eq!(nodes[1].node.list_channels().len(), 0);
2684 }
2685
2686 #[test]
2687 fn claim_htlc_outputs_single_tx() {
2688         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2689         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2690         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2691         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2692         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2693         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2694
2695         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2696
2697         // Rebalance the network to generate htlc in the two directions
2698         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2699         // 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
2700         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2701         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2702         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2703
2704         // Get the will-be-revoked local txn from node[0]
2705         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2706
2707         //Revoke the old state
2708         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2709
2710         {
2711                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2712                 check_added_monitors!(nodes[0], 1);
2713                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2714                 check_added_monitors!(nodes[1], 1);
2715                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2716
2717                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2718                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2719
2720                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2721                 assert_eq!(node_txn.len(), 9);
2722                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2723                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2724                 // 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)
2725                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2726
2727                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2728                 assert_eq!(node_txn[0].input.len(), 1);
2729                 check_spends!(node_txn[0], chan_1.3);
2730                 assert_eq!(node_txn[1].input.len(), 1);
2731                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2732                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2733                 check_spends!(node_txn[1], node_txn[0]);
2734
2735                 // Justice transactions are indices 1-2-4
2736                 assert_eq!(node_txn[2].input.len(), 1);
2737                 assert_eq!(node_txn[3].input.len(), 1);
2738                 assert_eq!(node_txn[4].input.len(), 1);
2739
2740                 check_spends!(node_txn[2], revoked_local_txn[0]);
2741                 check_spends!(node_txn[3], revoked_local_txn[0]);
2742                 check_spends!(node_txn[4], revoked_local_txn[0]);
2743
2744                 let mut witness_lens = BTreeSet::new();
2745                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2746                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2747                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2748                 assert_eq!(witness_lens.len(), 3);
2749                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2750                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2751                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2752         }
2753         get_announce_close_broadcast_events(&nodes, 0, 1);
2754         assert_eq!(nodes[0].node.list_channels().len(), 0);
2755         assert_eq!(nodes[1].node.list_channels().len(), 0);
2756 }
2757
2758 #[test]
2759 fn test_htlc_on_chain_success() {
2760         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2761         // the preimage backward accordingly. So here we test that ChannelManager is
2762         // broadcasting the right event to other nodes in payment path.
2763         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2764         // A --------------------> B ----------------------> C (preimage)
2765         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2766         // commitment transaction was broadcast.
2767         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2768         // towards B.
2769         // B should be able to claim via preimage if A then broadcasts its local tx.
2770         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2771         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2772         // PaymentSent event).
2773
2774         let chanmon_cfgs = create_chanmon_cfgs(3);
2775         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2776         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2777         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2778
2779         // Create some initial channels
2780         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2781         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2782
2783         // Ensure all nodes are at the same height
2784         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2785         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2786         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2787         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2788
2789         // Rebalance the network a bit by relaying one payment through all the channels...
2790         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2791         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2792
2793         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2794         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2795
2796         // Broadcast legit commitment tx from C on B's chain
2797         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2798         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2799         assert_eq!(commitment_tx.len(), 1);
2800         check_spends!(commitment_tx[0], chan_2.3);
2801         nodes[2].node.claim_funds(our_payment_preimage);
2802         nodes[2].node.claim_funds(our_payment_preimage_2);
2803         check_added_monitors!(nodes[2], 2);
2804         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2805         assert!(updates.update_add_htlcs.is_empty());
2806         assert!(updates.update_fail_htlcs.is_empty());
2807         assert!(updates.update_fail_malformed_htlcs.is_empty());
2808         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2809
2810         mine_transaction(&nodes[2], &commitment_tx[0]);
2811         check_closed_broadcast!(nodes[2], true);
2812         check_added_monitors!(nodes[2], 1);
2813         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)
2814         assert_eq!(node_txn.len(), 5);
2815         assert_eq!(node_txn[0], node_txn[3]);
2816         assert_eq!(node_txn[1], node_txn[4]);
2817         assert_eq!(node_txn[2], commitment_tx[0]);
2818         check_spends!(node_txn[0], commitment_tx[0]);
2819         check_spends!(node_txn[1], commitment_tx[0]);
2820         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2821         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2822         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2823         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2824         assert_eq!(node_txn[0].lock_time, 0);
2825         assert_eq!(node_txn[1].lock_time, 0);
2826
2827         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2828         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2829         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2830         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2831         {
2832                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2833                 assert_eq!(added_monitors.len(), 1);
2834                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2835                 added_monitors.clear();
2836         }
2837         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2838         assert_eq!(forwarded_events.len(), 2);
2839         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2840                 } else { panic!(); }
2841         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2842                 } else { panic!(); }
2843         let events = nodes[1].node.get_and_clear_pending_msg_events();
2844         {
2845                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2846                 assert_eq!(added_monitors.len(), 2);
2847                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2848                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2849                 added_monitors.clear();
2850         }
2851         assert_eq!(events.len(), 3);
2852         match events[0] {
2853                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2854                 _ => panic!("Unexpected event"),
2855         }
2856         match events[1] {
2857                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2858                 _ => panic!("Unexpected event"),
2859         }
2860
2861         match events[2] {
2862                 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, .. } } => {
2863                         assert!(update_add_htlcs.is_empty());
2864                         assert!(update_fail_htlcs.is_empty());
2865                         assert_eq!(update_fulfill_htlcs.len(), 1);
2866                         assert!(update_fail_malformed_htlcs.is_empty());
2867                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2868                 },
2869                 _ => panic!("Unexpected event"),
2870         };
2871         macro_rules! check_tx_local_broadcast {
2872                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2873                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2874                         assert_eq!(node_txn.len(), 3);
2875                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2876                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2877                         check_spends!(node_txn[1], $commitment_tx);
2878                         check_spends!(node_txn[2], $commitment_tx);
2879                         assert_ne!(node_txn[1].lock_time, 0);
2880                         assert_ne!(node_txn[2].lock_time, 0);
2881                         if $htlc_offered {
2882                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2883                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2884                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2885                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2886                         } else {
2887                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2888                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2889                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2890                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2891                         }
2892                         check_spends!(node_txn[0], $chan_tx);
2893                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2894                         node_txn.clear();
2895                 } }
2896         }
2897         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2898         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2899         // timeout-claim of the output that nodes[2] just claimed via success.
2900         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2901
2902         // Broadcast legit commitment tx from A on B's chain
2903         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2904         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2905         check_spends!(node_a_commitment_tx[0], chan_1.3);
2906         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2907         check_closed_broadcast!(nodes[1], true);
2908         check_added_monitors!(nodes[1], 1);
2909         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2910         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2911         let commitment_spend =
2912                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2913                         check_spends!(node_txn[1], commitment_tx[0]);
2914                         check_spends!(node_txn[2], commitment_tx[0]);
2915                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2916                         &node_txn[0]
2917                 } else {
2918                         check_spends!(node_txn[0], commitment_tx[0]);
2919                         check_spends!(node_txn[1], commitment_tx[0]);
2920                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2921                         &node_txn[2]
2922                 };
2923
2924         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2925         assert_eq!(commitment_spend.input.len(), 2);
2926         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2927         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2928         assert_eq!(commitment_spend.lock_time, 0);
2929         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2930         check_spends!(node_txn[3], chan_1.3);
2931         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2932         check_spends!(node_txn[4], node_txn[3]);
2933         check_spends!(node_txn[5], node_txn[3]);
2934         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2935         // we already checked the same situation with A.
2936
2937         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2938         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2939         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2940         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2941         check_closed_broadcast!(nodes[0], true);
2942         check_added_monitors!(nodes[0], 1);
2943         let events = nodes[0].node.get_and_clear_pending_events();
2944         assert_eq!(events.len(), 2);
2945         let mut first_claimed = false;
2946         for event in events {
2947                 match event {
2948                         Event::PaymentSent { payment_preimage } => {
2949                                 if payment_preimage == our_payment_preimage {
2950                                         assert!(!first_claimed);
2951                                         first_claimed = true;
2952                                 } else {
2953                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2954                                 }
2955                         },
2956                         _ => panic!("Unexpected event"),
2957                 }
2958         }
2959         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2960 }
2961
2962 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2963         // Test that in case of a unilateral close onchain, we detect the state of output and
2964         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2965         // broadcasting the right event to other nodes in payment path.
2966         // A ------------------> B ----------------------> C (timeout)
2967         //    B's commitment tx                 C's commitment tx
2968         //            \                                  \
2969         //         B's HTLC timeout tx               B's timeout tx
2970
2971         let chanmon_cfgs = create_chanmon_cfgs(3);
2972         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2973         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2974         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2975         *nodes[0].connect_style.borrow_mut() = connect_style;
2976         *nodes[1].connect_style.borrow_mut() = connect_style;
2977         *nodes[2].connect_style.borrow_mut() = connect_style;
2978
2979         // Create some intial channels
2980         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2981         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2982
2983         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2984         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2985         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2986
2987         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2988
2989         // Broadcast legit commitment tx from C on B's chain
2990         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2991         check_spends!(commitment_tx[0], chan_2.3);
2992         nodes[2].node.fail_htlc_backwards(&payment_hash);
2993         check_added_monitors!(nodes[2], 0);
2994         expect_pending_htlcs_forwardable!(nodes[2]);
2995         check_added_monitors!(nodes[2], 1);
2996
2997         let events = nodes[2].node.get_and_clear_pending_msg_events();
2998         assert_eq!(events.len(), 1);
2999         match events[0] {
3000                 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, .. } } => {
3001                         assert!(update_add_htlcs.is_empty());
3002                         assert!(!update_fail_htlcs.is_empty());
3003                         assert!(update_fulfill_htlcs.is_empty());
3004                         assert!(update_fail_malformed_htlcs.is_empty());
3005                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
3006                 },
3007                 _ => panic!("Unexpected event"),
3008         };
3009         mine_transaction(&nodes[2], &commitment_tx[0]);
3010         check_closed_broadcast!(nodes[2], true);
3011         check_added_monitors!(nodes[2], 1);
3012         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
3013         assert_eq!(node_txn.len(), 1);
3014         check_spends!(node_txn[0], chan_2.3);
3015         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
3016
3017         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3018         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3019         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3020         mine_transaction(&nodes[1], &commitment_tx[0]);
3021         let timeout_tx;
3022         {
3023                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3024                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3025                 assert_eq!(node_txn[0], node_txn[3]);
3026                 assert_eq!(node_txn[1], node_txn[4]);
3027
3028                 check_spends!(node_txn[2], commitment_tx[0]);
3029                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3030
3031                 check_spends!(node_txn[0], chan_2.3);
3032                 check_spends!(node_txn[1], node_txn[0]);
3033                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3034                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3035
3036                 timeout_tx = node_txn[2].clone();
3037                 node_txn.clear();
3038         }
3039
3040         mine_transaction(&nodes[1], &timeout_tx);
3041         check_added_monitors!(nodes[1], 1);
3042         check_closed_broadcast!(nodes[1], true);
3043         {
3044                 // B will rebroadcast a fee-bumped timeout transaction here.
3045                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3046                 assert_eq!(node_txn.len(), 1);
3047                 check_spends!(node_txn[0], commitment_tx[0]);
3048         }
3049
3050         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3051         {
3052                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3053                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3054                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3055                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3056                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3057                 if node_txn.len() == 1 {
3058                         check_spends!(node_txn[0], chan_2.3);
3059                 } else {
3060                         assert_eq!(node_txn.len(), 0);
3061                 }
3062         }
3063
3064         expect_pending_htlcs_forwardable!(nodes[1]);
3065         check_added_monitors!(nodes[1], 1);
3066         let events = nodes[1].node.get_and_clear_pending_msg_events();
3067         assert_eq!(events.len(), 1);
3068         match events[0] {
3069                 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, .. } } => {
3070                         assert!(update_add_htlcs.is_empty());
3071                         assert!(!update_fail_htlcs.is_empty());
3072                         assert!(update_fulfill_htlcs.is_empty());
3073                         assert!(update_fail_malformed_htlcs.is_empty());
3074                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3075                 },
3076                 _ => panic!("Unexpected event"),
3077         };
3078
3079         // Broadcast legit commitment tx from B on A's chain
3080         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3081         check_spends!(commitment_tx[0], chan_1.3);
3082
3083         mine_transaction(&nodes[0], &commitment_tx[0]);
3084         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3085
3086         check_closed_broadcast!(nodes[0], true);
3087         check_added_monitors!(nodes[0], 1);
3088         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3089         assert_eq!(node_txn.len(), 2);
3090         check_spends!(node_txn[0], chan_1.3);
3091         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3092         check_spends!(node_txn[1], commitment_tx[0]);
3093         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3094 }
3095
3096 #[test]
3097 fn test_htlc_on_chain_timeout() {
3098         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3099         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3100         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3101 }
3102
3103 #[test]
3104 fn test_simple_commitment_revoked_fail_backward() {
3105         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3106         // and fail backward accordingly.
3107
3108         let chanmon_cfgs = create_chanmon_cfgs(3);
3109         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3110         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3111         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3112
3113         // Create some initial channels
3114         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3115         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3116
3117         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3118         // Get the will-be-revoked local txn from nodes[2]
3119         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3120         // Revoke the old state
3121         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3122
3123         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3124
3125         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3126         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3127         check_added_monitors!(nodes[1], 1);
3128         check_closed_broadcast!(nodes[1], true);
3129
3130         expect_pending_htlcs_forwardable!(nodes[1]);
3131         check_added_monitors!(nodes[1], 1);
3132         let events = nodes[1].node.get_and_clear_pending_msg_events();
3133         assert_eq!(events.len(), 1);
3134         match events[0] {
3135                 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, .. } } => {
3136                         assert!(update_add_htlcs.is_empty());
3137                         assert_eq!(update_fail_htlcs.len(), 1);
3138                         assert!(update_fulfill_htlcs.is_empty());
3139                         assert!(update_fail_malformed_htlcs.is_empty());
3140                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3141
3142                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3143                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3144                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3145                         expect_payment_failed!(nodes[0], payment_hash, false);
3146                 },
3147                 _ => panic!("Unexpected event"),
3148         }
3149 }
3150
3151 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3152         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3153         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3154         // commitment transaction anymore.
3155         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3156         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3157         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3158         // technically disallowed and we should probably handle it reasonably.
3159         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3160         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3161         // transactions:
3162         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3163         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3164         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3165         //   and once they revoke the previous commitment transaction (allowing us to send a new
3166         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3167         let chanmon_cfgs = create_chanmon_cfgs(3);
3168         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3169         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3170         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3171
3172         // Create some initial channels
3173         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3174         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3175
3176         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 });
3177         // Get the will-be-revoked local txn from nodes[2]
3178         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3179         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3180         // Revoke the old state
3181         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3182
3183         let value = if use_dust {
3184                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3185                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3186                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3187         } else { 3000000 };
3188
3189         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3190         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3191         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3192
3193         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3194         expect_pending_htlcs_forwardable!(nodes[2]);
3195         check_added_monitors!(nodes[2], 1);
3196         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3197         assert!(updates.update_add_htlcs.is_empty());
3198         assert!(updates.update_fulfill_htlcs.is_empty());
3199         assert!(updates.update_fail_malformed_htlcs.is_empty());
3200         assert_eq!(updates.update_fail_htlcs.len(), 1);
3201         assert!(updates.update_fee.is_none());
3202         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3203         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3204         // Drop the last RAA from 3 -> 2
3205
3206         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3207         expect_pending_htlcs_forwardable!(nodes[2]);
3208         check_added_monitors!(nodes[2], 1);
3209         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3210         assert!(updates.update_add_htlcs.is_empty());
3211         assert!(updates.update_fulfill_htlcs.is_empty());
3212         assert!(updates.update_fail_malformed_htlcs.is_empty());
3213         assert_eq!(updates.update_fail_htlcs.len(), 1);
3214         assert!(updates.update_fee.is_none());
3215         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3216         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3217         check_added_monitors!(nodes[1], 1);
3218         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3219         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3220         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3221         check_added_monitors!(nodes[2], 1);
3222
3223         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3224         expect_pending_htlcs_forwardable!(nodes[2]);
3225         check_added_monitors!(nodes[2], 1);
3226         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3227         assert!(updates.update_add_htlcs.is_empty());
3228         assert!(updates.update_fulfill_htlcs.is_empty());
3229         assert!(updates.update_fail_malformed_htlcs.is_empty());
3230         assert_eq!(updates.update_fail_htlcs.len(), 1);
3231         assert!(updates.update_fee.is_none());
3232         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3233         // At this point first_payment_hash has dropped out of the latest two commitment
3234         // transactions that nodes[1] is tracking...
3235         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3236         check_added_monitors!(nodes[1], 1);
3237         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3238         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3239         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3240         check_added_monitors!(nodes[2], 1);
3241
3242         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3243         // on nodes[2]'s RAA.
3244         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3245         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3246         let logger = test_utils::TestLogger::new();
3247         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();
3248         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3249         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3250         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3251         check_added_monitors!(nodes[1], 0);
3252
3253         if deliver_bs_raa {
3254                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3255                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3256                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3257                 check_added_monitors!(nodes[1], 1);
3258                 let events = nodes[1].node.get_and_clear_pending_events();
3259                 assert_eq!(events.len(), 1);
3260                 match events[0] {
3261                         Event::PendingHTLCsForwardable { .. } => { },
3262                         _ => panic!("Unexpected event"),
3263                 };
3264                 // Deliberately don't process the pending fail-back so they all fail back at once after
3265                 // block connection just like the !deliver_bs_raa case
3266         }
3267
3268         let mut failed_htlcs = HashSet::new();
3269         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3270
3271         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3272         check_added_monitors!(nodes[1], 1);
3273         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3274
3275         let events = nodes[1].node.get_and_clear_pending_events();
3276         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3277         match events[0] {
3278                 Event::PaymentFailed { ref payment_hash, .. } => {
3279                         assert_eq!(*payment_hash, fourth_payment_hash);
3280                 },
3281                 _ => panic!("Unexpected event"),
3282         }
3283         if !deliver_bs_raa {
3284                 match events[1] {
3285                         Event::PendingHTLCsForwardable { .. } => { },
3286                         _ => panic!("Unexpected event"),
3287                 };
3288         }
3289         nodes[1].node.process_pending_htlc_forwards();
3290         check_added_monitors!(nodes[1], 1);
3291
3292         let events = nodes[1].node.get_and_clear_pending_msg_events();
3293         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3294         match events[if deliver_bs_raa { 1 } else { 0 }] {
3295                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3296                 _ => panic!("Unexpected event"),
3297         }
3298         match events[if deliver_bs_raa { 2 } else { 1 }] {
3299                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3300                         assert_eq!(channel_id, chan_2.2);
3301                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3302                 },
3303                 _ => panic!("Unexpected event"),
3304         }
3305         if deliver_bs_raa {
3306                 match events[0] {
3307                         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, .. } } => {
3308                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3309                                 assert_eq!(update_add_htlcs.len(), 1);
3310                                 assert!(update_fulfill_htlcs.is_empty());
3311                                 assert!(update_fail_htlcs.is_empty());
3312                                 assert!(update_fail_malformed_htlcs.is_empty());
3313                         },
3314                         _ => panic!("Unexpected event"),
3315                 }
3316         }
3317         match events[if deliver_bs_raa { 3 } else { 2 }] {
3318                 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, .. } } => {
3319                         assert!(update_add_htlcs.is_empty());
3320                         assert_eq!(update_fail_htlcs.len(), 3);
3321                         assert!(update_fulfill_htlcs.is_empty());
3322                         assert!(update_fail_malformed_htlcs.is_empty());
3323                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3324
3325                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3326                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3327                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3328
3329                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3330
3331                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3332                         // If we delivered B's RAA we got an unknown preimage error, not something
3333                         // that we should update our routing table for.
3334                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3335                         for event in events {
3336                                 match event {
3337                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3338                                         _ => panic!("Unexpected event"),
3339                                 }
3340                         }
3341                         let events = nodes[0].node.get_and_clear_pending_events();
3342                         assert_eq!(events.len(), 3);
3343                         match events[0] {
3344                                 Event::PaymentFailed { ref payment_hash, .. } => {
3345                                         assert!(failed_htlcs.insert(payment_hash.0));
3346                                 },
3347                                 _ => panic!("Unexpected event"),
3348                         }
3349                         match events[1] {
3350                                 Event::PaymentFailed { ref payment_hash, .. } => {
3351                                         assert!(failed_htlcs.insert(payment_hash.0));
3352                                 },
3353                                 _ => panic!("Unexpected event"),
3354                         }
3355                         match events[2] {
3356                                 Event::PaymentFailed { ref payment_hash, .. } => {
3357                                         assert!(failed_htlcs.insert(payment_hash.0));
3358                                 },
3359                                 _ => panic!("Unexpected event"),
3360                         }
3361                 },
3362                 _ => panic!("Unexpected event"),
3363         }
3364
3365         assert!(failed_htlcs.contains(&first_payment_hash.0));
3366         assert!(failed_htlcs.contains(&second_payment_hash.0));
3367         assert!(failed_htlcs.contains(&third_payment_hash.0));
3368 }
3369
3370 #[test]
3371 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3372         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3373         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3374         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3375         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3376 }
3377
3378 #[test]
3379 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3380         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3381         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3382         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3383         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3384 }
3385
3386 #[test]
3387 fn fail_backward_pending_htlc_upon_channel_failure() {
3388         let chanmon_cfgs = create_chanmon_cfgs(2);
3389         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3390         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3391         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3392         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3393         let logger = test_utils::TestLogger::new();
3394
3395         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3396         {
3397                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3398                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3399                 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();
3400                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3401                 check_added_monitors!(nodes[0], 1);
3402
3403                 let payment_event = {
3404                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3405                         assert_eq!(events.len(), 1);
3406                         SendEvent::from_event(events.remove(0))
3407                 };
3408                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3409                 assert_eq!(payment_event.msgs.len(), 1);
3410         }
3411
3412         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3413         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3414         {
3415                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3416                 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();
3417                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3418                 check_added_monitors!(nodes[0], 0);
3419
3420                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3421         }
3422
3423         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3424         {
3425                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3426
3427                 let secp_ctx = Secp256k1::new();
3428                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3429                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3430                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3431                 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();
3432                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3433                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3434                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3435
3436                 // Send a 0-msat update_add_htlc to fail the channel.
3437                 let update_add_htlc = msgs::UpdateAddHTLC {
3438                         channel_id: chan.2,
3439                         htlc_id: 0,
3440                         amount_msat: 0,
3441                         payment_hash,
3442                         cltv_expiry,
3443                         onion_routing_packet,
3444                 };
3445                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3446         }
3447
3448         // Check that Alice fails backward the pending HTLC from the second payment.
3449         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3450         check_closed_broadcast!(nodes[0], true);
3451         check_added_monitors!(nodes[0], 1);
3452 }
3453
3454 #[test]
3455 fn test_htlc_ignore_latest_remote_commitment() {
3456         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3457         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3458         let chanmon_cfgs = create_chanmon_cfgs(2);
3459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3461         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3462         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3463
3464         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3465         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3466         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3467         check_closed_broadcast!(nodes[0], true);
3468         check_added_monitors!(nodes[0], 1);
3469
3470         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3471         assert_eq!(node_txn.len(), 3);
3472         assert_eq!(node_txn[0], node_txn[1]);
3473
3474         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3475         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3476         check_closed_broadcast!(nodes[1], true);
3477         check_added_monitors!(nodes[1], 1);
3478
3479         // Duplicate the connect_block call since this may happen due to other listeners
3480         // registering new transactions
3481         header.prev_blockhash = header.block_hash();
3482         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3483 }
3484
3485 #[test]
3486 fn test_force_close_fail_back() {
3487         // Check which HTLCs are failed-backwards on channel force-closure
3488         let chanmon_cfgs = create_chanmon_cfgs(3);
3489         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3490         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3491         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3492         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3493         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3494         let logger = test_utils::TestLogger::new();
3495
3496         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3497
3498         let mut payment_event = {
3499                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3500                 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();
3501                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3502                 check_added_monitors!(nodes[0], 1);
3503
3504                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3505                 assert_eq!(events.len(), 1);
3506                 SendEvent::from_event(events.remove(0))
3507         };
3508
3509         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3510         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3511
3512         expect_pending_htlcs_forwardable!(nodes[1]);
3513
3514         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3515         assert_eq!(events_2.len(), 1);
3516         payment_event = SendEvent::from_event(events_2.remove(0));
3517         assert_eq!(payment_event.msgs.len(), 1);
3518
3519         check_added_monitors!(nodes[1], 1);
3520         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3521         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3522         check_added_monitors!(nodes[2], 1);
3523         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3524
3525         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3526         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3527         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3528
3529         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3530         check_closed_broadcast!(nodes[2], true);
3531         check_added_monitors!(nodes[2], 1);
3532         let tx = {
3533                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3534                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3535                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3536                 // back to nodes[1] upon timeout otherwise.
3537                 assert_eq!(node_txn.len(), 1);
3538                 node_txn.remove(0)
3539         };
3540
3541         mine_transaction(&nodes[1], &tx);
3542
3543         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3544         check_closed_broadcast!(nodes[1], true);
3545         check_added_monitors!(nodes[1], 1);
3546
3547         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3548         {
3549                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3550                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3551                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3552         }
3553         mine_transaction(&nodes[2], &tx);
3554         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3555         assert_eq!(node_txn.len(), 1);
3556         assert_eq!(node_txn[0].input.len(), 1);
3557         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3558         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3559         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3560
3561         check_spends!(node_txn[0], tx);
3562 }
3563
3564 #[test]
3565 fn test_dup_events_on_peer_disconnect() {
3566         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3567         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3568         // as we used to generate the event immediately upon receipt of the payment preimage in the
3569         // update_fulfill_htlc message.
3570
3571         let chanmon_cfgs = create_chanmon_cfgs(2);
3572         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3573         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3574         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3575         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3576
3577         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3578
3579         assert!(nodes[1].node.claim_funds(payment_preimage));
3580         check_added_monitors!(nodes[1], 1);
3581         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3582         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3583         expect_payment_sent!(nodes[0], payment_preimage);
3584
3585         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3586         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3587
3588         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3589         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3590 }
3591
3592 #[test]
3593 fn test_simple_peer_disconnect() {
3594         // Test that we can reconnect when there are no lost messages
3595         let chanmon_cfgs = create_chanmon_cfgs(3);
3596         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3597         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3598         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3599         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3600         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3601
3602         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3603         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3604         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3605
3606         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3607         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3608         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3609         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3610
3611         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3612         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3613         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3614
3615         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3616         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3617         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3618         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3619
3620         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3621         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3622
3623         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3624         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3625
3626         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3627         {
3628                 let events = nodes[0].node.get_and_clear_pending_events();
3629                 assert_eq!(events.len(), 2);
3630                 match events[0] {
3631                         Event::PaymentSent { payment_preimage } => {
3632                                 assert_eq!(payment_preimage, payment_preimage_3);
3633                         },
3634                         _ => panic!("Unexpected event"),
3635                 }
3636                 match events[1] {
3637                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3638                                 assert_eq!(payment_hash, payment_hash_5);
3639                                 assert!(rejected_by_dest);
3640                         },
3641                         _ => panic!("Unexpected event"),
3642                 }
3643         }
3644
3645         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3646         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3647 }
3648
3649 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3650         // Test that we can reconnect when in-flight HTLC updates get dropped
3651         let chanmon_cfgs = create_chanmon_cfgs(2);
3652         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3653         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3654         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3655
3656         let mut as_funding_locked = None;
3657         if messages_delivered == 0 {
3658                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3659                 as_funding_locked = Some(funding_locked);
3660                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3661                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3662                 // it before the channel_reestablish message.
3663         } else {
3664                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3665         }
3666
3667         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3668
3669         let logger = test_utils::TestLogger::new();
3670         let payment_event = {
3671                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3672                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3673                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3674                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3675                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3676                 check_added_monitors!(nodes[0], 1);
3677
3678                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3679                 assert_eq!(events.len(), 1);
3680                 SendEvent::from_event(events.remove(0))
3681         };
3682         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3683
3684         if messages_delivered < 2 {
3685                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3686         } else {
3687                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3688                 if messages_delivered >= 3 {
3689                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3690                         check_added_monitors!(nodes[1], 1);
3691                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3692
3693                         if messages_delivered >= 4 {
3694                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3695                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3696                                 check_added_monitors!(nodes[0], 1);
3697
3698                                 if messages_delivered >= 5 {
3699                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3700                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3701                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3702                                         check_added_monitors!(nodes[0], 1);
3703
3704                                         if messages_delivered >= 6 {
3705                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3706                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3707                                                 check_added_monitors!(nodes[1], 1);
3708                                         }
3709                                 }
3710                         }
3711                 }
3712         }
3713
3714         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3715         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3716         if messages_delivered < 3 {
3717                 if simulate_broken_lnd {
3718                         // lnd has a long-standing bug where they send a funding_locked prior to a
3719                         // channel_reestablish if you reconnect prior to funding_locked time.
3720                         //
3721                         // Here we simulate that behavior, delivering a funding_locked immediately on
3722                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3723                         // in `reconnect_nodes` but we currently don't fail based on that.
3724                         //
3725                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3726                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3727                 }
3728                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3729                 // received on either side, both sides will need to resend them.
3730                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3731         } else if messages_delivered == 3 {
3732                 // nodes[0] still wants its RAA + commitment_signed
3733                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3734         } else if messages_delivered == 4 {
3735                 // nodes[0] still wants its commitment_signed
3736                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3737         } else if messages_delivered == 5 {
3738                 // nodes[1] still wants its final RAA
3739                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3740         } else if messages_delivered == 6 {
3741                 // Everything was delivered...
3742                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3743         }
3744
3745         let events_1 = nodes[1].node.get_and_clear_pending_events();
3746         assert_eq!(events_1.len(), 1);
3747         match events_1[0] {
3748                 Event::PendingHTLCsForwardable { .. } => { },
3749                 _ => panic!("Unexpected event"),
3750         };
3751
3752         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3753         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3754         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3755
3756         nodes[1].node.process_pending_htlc_forwards();
3757
3758         let events_2 = nodes[1].node.get_and_clear_pending_events();
3759         assert_eq!(events_2.len(), 1);
3760         match events_2[0] {
3761                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3762                         assert_eq!(payment_hash_1, *payment_hash);
3763                         assert_eq!(amt, 1000000);
3764                         match &purpose {
3765                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3766                                         assert!(payment_preimage.is_none());
3767                                         assert_eq!(payment_secret_1, *payment_secret);
3768                                 },
3769                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3770                         }
3771                 },
3772                 _ => panic!("Unexpected event"),
3773         }
3774
3775         nodes[1].node.claim_funds(payment_preimage_1);
3776         check_added_monitors!(nodes[1], 1);
3777
3778         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3779         assert_eq!(events_3.len(), 1);
3780         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3781                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3782                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3783                         assert!(updates.update_add_htlcs.is_empty());
3784                         assert!(updates.update_fail_htlcs.is_empty());
3785                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3786                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3787                         assert!(updates.update_fee.is_none());
3788                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3789                 },
3790                 _ => panic!("Unexpected event"),
3791         };
3792
3793         if messages_delivered >= 1 {
3794                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3795
3796                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3797                 assert_eq!(events_4.len(), 1);
3798                 match events_4[0] {
3799                         Event::PaymentSent { ref payment_preimage } => {
3800                                 assert_eq!(payment_preimage_1, *payment_preimage);
3801                         },
3802                         _ => panic!("Unexpected event"),
3803                 }
3804
3805                 if messages_delivered >= 2 {
3806                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3807                         check_added_monitors!(nodes[0], 1);
3808                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3809
3810                         if messages_delivered >= 3 {
3811                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3812                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3813                                 check_added_monitors!(nodes[1], 1);
3814
3815                                 if messages_delivered >= 4 {
3816                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3817                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3818                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3819                                         check_added_monitors!(nodes[1], 1);
3820
3821                                         if messages_delivered >= 5 {
3822                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3823                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3824                                                 check_added_monitors!(nodes[0], 1);
3825                                         }
3826                                 }
3827                         }
3828                 }
3829         }
3830
3831         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3832         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3833         if messages_delivered < 2 {
3834                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3835                 if messages_delivered < 1 {
3836                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3837                         assert_eq!(events_4.len(), 1);
3838                         match events_4[0] {
3839                                 Event::PaymentSent { ref payment_preimage } => {
3840                                         assert_eq!(payment_preimage_1, *payment_preimage);
3841                                 },
3842                                 _ => panic!("Unexpected event"),
3843                         }
3844                 } else {
3845                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3846                 }
3847         } else if messages_delivered == 2 {
3848                 // nodes[0] still wants its RAA + commitment_signed
3849                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3850         } else if messages_delivered == 3 {
3851                 // nodes[0] still wants its commitment_signed
3852                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3853         } else if messages_delivered == 4 {
3854                 // nodes[1] still wants its final RAA
3855                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3856         } else if messages_delivered == 5 {
3857                 // Everything was delivered...
3858                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3859         }
3860
3861         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3862         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3863         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3864
3865         // Channel should still work fine...
3866         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3867         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3868                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3869                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3870         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3871         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3872 }
3873
3874 #[test]
3875 fn test_drop_messages_peer_disconnect_a() {
3876         do_test_drop_messages_peer_disconnect(0, true);
3877         do_test_drop_messages_peer_disconnect(0, false);
3878         do_test_drop_messages_peer_disconnect(1, false);
3879         do_test_drop_messages_peer_disconnect(2, false);
3880 }
3881
3882 #[test]
3883 fn test_drop_messages_peer_disconnect_b() {
3884         do_test_drop_messages_peer_disconnect(3, false);
3885         do_test_drop_messages_peer_disconnect(4, false);
3886         do_test_drop_messages_peer_disconnect(5, false);
3887         do_test_drop_messages_peer_disconnect(6, false);
3888 }
3889
3890 #[test]
3891 fn test_funding_peer_disconnect() {
3892         // Test that we can lock in our funding tx while disconnected
3893         let chanmon_cfgs = create_chanmon_cfgs(2);
3894         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3895         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3896         let persister: test_utils::TestPersister;
3897         let new_chain_monitor: test_utils::TestChainMonitor;
3898         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3899         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3900         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3901
3902         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3903         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3904
3905         confirm_transaction(&nodes[0], &tx);
3906         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3907         assert_eq!(events_1.len(), 1);
3908         match events_1[0] {
3909                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3910                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3911                 },
3912                 _ => panic!("Unexpected event"),
3913         }
3914
3915         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3916
3917         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3918         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3919
3920         confirm_transaction(&nodes[1], &tx);
3921         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3922         assert_eq!(events_2.len(), 2);
3923         let funding_locked = match events_2[0] {
3924                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3925                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3926                         msg.clone()
3927                 },
3928                 _ => panic!("Unexpected event"),
3929         };
3930         let bs_announcement_sigs = match events_2[1] {
3931                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3932                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3933                         msg.clone()
3934                 },
3935                 _ => panic!("Unexpected event"),
3936         };
3937
3938         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3939
3940         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3941         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3942         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3943         assert_eq!(events_3.len(), 2);
3944         let as_announcement_sigs = match events_3[0] {
3945                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3946                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3947                         msg.clone()
3948                 },
3949                 _ => panic!("Unexpected event"),
3950         };
3951         let (as_announcement, as_update) = match events_3[1] {
3952                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3953                         (msg.clone(), update_msg.clone())
3954                 },
3955                 _ => panic!("Unexpected event"),
3956         };
3957
3958         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3959         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3960         assert_eq!(events_4.len(), 1);
3961         let (_, bs_update) = match events_4[0] {
3962                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3963                         (msg.clone(), update_msg.clone())
3964                 },
3965                 _ => panic!("Unexpected event"),
3966         };
3967
3968         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3969         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3970         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3971
3972         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3973         let logger = test_utils::TestLogger::new();
3974         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();
3975         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3976         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3977
3978         // Check that after deserialization and reconnection we can still generate an identical
3979         // channel_announcement from the cached signatures.
3980         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3981
3982         let nodes_0_serialized = nodes[0].node.encode();
3983         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3984         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3985
3986         persister = test_utils::TestPersister::new();
3987         let keys_manager = &chanmon_cfgs[0].keys_manager;
3988         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);
3989         nodes[0].chain_monitor = &new_chain_monitor;
3990         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3991         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3992                 &mut chan_0_monitor_read, keys_manager).unwrap();
3993         assert!(chan_0_monitor_read.is_empty());
3994
3995         let mut nodes_0_read = &nodes_0_serialized[..];
3996         let (_, nodes_0_deserialized_tmp) = {
3997                 let mut channel_monitors = HashMap::new();
3998                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3999                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4000                         default_config: UserConfig::default(),
4001                         keys_manager,
4002                         fee_estimator: node_cfgs[0].fee_estimator,
4003                         chain_monitor: nodes[0].chain_monitor,
4004                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4005                         logger: nodes[0].logger,
4006                         channel_monitors,
4007                 }).unwrap()
4008         };
4009         nodes_0_deserialized = nodes_0_deserialized_tmp;
4010         assert!(nodes_0_read.is_empty());
4011
4012         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4013         nodes[0].node = &nodes_0_deserialized;
4014         check_added_monitors!(nodes[0], 1);
4015
4016         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4017
4018         // as_announcement should be re-generated exactly by broadcast_node_announcement.
4019         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
4020         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
4021         let mut found_announcement = false;
4022         for event in msgs.iter() {
4023                 match event {
4024                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
4025                                 if *msg == as_announcement { found_announcement = true; }
4026                         },
4027                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
4028                         _ => panic!("Unexpected event"),
4029                 }
4030         }
4031         assert!(found_announcement);
4032 }
4033
4034 #[test]
4035 fn test_drop_messages_peer_disconnect_dual_htlc() {
4036         // Test that we can handle reconnecting when both sides of a channel have pending
4037         // commitment_updates when we disconnect.
4038         let chanmon_cfgs = create_chanmon_cfgs(2);
4039         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4040         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4041         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4042         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4043         let logger = test_utils::TestLogger::new();
4044
4045         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4046
4047         // Now try to send a second payment which will fail to send
4048         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4049         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4050         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();
4051         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4052         check_added_monitors!(nodes[0], 1);
4053
4054         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4055         assert_eq!(events_1.len(), 1);
4056         match events_1[0] {
4057                 MessageSendEvent::UpdateHTLCs { .. } => {},
4058                 _ => panic!("Unexpected event"),
4059         }
4060
4061         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4062         check_added_monitors!(nodes[1], 1);
4063
4064         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4065         assert_eq!(events_2.len(), 1);
4066         match events_2[0] {
4067                 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 } } => {
4068                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4069                         assert!(update_add_htlcs.is_empty());
4070                         assert_eq!(update_fulfill_htlcs.len(), 1);
4071                         assert!(update_fail_htlcs.is_empty());
4072                         assert!(update_fail_malformed_htlcs.is_empty());
4073                         assert!(update_fee.is_none());
4074
4075                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4076                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4077                         assert_eq!(events_3.len(), 1);
4078                         match events_3[0] {
4079                                 Event::PaymentSent { ref payment_preimage } => {
4080                                         assert_eq!(*payment_preimage, payment_preimage_1);
4081                                 },
4082                                 _ => panic!("Unexpected event"),
4083                         }
4084
4085                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4086                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4087                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4088                         check_added_monitors!(nodes[0], 1);
4089                 },
4090                 _ => panic!("Unexpected event"),
4091         }
4092
4093         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4094         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4095
4096         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4097         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4098         assert_eq!(reestablish_1.len(), 1);
4099         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4100         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4101         assert_eq!(reestablish_2.len(), 1);
4102
4103         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4104         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4105         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4106         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4107
4108         assert!(as_resp.0.is_none());
4109         assert!(bs_resp.0.is_none());
4110
4111         assert!(bs_resp.1.is_none());
4112         assert!(bs_resp.2.is_none());
4113
4114         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4115
4116         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4117         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4118         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4119         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4120         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4121         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4122         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4123         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4124         // No commitment_signed so get_event_msg's assert(len == 1) passes
4125         check_added_monitors!(nodes[1], 1);
4126
4127         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4128         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4129         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4130         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4131         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4132         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4133         assert!(bs_second_commitment_signed.update_fee.is_none());
4134         check_added_monitors!(nodes[1], 1);
4135
4136         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4137         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4138         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4139         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4140         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4141         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4142         assert!(as_commitment_signed.update_fee.is_none());
4143         check_added_monitors!(nodes[0], 1);
4144
4145         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4146         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4147         // No commitment_signed so get_event_msg's assert(len == 1) passes
4148         check_added_monitors!(nodes[0], 1);
4149
4150         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4151         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4152         // No commitment_signed so get_event_msg's assert(len == 1) passes
4153         check_added_monitors!(nodes[1], 1);
4154
4155         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4156         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4157         check_added_monitors!(nodes[1], 1);
4158
4159         expect_pending_htlcs_forwardable!(nodes[1]);
4160
4161         let events_5 = nodes[1].node.get_and_clear_pending_events();
4162         assert_eq!(events_5.len(), 1);
4163         match events_5[0] {
4164                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
4165                         assert_eq!(payment_hash_2, *payment_hash);
4166                         match &purpose {
4167                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4168                                         assert!(payment_preimage.is_none());
4169                                         assert_eq!(payment_secret_2, *payment_secret);
4170                                 },
4171                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
4172                         }
4173                 },
4174                 _ => panic!("Unexpected event"),
4175         }
4176
4177         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4178         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4179         check_added_monitors!(nodes[0], 1);
4180
4181         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4182 }
4183
4184 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4185         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4186         // to avoid our counterparty failing the channel.
4187         let chanmon_cfgs = create_chanmon_cfgs(2);
4188         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4189         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4190         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4191
4192         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4193         let logger = test_utils::TestLogger::new();
4194
4195         let our_payment_hash = if send_partial_mpp {
4196                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4197                 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();
4198                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4199                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4200                 // indicates there are more HTLCs coming.
4201                 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.
4202                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, &None).unwrap();
4203                 check_added_monitors!(nodes[0], 1);
4204                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4205                 assert_eq!(events.len(), 1);
4206                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4207                 // hop should *not* yet generate any PaymentReceived event(s).
4208                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4209                 our_payment_hash
4210         } else {
4211                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4212         };
4213
4214         let mut block = Block {
4215                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4216                 txdata: vec![],
4217         };
4218         connect_block(&nodes[0], &block);
4219         connect_block(&nodes[1], &block);
4220         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4221         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4222                 block.header.prev_blockhash = block.block_hash();
4223                 connect_block(&nodes[0], &block);
4224                 connect_block(&nodes[1], &block);
4225         }
4226
4227         expect_pending_htlcs_forwardable!(nodes[1]);
4228
4229         check_added_monitors!(nodes[1], 1);
4230         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4231         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4232         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4233         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4234         assert!(htlc_timeout_updates.update_fee.is_none());
4235
4236         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4237         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4238         // 100_000 msat as u64, followed by the height at which we failed back above
4239         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4240         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4241         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4242 }
4243
4244 #[test]
4245 fn test_htlc_timeout() {
4246         do_test_htlc_timeout(true);
4247         do_test_htlc_timeout(false);
4248 }
4249
4250 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4251         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4252         let chanmon_cfgs = create_chanmon_cfgs(3);
4253         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4254         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4255         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4256         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4257         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4258
4259         // Make sure all nodes are at the same starting height
4260         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4261         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4262         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4263
4264         let logger = test_utils::TestLogger::new();
4265
4266         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4267         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4268         {
4269                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4270                 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();
4271                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4272         }
4273         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4274         check_added_monitors!(nodes[1], 1);
4275
4276         // Now attempt to route a second payment, which should be placed in the holding cell
4277         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4278         if forwarded_htlc {
4279                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4280                 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();
4281                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4282                 check_added_monitors!(nodes[0], 1);
4283                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4284                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4285                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4286                 expect_pending_htlcs_forwardable!(nodes[1]);
4287                 check_added_monitors!(nodes[1], 0);
4288         } else {
4289                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4290                 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();
4291                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4292                 check_added_monitors!(nodes[1], 0);
4293         }
4294
4295         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4296         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4297         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4298         connect_blocks(&nodes[1], 1);
4299
4300         if forwarded_htlc {
4301                 expect_pending_htlcs_forwardable!(nodes[1]);
4302                 check_added_monitors!(nodes[1], 1);
4303                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4304                 assert_eq!(fail_commit.len(), 1);
4305                 match fail_commit[0] {
4306                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4307                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4308                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4309                         },
4310                         _ => unreachable!(),
4311                 }
4312                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4313                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4314         } else {
4315                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4316         }
4317 }
4318
4319 #[test]
4320 fn test_holding_cell_htlc_add_timeouts() {
4321         do_test_holding_cell_htlc_add_timeouts(false);
4322         do_test_holding_cell_htlc_add_timeouts(true);
4323 }
4324
4325 #[test]
4326 fn test_invalid_channel_announcement() {
4327         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4328         let secp_ctx = Secp256k1::new();
4329         let chanmon_cfgs = create_chanmon_cfgs(2);
4330         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4331         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4332         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4333
4334         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4335
4336         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4337         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4338         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4339         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4340
4341         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 } );
4342
4343         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4344         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4345
4346         let as_network_key = nodes[0].node.get_our_node_id();
4347         let bs_network_key = nodes[1].node.get_our_node_id();
4348
4349         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4350
4351         let mut chan_announcement;
4352
4353         macro_rules! dummy_unsigned_msg {
4354                 () => {
4355                         msgs::UnsignedChannelAnnouncement {
4356                                 features: ChannelFeatures::known(),
4357                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4358                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4359                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4360                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4361                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4362                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4363                                 excess_data: Vec::new(),
4364                         };
4365                 }
4366         }
4367
4368         macro_rules! sign_msg {
4369                 ($unsigned_msg: expr) => {
4370                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4371                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4372                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4373                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4374                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4375                         chan_announcement = msgs::ChannelAnnouncement {
4376                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4377                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4378                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4379                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4380                                 contents: $unsigned_msg
4381                         }
4382                 }
4383         }
4384
4385         let unsigned_msg = dummy_unsigned_msg!();
4386         sign_msg!(unsigned_msg);
4387         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4388         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 } );
4389
4390         // Configured with Network::Testnet
4391         let mut unsigned_msg = dummy_unsigned_msg!();
4392         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4393         sign_msg!(unsigned_msg);
4394         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4395
4396         let mut unsigned_msg = dummy_unsigned_msg!();
4397         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4398         sign_msg!(unsigned_msg);
4399         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4400 }
4401
4402 #[test]
4403 fn test_no_txn_manager_serialize_deserialize() {
4404         let chanmon_cfgs = create_chanmon_cfgs(2);
4405         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4406         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4407         let logger: test_utils::TestLogger;
4408         let fee_estimator: test_utils::TestFeeEstimator;
4409         let persister: test_utils::TestPersister;
4410         let new_chain_monitor: test_utils::TestChainMonitor;
4411         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4413
4414         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4415
4416         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4417
4418         let nodes_0_serialized = nodes[0].node.encode();
4419         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4420         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4421
4422         logger = test_utils::TestLogger::new();
4423         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4424         persister = test_utils::TestPersister::new();
4425         let keys_manager = &chanmon_cfgs[0].keys_manager;
4426         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4427         nodes[0].chain_monitor = &new_chain_monitor;
4428         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4429         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4430                 &mut chan_0_monitor_read, keys_manager).unwrap();
4431         assert!(chan_0_monitor_read.is_empty());
4432
4433         let mut nodes_0_read = &nodes_0_serialized[..];
4434         let config = UserConfig::default();
4435         let (_, nodes_0_deserialized_tmp) = {
4436                 let mut channel_monitors = HashMap::new();
4437                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4438                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4439                         default_config: config,
4440                         keys_manager,
4441                         fee_estimator: &fee_estimator,
4442                         chain_monitor: nodes[0].chain_monitor,
4443                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4444                         logger: &logger,
4445                         channel_monitors,
4446                 }).unwrap()
4447         };
4448         nodes_0_deserialized = nodes_0_deserialized_tmp;
4449         assert!(nodes_0_read.is_empty());
4450
4451         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4452         nodes[0].node = &nodes_0_deserialized;
4453         assert_eq!(nodes[0].node.list_channels().len(), 1);
4454         check_added_monitors!(nodes[0], 1);
4455
4456         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4457         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4458         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4459         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4460
4461         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4462         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4463         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4464         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4465
4466         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4467         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4468         for node in nodes.iter() {
4469                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4470                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4471                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4472         }
4473
4474         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4475 }
4476
4477 #[test]
4478 fn test_dup_htlc_onchain_fails_on_reload() {
4479         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4480         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4481         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4482         // the ChannelMonitor tells it to.
4483         //
4484         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4485         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4486         // PaymentFailed event appearing). However, because we may not serialize the relevant
4487         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4488         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4489         // and de-duplicates ChannelMonitor events.
4490         //
4491         // This tests that explicit tracking behavior.
4492         let chanmon_cfgs = create_chanmon_cfgs(2);
4493         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4494         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4495         let persister: test_utils::TestPersister;
4496         let new_chain_monitor: test_utils::TestChainMonitor;
4497         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4498         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4499
4500         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4501
4502         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4503         // nodes[0].
4504         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4505         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4506         check_closed_broadcast!(nodes[0], true);
4507         check_added_monitors!(nodes[0], 1);
4508
4509         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4510         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4511
4512         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4513         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4514         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4515         assert_eq!(node_txn.len(), 3);
4516         assert_eq!(node_txn[0], node_txn[1]);
4517
4518         assert!(nodes[1].node.claim_funds(payment_preimage));
4519         check_added_monitors!(nodes[1], 1);
4520
4521         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4522         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4523         check_closed_broadcast!(nodes[1], true);
4524         check_added_monitors!(nodes[1], 1);
4525         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4526
4527         header.prev_blockhash = nodes[0].best_block_hash();
4528         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4529
4530         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4531         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4532         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4533         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4534         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4535
4536         header.prev_blockhash = nodes[0].best_block_hash();
4537         let claim_block = Block { header, txdata: claim_txn};
4538         connect_block(&nodes[0], &claim_block);
4539         expect_payment_sent!(nodes[0], payment_preimage);
4540
4541         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4542         // connected a highly-relevant block, it likely gets serialized out now.
4543         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4544         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4545
4546         // Now reload nodes[0]...
4547         persister = test_utils::TestPersister::new();
4548         let keys_manager = &chanmon_cfgs[0].keys_manager;
4549         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);
4550         nodes[0].chain_monitor = &new_chain_monitor;
4551         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4552         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4553                 &mut chan_0_monitor_read, keys_manager).unwrap();
4554         assert!(chan_0_monitor_read.is_empty());
4555
4556         let (_, nodes_0_deserialized_tmp) = {
4557                 let mut channel_monitors = HashMap::new();
4558                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4559                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4560                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4561                                 default_config: Default::default(),
4562                                 keys_manager,
4563                                 fee_estimator: node_cfgs[0].fee_estimator,
4564                                 chain_monitor: nodes[0].chain_monitor,
4565                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4566                                 logger: nodes[0].logger,
4567                                 channel_monitors,
4568                         }).unwrap()
4569         };
4570         nodes_0_deserialized = nodes_0_deserialized_tmp;
4571
4572         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4573         check_added_monitors!(nodes[0], 1);
4574         nodes[0].node = &nodes_0_deserialized;
4575
4576         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4577         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4578         // payment events should kick in, leaving us with no pending events here.
4579         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4580         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4581         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4582 }
4583
4584 #[test]
4585 fn test_manager_serialize_deserialize_events() {
4586         // This test makes sure the events field in ChannelManager survives de/serialization
4587         let chanmon_cfgs = create_chanmon_cfgs(2);
4588         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4589         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4590         let fee_estimator: test_utils::TestFeeEstimator;
4591         let persister: test_utils::TestPersister;
4592         let logger: test_utils::TestLogger;
4593         let new_chain_monitor: test_utils::TestChainMonitor;
4594         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4595         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4596
4597         // Start creating a channel, but stop right before broadcasting the funding transaction
4598         let channel_value = 100000;
4599         let push_msat = 10001;
4600         let a_flags = InitFeatures::known();
4601         let b_flags = InitFeatures::known();
4602         let node_a = nodes.remove(0);
4603         let node_b = nodes.remove(0);
4604         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4605         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()));
4606         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()));
4607
4608         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4609
4610         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4611         check_added_monitors!(node_a, 0);
4612
4613         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()));
4614         {
4615                 let mut added_monitors = node_b.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
4621         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()));
4622         {
4623                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4624                 assert_eq!(added_monitors.len(), 1);
4625                 assert_eq!(added_monitors[0].0, funding_output);
4626                 added_monitors.clear();
4627         }
4628         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4629
4630         nodes.push(node_a);
4631         nodes.push(node_b);
4632
4633         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4634         let nodes_0_serialized = nodes[0].node.encode();
4635         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4636         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4637
4638         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4639         logger = test_utils::TestLogger::new();
4640         persister = test_utils::TestPersister::new();
4641         let keys_manager = &chanmon_cfgs[0].keys_manager;
4642         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4643         nodes[0].chain_monitor = &new_chain_monitor;
4644         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4645         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4646                 &mut chan_0_monitor_read, keys_manager).unwrap();
4647         assert!(chan_0_monitor_read.is_empty());
4648
4649         let mut nodes_0_read = &nodes_0_serialized[..];
4650         let config = UserConfig::default();
4651         let (_, nodes_0_deserialized_tmp) = {
4652                 let mut channel_monitors = HashMap::new();
4653                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4654                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4655                         default_config: config,
4656                         keys_manager,
4657                         fee_estimator: &fee_estimator,
4658                         chain_monitor: nodes[0].chain_monitor,
4659                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4660                         logger: &logger,
4661                         channel_monitors,
4662                 }).unwrap()
4663         };
4664         nodes_0_deserialized = nodes_0_deserialized_tmp;
4665         assert!(nodes_0_read.is_empty());
4666
4667         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4668
4669         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4670         nodes[0].node = &nodes_0_deserialized;
4671
4672         // After deserializing, make sure the funding_transaction is still held by the channel manager
4673         let events_4 = nodes[0].node.get_and_clear_pending_events();
4674         assert_eq!(events_4.len(), 0);
4675         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4676         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4677
4678         // Make sure the channel is functioning as though the de/serialization never happened
4679         assert_eq!(nodes[0].node.list_channels().len(), 1);
4680         check_added_monitors!(nodes[0], 1);
4681
4682         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4683         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4684         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4685         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4686
4687         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4688         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4689         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4691
4692         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4693         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4694         for node in nodes.iter() {
4695                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4696                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4697                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4698         }
4699
4700         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4701 }
4702
4703 #[test]
4704 fn test_simple_manager_serialize_deserialize() {
4705         let chanmon_cfgs = create_chanmon_cfgs(2);
4706         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4707         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4708         let logger: test_utils::TestLogger;
4709         let fee_estimator: test_utils::TestFeeEstimator;
4710         let persister: test_utils::TestPersister;
4711         let new_chain_monitor: test_utils::TestChainMonitor;
4712         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4713         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4714         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4715
4716         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4717         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4718
4719         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4720
4721         let nodes_0_serialized = nodes[0].node.encode();
4722         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4723         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4724
4725         logger = test_utils::TestLogger::new();
4726         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4727         persister = test_utils::TestPersister::new();
4728         let keys_manager = &chanmon_cfgs[0].keys_manager;
4729         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4730         nodes[0].chain_monitor = &new_chain_monitor;
4731         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4732         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4733                 &mut chan_0_monitor_read, keys_manager).unwrap();
4734         assert!(chan_0_monitor_read.is_empty());
4735
4736         let mut nodes_0_read = &nodes_0_serialized[..];
4737         let (_, nodes_0_deserialized_tmp) = {
4738                 let mut channel_monitors = HashMap::new();
4739                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4740                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4741                         default_config: UserConfig::default(),
4742                         keys_manager,
4743                         fee_estimator: &fee_estimator,
4744                         chain_monitor: nodes[0].chain_monitor,
4745                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4746                         logger: &logger,
4747                         channel_monitors,
4748                 }).unwrap()
4749         };
4750         nodes_0_deserialized = nodes_0_deserialized_tmp;
4751         assert!(nodes_0_read.is_empty());
4752
4753         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4754         nodes[0].node = &nodes_0_deserialized;
4755         check_added_monitors!(nodes[0], 1);
4756
4757         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4758
4759         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4760         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4761 }
4762
4763 #[test]
4764 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4765         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4766         let chanmon_cfgs = create_chanmon_cfgs(4);
4767         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4768         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4769         let logger: test_utils::TestLogger;
4770         let fee_estimator: test_utils::TestFeeEstimator;
4771         let persister: test_utils::TestPersister;
4772         let new_chain_monitor: test_utils::TestChainMonitor;
4773         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4774         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4775         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4776         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4777         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4778
4779         let mut node_0_stale_monitors_serialized = Vec::new();
4780         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4781                 let mut writer = test_utils::TestVecWriter(Vec::new());
4782                 monitor.1.write(&mut writer).unwrap();
4783                 node_0_stale_monitors_serialized.push(writer.0);
4784         }
4785
4786         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4787
4788         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4789         let nodes_0_serialized = nodes[0].node.encode();
4790
4791         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4792         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4793         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4794         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4795
4796         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4797         // nodes[3])
4798         let mut node_0_monitors_serialized = Vec::new();
4799         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4800                 let mut writer = test_utils::TestVecWriter(Vec::new());
4801                 monitor.1.write(&mut writer).unwrap();
4802                 node_0_monitors_serialized.push(writer.0);
4803         }
4804
4805         logger = test_utils::TestLogger::new();
4806         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4807         persister = test_utils::TestPersister::new();
4808         let keys_manager = &chanmon_cfgs[0].keys_manager;
4809         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4810         nodes[0].chain_monitor = &new_chain_monitor;
4811
4812
4813         let mut node_0_stale_monitors = Vec::new();
4814         for serialized in node_0_stale_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_stale_monitors.push(monitor);
4819         }
4820
4821         let mut node_0_monitors = Vec::new();
4822         for serialized in node_0_monitors_serialized.iter() {
4823                 let mut read = &serialized[..];
4824                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4825                 assert!(read.is_empty());
4826                 node_0_monitors.push(monitor);
4827         }
4828
4829         let mut nodes_0_read = &nodes_0_serialized[..];
4830         if let Err(msgs::DecodeError::InvalidValue) =
4831                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4832                 default_config: UserConfig::default(),
4833                 keys_manager,
4834                 fee_estimator: &fee_estimator,
4835                 chain_monitor: nodes[0].chain_monitor,
4836                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4837                 logger: &logger,
4838                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4839         }) { } else {
4840                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4841         };
4842
4843         let mut nodes_0_read = &nodes_0_serialized[..];
4844         let (_, nodes_0_deserialized_tmp) =
4845                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4846                 default_config: UserConfig::default(),
4847                 keys_manager,
4848                 fee_estimator: &fee_estimator,
4849                 chain_monitor: nodes[0].chain_monitor,
4850                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4851                 logger: &logger,
4852                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4853         }).unwrap();
4854         nodes_0_deserialized = nodes_0_deserialized_tmp;
4855         assert!(nodes_0_read.is_empty());
4856
4857         { // Channel close should result in a commitment tx
4858                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4859                 assert_eq!(txn.len(), 1);
4860                 check_spends!(txn[0], funding_tx);
4861                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4862         }
4863
4864         for monitor in node_0_monitors.drain(..) {
4865                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4866                 check_added_monitors!(nodes[0], 1);
4867         }
4868         nodes[0].node = &nodes_0_deserialized;
4869
4870         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4871         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4872         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4873         //... and we can even still claim the payment!
4874         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4875
4876         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4877         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4878         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4879         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4880         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4881         assert_eq!(msg_events.len(), 1);
4882         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4883                 match action {
4884                         &ErrorAction::SendErrorMessage { ref msg } => {
4885                                 assert_eq!(msg.channel_id, channel_id);
4886                         },
4887                         _ => panic!("Unexpected event!"),
4888                 }
4889         }
4890 }
4891
4892 macro_rules! check_spendable_outputs {
4893         ($node: expr, $keysinterface: expr) => {
4894                 {
4895                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4896                         let mut txn = Vec::new();
4897                         let mut all_outputs = Vec::new();
4898                         let secp_ctx = Secp256k1::new();
4899                         for event in events.drain(..) {
4900                                 match event {
4901                                         Event::SpendableOutputs { mut outputs } => {
4902                                                 for outp in outputs.drain(..) {
4903                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4904                                                         all_outputs.push(outp);
4905                                                 }
4906                                         },
4907                                         _ => panic!("Unexpected event"),
4908                                 };
4909                         }
4910                         if all_outputs.len() > 1 {
4911                                 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) {
4912                                         txn.push(tx);
4913                                 }
4914                         }
4915                         txn
4916                 }
4917         }
4918 }
4919
4920 #[test]
4921 fn test_claim_sizeable_push_msat() {
4922         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4923         let chanmon_cfgs = create_chanmon_cfgs(2);
4924         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4925         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4926         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4927
4928         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4929         nodes[1].node.force_close_channel(&chan.2).unwrap();
4930         check_closed_broadcast!(nodes[1], true);
4931         check_added_monitors!(nodes[1], 1);
4932         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4933         assert_eq!(node_txn.len(), 1);
4934         check_spends!(node_txn[0], chan.3);
4935         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
4936
4937         mine_transaction(&nodes[1], &node_txn[0]);
4938         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4939
4940         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4941         assert_eq!(spend_txn.len(), 1);
4942         assert_eq!(spend_txn[0].input.len(), 1);
4943         check_spends!(spend_txn[0], node_txn[0]);
4944         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4945 }
4946
4947 #[test]
4948 fn test_claim_on_remote_sizeable_push_msat() {
4949         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4950         // to_remote output is encumbered by a P2WPKH
4951         let chanmon_cfgs = create_chanmon_cfgs(2);
4952         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4953         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4954         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4955
4956         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4957         nodes[0].node.force_close_channel(&chan.2).unwrap();
4958         check_closed_broadcast!(nodes[0], true);
4959         check_added_monitors!(nodes[0], 1);
4960
4961         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4962         assert_eq!(node_txn.len(), 1);
4963         check_spends!(node_txn[0], chan.3);
4964         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
4965
4966         mine_transaction(&nodes[1], &node_txn[0]);
4967         check_closed_broadcast!(nodes[1], true);
4968         check_added_monitors!(nodes[1], 1);
4969         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4970
4971         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4972         assert_eq!(spend_txn.len(), 1);
4973         check_spends!(spend_txn[0], node_txn[0]);
4974 }
4975
4976 #[test]
4977 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4978         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4979         // to_remote output is encumbered by a P2WPKH
4980
4981         let chanmon_cfgs = create_chanmon_cfgs(2);
4982         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4983         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4984         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4985
4986         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4987         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4988         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4989         assert_eq!(revoked_local_txn[0].input.len(), 1);
4990         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4991
4992         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4993         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4994         check_closed_broadcast!(nodes[1], true);
4995         check_added_monitors!(nodes[1], 1);
4996
4997         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4998         mine_transaction(&nodes[1], &node_txn[0]);
4999         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5000
5001         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5002         assert_eq!(spend_txn.len(), 3);
5003         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
5004         check_spends!(spend_txn[1], node_txn[0]);
5005         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
5006 }
5007
5008 #[test]
5009 fn test_static_spendable_outputs_preimage_tx() {
5010         let chanmon_cfgs = create_chanmon_cfgs(2);
5011         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5012         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5013         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5014
5015         // Create some initial channels
5016         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5017
5018         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5019
5020         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5021         assert_eq!(commitment_tx[0].input.len(), 1);
5022         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5023
5024         // Settle A's commitment tx on B's chain
5025         assert!(nodes[1].node.claim_funds(payment_preimage));
5026         check_added_monitors!(nodes[1], 1);
5027         mine_transaction(&nodes[1], &commitment_tx[0]);
5028         check_added_monitors!(nodes[1], 1);
5029         let events = nodes[1].node.get_and_clear_pending_msg_events();
5030         match events[0] {
5031                 MessageSendEvent::UpdateHTLCs { .. } => {},
5032                 _ => panic!("Unexpected event"),
5033         }
5034         match events[1] {
5035                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5036                 _ => panic!("Unexepected event"),
5037         }
5038
5039         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5040         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
5041         assert_eq!(node_txn.len(), 3);
5042         check_spends!(node_txn[0], commitment_tx[0]);
5043         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5044         check_spends!(node_txn[1], chan_1.3);
5045         check_spends!(node_txn[2], node_txn[1]);
5046
5047         mine_transaction(&nodes[1], &node_txn[0]);
5048         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5049
5050         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5051         assert_eq!(spend_txn.len(), 1);
5052         check_spends!(spend_txn[0], node_txn[0]);
5053 }
5054
5055 #[test]
5056 fn test_static_spendable_outputs_timeout_tx() {
5057         let chanmon_cfgs = create_chanmon_cfgs(2);
5058         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5059         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5060         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5061
5062         // Create some initial channels
5063         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5064
5065         // Rebalance the network a bit by relaying one payment through all the channels ...
5066         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5067
5068         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5069
5070         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5071         assert_eq!(commitment_tx[0].input.len(), 1);
5072         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5073
5074         // Settle A's commitment tx on B' chain
5075         mine_transaction(&nodes[1], &commitment_tx[0]);
5076         check_added_monitors!(nodes[1], 1);
5077         let events = nodes[1].node.get_and_clear_pending_msg_events();
5078         match events[0] {
5079                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5080                 _ => panic!("Unexpected event"),
5081         }
5082         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5083
5084         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5085         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5086         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5087         check_spends!(node_txn[0], chan_1.3.clone());
5088         check_spends!(node_txn[1],  commitment_tx[0].clone());
5089         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5090
5091         mine_transaction(&nodes[1], &node_txn[1]);
5092         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5093         expect_payment_failed!(nodes[1], our_payment_hash, true);
5094
5095         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5096         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5097         check_spends!(spend_txn[0], commitment_tx[0]);
5098         check_spends!(spend_txn[1], node_txn[1]);
5099         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5100 }
5101
5102 #[test]
5103 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5104         let chanmon_cfgs = create_chanmon_cfgs(2);
5105         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5106         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5107         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5108
5109         // Create some initial channels
5110         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5111
5112         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5113         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5114         assert_eq!(revoked_local_txn[0].input.len(), 1);
5115         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5116
5117         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5118
5119         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5120         check_closed_broadcast!(nodes[1], true);
5121         check_added_monitors!(nodes[1], 1);
5122
5123         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5124         assert_eq!(node_txn.len(), 2);
5125         assert_eq!(node_txn[0].input.len(), 2);
5126         check_spends!(node_txn[0], revoked_local_txn[0]);
5127
5128         mine_transaction(&nodes[1], &node_txn[0]);
5129         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5130
5131         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5132         assert_eq!(spend_txn.len(), 1);
5133         check_spends!(spend_txn[0], node_txn[0]);
5134 }
5135
5136 #[test]
5137 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5138         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5139         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5140         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5141         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5142         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5143
5144         // Create some initial channels
5145         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5146
5147         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5148         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5149         assert_eq!(revoked_local_txn[0].input.len(), 1);
5150         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5151
5152         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5153
5154         // A will generate HTLC-Timeout from revoked commitment tx
5155         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5156         check_closed_broadcast!(nodes[0], true);
5157         check_added_monitors!(nodes[0], 1);
5158         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5159
5160         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5161         assert_eq!(revoked_htlc_txn.len(), 2);
5162         check_spends!(revoked_htlc_txn[0], chan_1.3);
5163         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5164         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5165         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5166         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5167
5168         // B will generate justice tx from A's revoked commitment/HTLC tx
5169         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5170         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5171         check_closed_broadcast!(nodes[1], true);
5172         check_added_monitors!(nodes[1], 1);
5173
5174         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5175         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5176         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5177         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5178         // transactions next...
5179         assert_eq!(node_txn[0].input.len(), 3);
5180         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5181
5182         assert_eq!(node_txn[1].input.len(), 2);
5183         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5184         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5185                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5186         } else {
5187                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5188                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5189         }
5190
5191         assert_eq!(node_txn[2].input.len(), 1);
5192         check_spends!(node_txn[2], chan_1.3);
5193
5194         mine_transaction(&nodes[1], &node_txn[1]);
5195         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5196
5197         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5198         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5199         assert_eq!(spend_txn.len(), 1);
5200         assert_eq!(spend_txn[0].input.len(), 1);
5201         check_spends!(spend_txn[0], node_txn[1]);
5202 }
5203
5204 #[test]
5205 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5206         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5207         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5208         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5209         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5210         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5211
5212         // Create some initial channels
5213         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5214
5215         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5216         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5217         assert_eq!(revoked_local_txn[0].input.len(), 1);
5218         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5219
5220         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5221         assert_eq!(revoked_local_txn[0].output.len(), 2);
5222
5223         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5224
5225         // B will generate HTLC-Success from revoked commitment tx
5226         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5227         check_closed_broadcast!(nodes[1], true);
5228         check_added_monitors!(nodes[1], 1);
5229         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5230
5231         assert_eq!(revoked_htlc_txn.len(), 2);
5232         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5233         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5234         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5235
5236         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5237         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5238         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5239
5240         // A will generate justice tx from B's revoked commitment/HTLC tx
5241         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5242         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5243         check_closed_broadcast!(nodes[0], true);
5244         check_added_monitors!(nodes[0], 1);
5245
5246         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5247         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5248
5249         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5250         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5251         // transactions next...
5252         assert_eq!(node_txn[0].input.len(), 2);
5253         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5254         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5255                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5256         } else {
5257                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5258                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5259         }
5260
5261         assert_eq!(node_txn[1].input.len(), 1);
5262         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5263
5264         check_spends!(node_txn[2], chan_1.3);
5265
5266         mine_transaction(&nodes[0], &node_txn[1]);
5267         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5268
5269         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5270         // didn't try to generate any new transactions.
5271
5272         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5273         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5274         assert_eq!(spend_txn.len(), 3);
5275         assert_eq!(spend_txn[0].input.len(), 1);
5276         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5277         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5278         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5279         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5280 }
5281
5282 #[test]
5283 fn test_onchain_to_onchain_claim() {
5284         // Test that in case of channel closure, we detect the state of output and claim HTLC
5285         // on downstream peer's remote commitment tx.
5286         // First, have C claim an HTLC against its own latest commitment transaction.
5287         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5288         // channel.
5289         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5290         // gets broadcast.
5291
5292         let chanmon_cfgs = create_chanmon_cfgs(3);
5293         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5294         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5295         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5296
5297         // Create some initial channels
5298         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5299         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5300
5301         // Ensure all nodes are at the same height
5302         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5303         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5304         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5305         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5306
5307         // Rebalance the network a bit by relaying one payment through all the channels ...
5308         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5309         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5310
5311         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5312         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5313         check_spends!(commitment_tx[0], chan_2.3);
5314         nodes[2].node.claim_funds(payment_preimage);
5315         check_added_monitors!(nodes[2], 1);
5316         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5317         assert!(updates.update_add_htlcs.is_empty());
5318         assert!(updates.update_fail_htlcs.is_empty());
5319         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5320         assert!(updates.update_fail_malformed_htlcs.is_empty());
5321
5322         mine_transaction(&nodes[2], &commitment_tx[0]);
5323         check_closed_broadcast!(nodes[2], true);
5324         check_added_monitors!(nodes[2], 1);
5325
5326         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5327         assert_eq!(c_txn.len(), 3);
5328         assert_eq!(c_txn[0], c_txn[2]);
5329         assert_eq!(commitment_tx[0], c_txn[1]);
5330         check_spends!(c_txn[1], chan_2.3);
5331         check_spends!(c_txn[2], c_txn[1]);
5332         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5333         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5334         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5335         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5336
5337         // 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
5338         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5339         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5340         check_added_monitors!(nodes[1], 1);
5341         expect_payment_forwarded!(nodes[1], Some(1000), true);
5342         {
5343                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5344                 // ChannelMonitor: claim tx
5345                 assert_eq!(b_txn.len(), 1);
5346                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5347                 b_txn.clear();
5348         }
5349         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5350         assert_eq!(msg_events.len(), 3);
5351         check_added_monitors!(nodes[1], 1);
5352         match msg_events[0] {
5353                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5354                 _ => panic!("Unexpected event"),
5355         }
5356         match msg_events[1] {
5357                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5358                 _ => panic!("Unexpected event"),
5359         }
5360         match msg_events[2] {
5361                 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, .. } } => {
5362                         assert!(update_add_htlcs.is_empty());
5363                         assert!(update_fail_htlcs.is_empty());
5364                         assert_eq!(update_fulfill_htlcs.len(), 1);
5365                         assert!(update_fail_malformed_htlcs.is_empty());
5366                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5367                 },
5368                 _ => panic!("Unexpected event"),
5369         };
5370         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5371         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5372         mine_transaction(&nodes[1], &commitment_tx[0]);
5373         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5374         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5375         assert_eq!(b_txn.len(), 3);
5376         check_spends!(b_txn[1], chan_1.3);
5377         check_spends!(b_txn[2], b_txn[1]);
5378         check_spends!(b_txn[0], commitment_tx[0]);
5379         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5380         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5381         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5382
5383         check_closed_broadcast!(nodes[1], true);
5384         check_added_monitors!(nodes[1], 1);
5385 }
5386
5387 #[test]
5388 fn test_duplicate_payment_hash_one_failure_one_success() {
5389         // Topology : A --> B --> C --> D
5390         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5391         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5392         // we forward one of the payments onwards to D.
5393         let chanmon_cfgs = create_chanmon_cfgs(4);
5394         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5395         // When this test was written, the default base fee floated based on the HTLC count.
5396         // It is now fixed, so we simply set the fee to the expected value here.
5397         let mut config = test_default_channel_config();
5398         config.channel_options.forwarding_fee_base_msat = 196;
5399         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5400                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5401         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5402
5403         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5404         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5405         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5406
5407         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5408         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5409         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5410         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5411         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5412
5413         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5414
5415         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5416         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5417         // script push size limit so that the below script length checks match
5418         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5419         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5420                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5421         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5422
5423         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5424         assert_eq!(commitment_txn[0].input.len(), 1);
5425         check_spends!(commitment_txn[0], chan_2.3);
5426
5427         mine_transaction(&nodes[1], &commitment_txn[0]);
5428         check_closed_broadcast!(nodes[1], true);
5429         check_added_monitors!(nodes[1], 1);
5430         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5431
5432         let htlc_timeout_tx;
5433         { // Extract one of the two HTLC-Timeout transaction
5434                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5435                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5436                 assert_eq!(node_txn.len(), 4);
5437                 check_spends!(node_txn[0], chan_2.3);
5438
5439                 check_spends!(node_txn[1], commitment_txn[0]);
5440                 assert_eq!(node_txn[1].input.len(), 1);
5441                 check_spends!(node_txn[2], commitment_txn[0]);
5442                 assert_eq!(node_txn[2].input.len(), 1);
5443                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5444                 check_spends!(node_txn[3], commitment_txn[0]);
5445                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5446
5447                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5448                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5449                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5450                 htlc_timeout_tx = node_txn[1].clone();
5451         }
5452
5453         nodes[2].node.claim_funds(our_payment_preimage);
5454         mine_transaction(&nodes[2], &commitment_txn[0]);
5455         check_added_monitors!(nodes[2], 2);
5456         let events = nodes[2].node.get_and_clear_pending_msg_events();
5457         match events[0] {
5458                 MessageSendEvent::UpdateHTLCs { .. } => {},
5459                 _ => panic!("Unexpected event"),
5460         }
5461         match events[1] {
5462                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5463                 _ => panic!("Unexepected event"),
5464         }
5465         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5466         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)
5467         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5468         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5469         assert_eq!(htlc_success_txn[0].input.len(), 1);
5470         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5471         assert_eq!(htlc_success_txn[1].input.len(), 1);
5472         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5473         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5474         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5475         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5476         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5477         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5478
5479         mine_transaction(&nodes[1], &htlc_timeout_tx);
5480         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5481         expect_pending_htlcs_forwardable!(nodes[1]);
5482         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5483         assert!(htlc_updates.update_add_htlcs.is_empty());
5484         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5485         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5486         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5487         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5488         check_added_monitors!(nodes[1], 1);
5489
5490         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5491         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5492         {
5493                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5494                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5495         }
5496         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5497
5498         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5499         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5500         // and nodes[2] fee) is rounded down and then claimed in full.
5501         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5502         expect_payment_forwarded!(nodes[1], Some(196*2), true);
5503         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5504         assert!(updates.update_add_htlcs.is_empty());
5505         assert!(updates.update_fail_htlcs.is_empty());
5506         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5507         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5508         assert!(updates.update_fail_malformed_htlcs.is_empty());
5509         check_added_monitors!(nodes[1], 1);
5510
5511         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5512         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5513
5514         let events = nodes[0].node.get_and_clear_pending_events();
5515         match events[0] {
5516                 Event::PaymentSent { ref payment_preimage } => {
5517                         assert_eq!(*payment_preimage, our_payment_preimage);
5518                 }
5519                 _ => panic!("Unexpected event"),
5520         }
5521 }
5522
5523 #[test]
5524 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5525         let chanmon_cfgs = create_chanmon_cfgs(2);
5526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5528         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5529
5530         // Create some initial channels
5531         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5532
5533         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5534         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5535         assert_eq!(local_txn.len(), 1);
5536         assert_eq!(local_txn[0].input.len(), 1);
5537         check_spends!(local_txn[0], chan_1.3);
5538
5539         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5540         nodes[1].node.claim_funds(payment_preimage);
5541         check_added_monitors!(nodes[1], 1);
5542         mine_transaction(&nodes[1], &local_txn[0]);
5543         check_added_monitors!(nodes[1], 1);
5544         let events = nodes[1].node.get_and_clear_pending_msg_events();
5545         match events[0] {
5546                 MessageSendEvent::UpdateHTLCs { .. } => {},
5547                 _ => panic!("Unexpected event"),
5548         }
5549         match events[1] {
5550                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5551                 _ => panic!("Unexepected event"),
5552         }
5553         let node_tx = {
5554                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5555                 assert_eq!(node_txn.len(), 3);
5556                 assert_eq!(node_txn[0], node_txn[2]);
5557                 assert_eq!(node_txn[1], local_txn[0]);
5558                 assert_eq!(node_txn[0].input.len(), 1);
5559                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5560                 check_spends!(node_txn[0], local_txn[0]);
5561                 node_txn[0].clone()
5562         };
5563
5564         mine_transaction(&nodes[1], &node_tx);
5565         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5566
5567         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5568         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5569         assert_eq!(spend_txn.len(), 1);
5570         assert_eq!(spend_txn[0].input.len(), 1);
5571         check_spends!(spend_txn[0], node_tx);
5572         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5573 }
5574
5575 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5576         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5577         // unrevoked commitment transaction.
5578         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5579         // a remote RAA before they could be failed backwards (and combinations thereof).
5580         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5581         // use the same payment hashes.
5582         // Thus, we use a six-node network:
5583         //
5584         // A \         / E
5585         //    - C - D -
5586         // B /         \ F
5587         // And test where C fails back to A/B when D announces its latest commitment transaction
5588         let chanmon_cfgs = create_chanmon_cfgs(6);
5589         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5590         // When this test was written, the default base fee floated based on the HTLC count.
5591         // It is now fixed, so we simply set the fee to the expected value here.
5592         let mut config = test_default_channel_config();
5593         config.channel_options.forwarding_fee_base_msat = 196;
5594         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5595                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5596         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5597         let logger = test_utils::TestLogger::new();
5598
5599         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5600         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5601         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5602         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5603         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5604
5605         // Rebalance and check output sanity...
5606         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5607         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5608         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5609
5610         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5611         // 0th HTLC:
5612         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
5613         // 1st HTLC:
5614         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
5615         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5616         let our_node_id = &nodes[1].node.get_our_node_id();
5617         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();
5618         // 2nd HTLC:
5619         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
5620         // 3rd HTLC:
5621         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
5622         // 4th HTLC:
5623         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5624         // 5th HTLC:
5625         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5626         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();
5627         // 6th HTLC:
5628         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());
5629         // 7th HTLC:
5630         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());
5631
5632         // 8th HTLC:
5633         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5634         // 9th HTLC:
5635         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();
5636         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
5637
5638         // 10th HTLC:
5639         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
5640         // 11th HTLC:
5641         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();
5642         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());
5643
5644         // Double-check that six of the new HTLC were added
5645         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5646         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5647         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5648         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5649
5650         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5651         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5652         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5653         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5654         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5655         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5656         check_added_monitors!(nodes[4], 0);
5657         expect_pending_htlcs_forwardable!(nodes[4]);
5658         check_added_monitors!(nodes[4], 1);
5659
5660         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5661         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5662         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5663         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5664         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5665         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5666
5667         // Fail 3rd below-dust and 7th above-dust HTLCs
5668         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5669         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5670         check_added_monitors!(nodes[5], 0);
5671         expect_pending_htlcs_forwardable!(nodes[5]);
5672         check_added_monitors!(nodes[5], 1);
5673
5674         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5675         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5676         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5677         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5678
5679         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5680
5681         expect_pending_htlcs_forwardable!(nodes[3]);
5682         check_added_monitors!(nodes[3], 1);
5683         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5684         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5685         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5686         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5687         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5688         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5689         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5690         if deliver_last_raa {
5691                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5692         } else {
5693                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5694         }
5695
5696         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5697         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5698         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5699         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5700         //
5701         // We now broadcast the latest commitment transaction, which *should* result in failures for
5702         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5703         // the non-broadcast above-dust HTLCs.
5704         //
5705         // Alternatively, we may broadcast the previous commitment transaction, which should only
5706         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5707         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5708
5709         if announce_latest {
5710                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5711         } else {
5712                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5713         }
5714         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5715         check_closed_broadcast!(nodes[2], true);
5716         expect_pending_htlcs_forwardable!(nodes[2]);
5717         check_added_monitors!(nodes[2], 3);
5718
5719         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5720         assert_eq!(cs_msgs.len(), 2);
5721         let mut a_done = false;
5722         for msg in cs_msgs {
5723                 match msg {
5724                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5725                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5726                                 // should be failed-backwards here.
5727                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5728                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5729                                         for htlc in &updates.update_fail_htlcs {
5730                                                 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 });
5731                                         }
5732                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5733                                         assert!(!a_done);
5734                                         a_done = true;
5735                                         &nodes[0]
5736                                 } else {
5737                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5738                                         for htlc in &updates.update_fail_htlcs {
5739                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5740                                         }
5741                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5742                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5743                                         &nodes[1]
5744                                 };
5745                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5746                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5747                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5748                                 if announce_latest {
5749                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5750                                         if *node_id == nodes[0].node.get_our_node_id() {
5751                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5752                                         }
5753                                 }
5754                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5755                         },
5756                         _ => panic!("Unexpected event"),
5757                 }
5758         }
5759
5760         let as_events = nodes[0].node.get_and_clear_pending_events();
5761         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5762         let mut as_failds = HashSet::new();
5763         for event in as_events.iter() {
5764                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5765                         assert!(as_failds.insert(*payment_hash));
5766                         if *payment_hash != payment_hash_2 {
5767                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5768                         } else {
5769                                 assert!(!rejected_by_dest);
5770                         }
5771                 } else { panic!("Unexpected event"); }
5772         }
5773         assert!(as_failds.contains(&payment_hash_1));
5774         assert!(as_failds.contains(&payment_hash_2));
5775         if announce_latest {
5776                 assert!(as_failds.contains(&payment_hash_3));
5777                 assert!(as_failds.contains(&payment_hash_5));
5778         }
5779         assert!(as_failds.contains(&payment_hash_6));
5780
5781         let bs_events = nodes[1].node.get_and_clear_pending_events();
5782         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5783         let mut bs_failds = HashSet::new();
5784         for event in bs_events.iter() {
5785                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5786                         assert!(bs_failds.insert(*payment_hash));
5787                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5788                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5789                         } else {
5790                                 assert!(!rejected_by_dest);
5791                         }
5792                 } else { panic!("Unexpected event"); }
5793         }
5794         assert!(bs_failds.contains(&payment_hash_1));
5795         assert!(bs_failds.contains(&payment_hash_2));
5796         if announce_latest {
5797                 assert!(bs_failds.contains(&payment_hash_4));
5798         }
5799         assert!(bs_failds.contains(&payment_hash_5));
5800
5801         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5802         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5803         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5804         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5805         // PaymentFailureNetworkUpdates.
5806         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5807         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5808         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5809         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5810         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5811                 match event {
5812                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5813                         _ => panic!("Unexpected event"),
5814                 }
5815         }
5816 }
5817
5818 #[test]
5819 fn test_fail_backwards_latest_remote_announce_a() {
5820         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5821 }
5822
5823 #[test]
5824 fn test_fail_backwards_latest_remote_announce_b() {
5825         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5826 }
5827
5828 #[test]
5829 fn test_fail_backwards_previous_remote_announce() {
5830         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5831         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5832         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5833 }
5834
5835 #[test]
5836 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5837         let chanmon_cfgs = create_chanmon_cfgs(2);
5838         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5839         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5840         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5841
5842         // Create some initial channels
5843         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5844
5845         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5846         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5847         assert_eq!(local_txn[0].input.len(), 1);
5848         check_spends!(local_txn[0], chan_1.3);
5849
5850         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5851         mine_transaction(&nodes[0], &local_txn[0]);
5852         check_closed_broadcast!(nodes[0], true);
5853         check_added_monitors!(nodes[0], 1);
5854         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5855
5856         let htlc_timeout = {
5857                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5858                 assert_eq!(node_txn.len(), 2);
5859                 check_spends!(node_txn[0], chan_1.3);
5860                 assert_eq!(node_txn[1].input.len(), 1);
5861                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5862                 check_spends!(node_txn[1], local_txn[0]);
5863                 node_txn[1].clone()
5864         };
5865
5866         mine_transaction(&nodes[0], &htlc_timeout);
5867         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5868         expect_payment_failed!(nodes[0], our_payment_hash, true);
5869
5870         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5871         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5872         assert_eq!(spend_txn.len(), 3);
5873         check_spends!(spend_txn[0], local_txn[0]);
5874         assert_eq!(spend_txn[1].input.len(), 1);
5875         check_spends!(spend_txn[1], htlc_timeout);
5876         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5877         assert_eq!(spend_txn[2].input.len(), 2);
5878         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5879         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5880                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5881 }
5882
5883 #[test]
5884 fn test_key_derivation_params() {
5885         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5886         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5887         // let us re-derive the channel key set to then derive a delayed_payment_key.
5888
5889         let chanmon_cfgs = create_chanmon_cfgs(3);
5890
5891         // We manually create the node configuration to backup the seed.
5892         let seed = [42; 32];
5893         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5894         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);
5895         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 };
5896         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5897         node_cfgs.remove(0);
5898         node_cfgs.insert(0, node);
5899
5900         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5901         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5902
5903         // Create some initial channels
5904         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5905         // for node 0
5906         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5907         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5908         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5909
5910         // Ensure all nodes are at the same height
5911         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5912         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5913         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5914         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5915
5916         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5917         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5918         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5919         assert_eq!(local_txn_1[0].input.len(), 1);
5920         check_spends!(local_txn_1[0], chan_1.3);
5921
5922         // We check funding pubkey are unique
5923         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]));
5924         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]));
5925         if from_0_funding_key_0 == from_1_funding_key_0
5926             || from_0_funding_key_0 == from_1_funding_key_1
5927             || from_0_funding_key_1 == from_1_funding_key_0
5928             || from_0_funding_key_1 == from_1_funding_key_1 {
5929                 panic!("Funding pubkeys aren't unique");
5930         }
5931
5932         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5933         mine_transaction(&nodes[0], &local_txn_1[0]);
5934         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5935         check_closed_broadcast!(nodes[0], true);
5936         check_added_monitors!(nodes[0], 1);
5937
5938         let htlc_timeout = {
5939                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5940                 assert_eq!(node_txn[1].input.len(), 1);
5941                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5942                 check_spends!(node_txn[1], local_txn_1[0]);
5943                 node_txn[1].clone()
5944         };
5945
5946         mine_transaction(&nodes[0], &htlc_timeout);
5947         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5948         expect_payment_failed!(nodes[0], our_payment_hash, true);
5949
5950         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5951         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5952         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5953         assert_eq!(spend_txn.len(), 3);
5954         check_spends!(spend_txn[0], local_txn_1[0]);
5955         assert_eq!(spend_txn[1].input.len(), 1);
5956         check_spends!(spend_txn[1], htlc_timeout);
5957         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5958         assert_eq!(spend_txn[2].input.len(), 2);
5959         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5960         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5961                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5962 }
5963
5964 #[test]
5965 fn test_static_output_closing_tx() {
5966         let chanmon_cfgs = create_chanmon_cfgs(2);
5967         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5968         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5969         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5970
5971         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5972
5973         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5974         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5975
5976         mine_transaction(&nodes[0], &closing_tx);
5977         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5978
5979         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5980         assert_eq!(spend_txn.len(), 1);
5981         check_spends!(spend_txn[0], closing_tx);
5982
5983         mine_transaction(&nodes[1], &closing_tx);
5984         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5985
5986         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5987         assert_eq!(spend_txn.len(), 1);
5988         check_spends!(spend_txn[0], closing_tx);
5989 }
5990
5991 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5992         let chanmon_cfgs = create_chanmon_cfgs(2);
5993         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5994         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5995         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5996         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5997
5998         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5999
6000         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
6001         // present in B's local commitment transaction, but none of A's commitment transactions.
6002         assert!(nodes[1].node.claim_funds(our_payment_preimage));
6003         check_added_monitors!(nodes[1], 1);
6004
6005         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6006         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
6007         let events = nodes[0].node.get_and_clear_pending_events();
6008         assert_eq!(events.len(), 1);
6009         match events[0] {
6010                 Event::PaymentSent { payment_preimage } => {
6011                         assert_eq!(payment_preimage, our_payment_preimage);
6012                 },
6013                 _ => panic!("Unexpected event"),
6014         }
6015
6016         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6017         check_added_monitors!(nodes[0], 1);
6018         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6019         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6020         check_added_monitors!(nodes[1], 1);
6021
6022         let starting_block = nodes[1].best_block_info();
6023         let mut block = Block {
6024                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6025                 txdata: vec![],
6026         };
6027         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
6028                 connect_block(&nodes[1], &block);
6029                 block.header.prev_blockhash = block.block_hash();
6030         }
6031         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
6032         check_closed_broadcast!(nodes[1], true);
6033         check_added_monitors!(nodes[1], 1);
6034 }
6035
6036 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
6037         let chanmon_cfgs = create_chanmon_cfgs(2);
6038         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6039         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6040         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6041         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6042         let logger = test_utils::TestLogger::new();
6043
6044         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6045         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6046         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();
6047         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6048         check_added_monitors!(nodes[0], 1);
6049
6050         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6051
6052         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6053         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6054         // to "time out" the HTLC.
6055
6056         let starting_block = nodes[1].best_block_info();
6057         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6058
6059         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6060                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6061                 header.prev_blockhash = header.block_hash();
6062         }
6063         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6064         check_closed_broadcast!(nodes[0], true);
6065         check_added_monitors!(nodes[0], 1);
6066 }
6067
6068 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6069         let chanmon_cfgs = create_chanmon_cfgs(3);
6070         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6071         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6072         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6073         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6074
6075         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6076         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6077         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6078         // actually revoked.
6079         let htlc_value = if use_dust { 50000 } else { 3000000 };
6080         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6081         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6082         expect_pending_htlcs_forwardable!(nodes[1]);
6083         check_added_monitors!(nodes[1], 1);
6084
6085         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6086         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6087         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6088         check_added_monitors!(nodes[0], 1);
6089         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6090         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6091         check_added_monitors!(nodes[1], 1);
6092         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6093         check_added_monitors!(nodes[1], 1);
6094         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6095
6096         if check_revoke_no_close {
6097                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6098                 check_added_monitors!(nodes[0], 1);
6099         }
6100
6101         let starting_block = nodes[1].best_block_info();
6102         let mut block = Block {
6103                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6104                 txdata: vec![],
6105         };
6106         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6107                 connect_block(&nodes[0], &block);
6108                 block.header.prev_blockhash = block.block_hash();
6109         }
6110         if !check_revoke_no_close {
6111                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6112                 check_closed_broadcast!(nodes[0], true);
6113                 check_added_monitors!(nodes[0], 1);
6114         } else {
6115                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6116         }
6117 }
6118
6119 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6120 // There are only a few cases to test here:
6121 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6122 //    broadcastable commitment transactions result in channel closure,
6123 //  * its included in an unrevoked-but-previous remote commitment transaction,
6124 //  * its included in the latest remote or local commitment transactions.
6125 // We test each of the three possible commitment transactions individually and use both dust and
6126 // non-dust HTLCs.
6127 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6128 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6129 // tested for at least one of the cases in other tests.
6130 #[test]
6131 fn htlc_claim_single_commitment_only_a() {
6132         do_htlc_claim_local_commitment_only(true);
6133         do_htlc_claim_local_commitment_only(false);
6134
6135         do_htlc_claim_current_remote_commitment_only(true);
6136         do_htlc_claim_current_remote_commitment_only(false);
6137 }
6138
6139 #[test]
6140 fn htlc_claim_single_commitment_only_b() {
6141         do_htlc_claim_previous_remote_commitment_only(true, false);
6142         do_htlc_claim_previous_remote_commitment_only(false, false);
6143         do_htlc_claim_previous_remote_commitment_only(true, true);
6144         do_htlc_claim_previous_remote_commitment_only(false, true);
6145 }
6146
6147 #[test]
6148 #[should_panic]
6149 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6150         let chanmon_cfgs = create_chanmon_cfgs(2);
6151         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6152         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6153         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6154         //Force duplicate channel ids
6155         for node in nodes.iter() {
6156                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6157         }
6158
6159         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6160         let channel_value_satoshis=10000;
6161         let push_msat=10001;
6162         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6163         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6164         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6165
6166         //Create a second channel with a channel_id collision
6167         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6168 }
6169
6170 #[test]
6171 fn bolt2_open_channel_sending_node_checks_part2() {
6172         let chanmon_cfgs = create_chanmon_cfgs(2);
6173         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6174         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6175         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6176
6177         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6178         let channel_value_satoshis=2^24;
6179         let push_msat=10001;
6180         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6181
6182         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6183         let channel_value_satoshis=10000;
6184         // Test when push_msat is equal to 1000 * funding_satoshis.
6185         let push_msat=1000*channel_value_satoshis+1;
6186         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6187
6188         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6189         let channel_value_satoshis=10000;
6190         let push_msat=10001;
6191         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
6192         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6193         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6194
6195         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6196         // 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
6197         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6198
6199         // 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.
6200         assert!(BREAKDOWN_TIMEOUT>0);
6201         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6202
6203         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6204         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6205         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6206
6207         // 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.
6208         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6209         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6210         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6211         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6212         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6213 }
6214
6215 #[test]
6216 fn bolt2_open_channel_sane_dust_limit() {
6217         let chanmon_cfgs = create_chanmon_cfgs(2);
6218         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6219         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6220         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6221
6222         let channel_value_satoshis=1000000;
6223         let push_msat=10001;
6224         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6225         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6226         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6227         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6228
6229         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6230         let events = nodes[1].node.get_and_clear_pending_msg_events();
6231         let err_msg = match events[0] {
6232                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6233                         msg.clone()
6234                 },
6235                 _ => panic!("Unexpected event"),
6236         };
6237         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6238 }
6239
6240 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6241 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6242 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6243 // is no longer affordable once it's freed.
6244 #[test]
6245 fn test_fail_holding_cell_htlc_upon_free() {
6246         let chanmon_cfgs = create_chanmon_cfgs(2);
6247         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6248         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6249         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6250         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6251         let logger = test_utils::TestLogger::new();
6252
6253         // First nodes[0] generates an update_fee, setting the channel's
6254         // pending_update_fee.
6255         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6256         check_added_monitors!(nodes[0], 1);
6257
6258         let events = nodes[0].node.get_and_clear_pending_msg_events();
6259         assert_eq!(events.len(), 1);
6260         let (update_msg, commitment_signed) = match events[0] {
6261                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6262                         (update_fee.as_ref(), commitment_signed)
6263                 },
6264                 _ => panic!("Unexpected event"),
6265         };
6266
6267         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6268
6269         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6270         let channel_reserve = chan_stat.channel_reserve_msat;
6271         let feerate = get_feerate!(nodes[0], chan.2);
6272
6273         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6274         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6275         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6276         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6277         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();
6278
6279         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6280         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6281         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6282         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6283
6284         // Flush the pending fee update.
6285         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6286         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6287         check_added_monitors!(nodes[1], 1);
6288         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6289         check_added_monitors!(nodes[0], 1);
6290
6291         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6292         // HTLC, but now that the fee has been raised the payment will now fail, causing
6293         // us to surface its failure to the user.
6294         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6295         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6296         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);
6297         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 {}",
6298                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6299         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6300
6301         // Check that the payment failed to be sent out.
6302         let events = nodes[0].node.get_and_clear_pending_events();
6303         assert_eq!(events.len(), 1);
6304         match &events[0] {
6305                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6306                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6307                         assert_eq!(*rejected_by_dest, false);
6308                         assert_eq!(*error_code, None);
6309                         assert_eq!(*error_data, None);
6310                 },
6311                 _ => panic!("Unexpected event"),
6312         }
6313 }
6314
6315 // Test that if multiple HTLCs are released from the holding cell and one is
6316 // valid but the other is no longer valid upon release, the valid HTLC can be
6317 // successfully completed while the other one fails as expected.
6318 #[test]
6319 fn test_free_and_fail_holding_cell_htlcs() {
6320         let chanmon_cfgs = create_chanmon_cfgs(2);
6321         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6322         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6323         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6324         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6325         let logger = test_utils::TestLogger::new();
6326
6327         // First nodes[0] generates an update_fee, setting the channel's
6328         // pending_update_fee.
6329         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6330         check_added_monitors!(nodes[0], 1);
6331
6332         let events = nodes[0].node.get_and_clear_pending_msg_events();
6333         assert_eq!(events.len(), 1);
6334         let (update_msg, commitment_signed) = match events[0] {
6335                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6336                         (update_fee.as_ref(), commitment_signed)
6337                 },
6338                 _ => panic!("Unexpected event"),
6339         };
6340
6341         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6342
6343         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6344         let channel_reserve = chan_stat.channel_reserve_msat;
6345         let feerate = get_feerate!(nodes[0], chan.2);
6346
6347         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6348         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6349         let amt_1 = 20000;
6350         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6351         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6352         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6353         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();
6354         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();
6355
6356         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6357         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6358         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6359         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6360         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6361         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6362         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6363
6364         // Flush the pending fee update.
6365         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6366         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6367         check_added_monitors!(nodes[1], 1);
6368         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6369         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6370         check_added_monitors!(nodes[0], 2);
6371
6372         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6373         // but now that the fee has been raised the second payment will now fail, causing us
6374         // to surface its failure to the user. The first payment should succeed.
6375         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6376         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6377         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);
6378         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 {}",
6379                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6380         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6381
6382         // Check that the second payment failed to be sent out.
6383         let events = nodes[0].node.get_and_clear_pending_events();
6384         assert_eq!(events.len(), 1);
6385         match &events[0] {
6386                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6387                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6388                         assert_eq!(*rejected_by_dest, false);
6389                         assert_eq!(*error_code, None);
6390                         assert_eq!(*error_data, None);
6391                 },
6392                 _ => panic!("Unexpected event"),
6393         }
6394
6395         // Complete the first payment and the RAA from the fee update.
6396         let (payment_event, send_raa_event) = {
6397                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6398                 assert_eq!(msgs.len(), 2);
6399                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6400         };
6401         let raa = match send_raa_event {
6402                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6403                 _ => panic!("Unexpected event"),
6404         };
6405         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6406         check_added_monitors!(nodes[1], 1);
6407         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6408         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6409         let events = nodes[1].node.get_and_clear_pending_events();
6410         assert_eq!(events.len(), 1);
6411         match events[0] {
6412                 Event::PendingHTLCsForwardable { .. } => {},
6413                 _ => panic!("Unexpected event"),
6414         }
6415         nodes[1].node.process_pending_htlc_forwards();
6416         let events = nodes[1].node.get_and_clear_pending_events();
6417         assert_eq!(events.len(), 1);
6418         match events[0] {
6419                 Event::PaymentReceived { .. } => {},
6420                 _ => panic!("Unexpected event"),
6421         }
6422         nodes[1].node.claim_funds(payment_preimage_1);
6423         check_added_monitors!(nodes[1], 1);
6424         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6425         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6426         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6427         let events = nodes[0].node.get_and_clear_pending_events();
6428         assert_eq!(events.len(), 1);
6429         match events[0] {
6430                 Event::PaymentSent { ref payment_preimage } => {
6431                         assert_eq!(*payment_preimage, payment_preimage_1);
6432                 }
6433                 _ => panic!("Unexpected event"),
6434         }
6435 }
6436
6437 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6438 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6439 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6440 // once it's freed.
6441 #[test]
6442 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6443         let chanmon_cfgs = create_chanmon_cfgs(3);
6444         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6445         // When this test was written, the default base fee floated based on the HTLC count.
6446         // It is now fixed, so we simply set the fee to the expected value here.
6447         let mut config = test_default_channel_config();
6448         config.channel_options.forwarding_fee_base_msat = 196;
6449         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6450         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6451         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6452         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6453         let logger = test_utils::TestLogger::new();
6454
6455         // First nodes[1] generates an update_fee, setting the channel's
6456         // pending_update_fee.
6457         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6458         check_added_monitors!(nodes[1], 1);
6459
6460         let events = nodes[1].node.get_and_clear_pending_msg_events();
6461         assert_eq!(events.len(), 1);
6462         let (update_msg, commitment_signed) = match events[0] {
6463                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6464                         (update_fee.as_ref(), commitment_signed)
6465                 },
6466                 _ => panic!("Unexpected event"),
6467         };
6468
6469         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6470
6471         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6472         let channel_reserve = chan_stat.channel_reserve_msat;
6473         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6474
6475         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6476         let feemsat = 239;
6477         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6478         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6479         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6480         let payment_event = {
6481                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6482                 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();
6483                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6484                 check_added_monitors!(nodes[0], 1);
6485
6486                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6487                 assert_eq!(events.len(), 1);
6488
6489                 SendEvent::from_event(events.remove(0))
6490         };
6491         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6492         check_added_monitors!(nodes[1], 0);
6493         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6494         expect_pending_htlcs_forwardable!(nodes[1]);
6495
6496         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6497         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6498
6499         // Flush the pending fee update.
6500         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6501         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6502         check_added_monitors!(nodes[2], 1);
6503         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6504         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6505         check_added_monitors!(nodes[1], 2);
6506
6507         // A final RAA message is generated to finalize the fee update.
6508         let events = nodes[1].node.get_and_clear_pending_msg_events();
6509         assert_eq!(events.len(), 1);
6510
6511         let raa_msg = match &events[0] {
6512                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6513                         msg.clone()
6514                 },
6515                 _ => panic!("Unexpected event"),
6516         };
6517
6518         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6519         check_added_monitors!(nodes[2], 1);
6520         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6521
6522         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6523         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6524         assert_eq!(process_htlc_forwards_event.len(), 1);
6525         match &process_htlc_forwards_event[0] {
6526                 &Event::PendingHTLCsForwardable { .. } => {},
6527                 _ => panic!("Unexpected event"),
6528         }
6529
6530         // In response, we call ChannelManager's process_pending_htlc_forwards
6531         nodes[1].node.process_pending_htlc_forwards();
6532         check_added_monitors!(nodes[1], 1);
6533
6534         // This causes the HTLC to be failed backwards.
6535         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6536         assert_eq!(fail_event.len(), 1);
6537         let (fail_msg, commitment_signed) = match &fail_event[0] {
6538                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6539                         assert_eq!(updates.update_add_htlcs.len(), 0);
6540                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6541                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6542                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6543                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6544                 },
6545                 _ => panic!("Unexpected event"),
6546         };
6547
6548         // Pass the failure messages back to nodes[0].
6549         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6550         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6551
6552         // Complete the HTLC failure+removal process.
6553         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6554         check_added_monitors!(nodes[0], 1);
6555         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6556         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6557         check_added_monitors!(nodes[1], 2);
6558         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6559         assert_eq!(final_raa_event.len(), 1);
6560         let raa = match &final_raa_event[0] {
6561                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6562                 _ => panic!("Unexpected event"),
6563         };
6564         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6565         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6566         expect_payment_failed!(nodes[0], our_payment_hash, false);
6567         check_added_monitors!(nodes[0], 1);
6568 }
6569
6570 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6571 // 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.
6572 //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.
6573
6574 #[test]
6575 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6576         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6577         let chanmon_cfgs = create_chanmon_cfgs(2);
6578         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6579         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6580         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6581         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6582
6583         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6584         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6585         let logger = test_utils::TestLogger::new();
6586         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();
6587         route.paths[0][0].fee_msat = 100;
6588
6589         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6590                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6591         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6592         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6593 }
6594
6595 #[test]
6596 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6597         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6598         let chanmon_cfgs = create_chanmon_cfgs(2);
6599         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6600         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6601         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6602         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6603         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6604
6605         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6606         let logger = test_utils::TestLogger::new();
6607         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();
6608         route.paths[0][0].fee_msat = 0;
6609         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6610                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6611
6612         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6613         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6614 }
6615
6616 #[test]
6617 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6618         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6619         let chanmon_cfgs = create_chanmon_cfgs(2);
6620         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6621         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6622         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6623         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6624
6625         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6626         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6627         let logger = test_utils::TestLogger::new();
6628         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();
6629         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6630         check_added_monitors!(nodes[0], 1);
6631         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6632         updates.update_add_htlcs[0].amount_msat = 0;
6633
6634         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6635         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6636         check_closed_broadcast!(nodes[1], true).unwrap();
6637         check_added_monitors!(nodes[1], 1);
6638 }
6639
6640 #[test]
6641 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6642         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6643         //It is enforced when constructing a route.
6644         let chanmon_cfgs = create_chanmon_cfgs(2);
6645         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6646         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6647         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6648         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6649         let logger = test_utils::TestLogger::new();
6650
6651         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6652
6653         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6654         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();
6655         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6656                 assert_eq!(err, &"Channel CLTV overflowed?"));
6657 }
6658
6659 #[test]
6660 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6661         //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.
6662         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6663         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6664         let chanmon_cfgs = create_chanmon_cfgs(2);
6665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6667         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6668         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6669         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6670
6671         let logger = test_utils::TestLogger::new();
6672         for i in 0..max_accepted_htlcs {
6673                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6674                 let payment_event = {
6675                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6676                         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();
6677                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6678                         check_added_monitors!(nodes[0], 1);
6679
6680                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6681                         assert_eq!(events.len(), 1);
6682                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6683                                 assert_eq!(htlcs[0].htlc_id, i);
6684                         } else {
6685                                 assert!(false);
6686                         }
6687                         SendEvent::from_event(events.remove(0))
6688                 };
6689                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6690                 check_added_monitors!(nodes[1], 0);
6691                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6692
6693                 expect_pending_htlcs_forwardable!(nodes[1]);
6694                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6695         }
6696         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6697         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6698         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6699         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6700                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6701
6702         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6703         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6704 }
6705
6706 #[test]
6707 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6708         //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.
6709         let chanmon_cfgs = create_chanmon_cfgs(2);
6710         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6711         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6712         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6713         let channel_value = 100000;
6714         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6715         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6716
6717         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6718
6719         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6720         // Manually create a route over our max in flight (which our router normally automatically
6721         // limits us to.
6722         let route = Route { paths: vec![vec![RouteHop {
6723            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6724            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6725            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6726         }]] };
6727         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6728                 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)));
6729
6730         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6731         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);
6732
6733         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6734 }
6735
6736 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6737 #[test]
6738 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6739         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6740         let chanmon_cfgs = create_chanmon_cfgs(2);
6741         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6742         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6743         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6744         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6745         let htlc_minimum_msat: u64;
6746         {
6747                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6748                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6749                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6750         }
6751
6752         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6753         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6754         let logger = test_utils::TestLogger::new();
6755         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();
6756         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6757         check_added_monitors!(nodes[0], 1);
6758         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6759         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6760         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6761         assert!(nodes[1].node.list_channels().is_empty());
6762         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6763         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()));
6764         check_added_monitors!(nodes[1], 1);
6765 }
6766
6767 #[test]
6768 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6769         //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
6770         let chanmon_cfgs = create_chanmon_cfgs(2);
6771         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6772         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6773         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6774         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6775         let logger = test_utils::TestLogger::new();
6776
6777         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6778         let channel_reserve = chan_stat.channel_reserve_msat;
6779         let feerate = get_feerate!(nodes[0], chan.2);
6780         // The 2* and +1 are for the fee spike reserve.
6781         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6782
6783         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6784         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6785         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6786         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();
6787         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6788         check_added_monitors!(nodes[0], 1);
6789         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6790
6791         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6792         // at this time channel-initiatee receivers are not required to enforce that senders
6793         // respect the fee_spike_reserve.
6794         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6795         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6796
6797         assert!(nodes[1].node.list_channels().is_empty());
6798         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6799         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6800         check_added_monitors!(nodes[1], 1);
6801 }
6802
6803 #[test]
6804 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6805         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6806         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6807         let chanmon_cfgs = create_chanmon_cfgs(2);
6808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6810         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6811         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6812         let logger = test_utils::TestLogger::new();
6813
6814         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6815         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6816
6817         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6818         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();
6819
6820         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6821         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6822         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6823         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6824
6825         let mut msg = msgs::UpdateAddHTLC {
6826                 channel_id: chan.2,
6827                 htlc_id: 0,
6828                 amount_msat: 1000,
6829                 payment_hash: our_payment_hash,
6830                 cltv_expiry: htlc_cltv,
6831                 onion_routing_packet: onion_packet.clone(),
6832         };
6833
6834         for i in 0..super::channel::OUR_MAX_HTLCS {
6835                 msg.htlc_id = i as u64;
6836                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6837         }
6838         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6839         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6840
6841         assert!(nodes[1].node.list_channels().is_empty());
6842         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6843         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6844         check_added_monitors!(nodes[1], 1);
6845 }
6846
6847 #[test]
6848 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6849         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6850         let chanmon_cfgs = create_chanmon_cfgs(2);
6851         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6852         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6853         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6854         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6855         let logger = test_utils::TestLogger::new();
6856
6857         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6858         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6859         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();
6860         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6861         check_added_monitors!(nodes[0], 1);
6862         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6863         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6864         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6865
6866         assert!(nodes[1].node.list_channels().is_empty());
6867         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6868         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6869         check_added_monitors!(nodes[1], 1);
6870 }
6871
6872 #[test]
6873 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6874         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6875         let chanmon_cfgs = create_chanmon_cfgs(2);
6876         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6877         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6878         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6879         let logger = test_utils::TestLogger::new();
6880
6881         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6882         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6883         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6884         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();
6885         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6886         check_added_monitors!(nodes[0], 1);
6887         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6888         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6889         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6890
6891         assert!(nodes[1].node.list_channels().is_empty());
6892         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6893         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6894         check_added_monitors!(nodes[1], 1);
6895 }
6896
6897 #[test]
6898 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6899         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6900         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6901         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6902         let chanmon_cfgs = create_chanmon_cfgs(2);
6903         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6904         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6905         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6906         let logger = test_utils::TestLogger::new();
6907
6908         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6909         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6910         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6911         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();
6912         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6913         check_added_monitors!(nodes[0], 1);
6914         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6915         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6916
6917         //Disconnect and Reconnect
6918         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6919         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6920         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6921         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6922         assert_eq!(reestablish_1.len(), 1);
6923         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6924         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6925         assert_eq!(reestablish_2.len(), 1);
6926         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6927         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6928         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6929         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6930
6931         //Resend HTLC
6932         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6933         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6934         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6935         check_added_monitors!(nodes[1], 1);
6936         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6937
6938         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6939
6940         assert!(nodes[1].node.list_channels().is_empty());
6941         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6942         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6943         check_added_monitors!(nodes[1], 1);
6944 }
6945
6946 #[test]
6947 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6948         //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.
6949
6950         let chanmon_cfgs = create_chanmon_cfgs(2);
6951         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6952         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6953         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6954         let logger = test_utils::TestLogger::new();
6955         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6956         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6957         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6958         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();
6959         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6960
6961         check_added_monitors!(nodes[0], 1);
6962         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6963         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6964
6965         let update_msg = msgs::UpdateFulfillHTLC{
6966                 channel_id: chan.2,
6967                 htlc_id: 0,
6968                 payment_preimage: our_payment_preimage,
6969         };
6970
6971         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6972
6973         assert!(nodes[0].node.list_channels().is_empty());
6974         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6975         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()));
6976         check_added_monitors!(nodes[0], 1);
6977 }
6978
6979 #[test]
6980 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6981         //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.
6982
6983         let chanmon_cfgs = create_chanmon_cfgs(2);
6984         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6985         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6986         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6987         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6988         let logger = test_utils::TestLogger::new();
6989
6990         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6991         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6992         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();
6993         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6994         check_added_monitors!(nodes[0], 1);
6995         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6996         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6997
6998         let update_msg = msgs::UpdateFailHTLC{
6999                 channel_id: chan.2,
7000                 htlc_id: 0,
7001                 reason: msgs::OnionErrorPacket { data: Vec::new()},
7002         };
7003
7004         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7005
7006         assert!(nodes[0].node.list_channels().is_empty());
7007         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7008         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()));
7009         check_added_monitors!(nodes[0], 1);
7010 }
7011
7012 #[test]
7013 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7014         //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.
7015
7016         let chanmon_cfgs = create_chanmon_cfgs(2);
7017         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7018         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7019         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7020         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7021         let logger = test_utils::TestLogger::new();
7022
7023         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7024         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7025         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();
7026         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7027         check_added_monitors!(nodes[0], 1);
7028         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7029         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7030         let update_msg = msgs::UpdateFailMalformedHTLC{
7031                 channel_id: chan.2,
7032                 htlc_id: 0,
7033                 sha256_of_onion: [1; 32],
7034                 failure_code: 0x8000,
7035         };
7036
7037         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7038
7039         assert!(nodes[0].node.list_channels().is_empty());
7040         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7041         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()));
7042         check_added_monitors!(nodes[0], 1);
7043 }
7044
7045 #[test]
7046 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7047         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7048
7049         let chanmon_cfgs = create_chanmon_cfgs(2);
7050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7053         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7054
7055         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7056
7057         nodes[1].node.claim_funds(our_payment_preimage);
7058         check_added_monitors!(nodes[1], 1);
7059
7060         let events = nodes[1].node.get_and_clear_pending_msg_events();
7061         assert_eq!(events.len(), 1);
7062         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7063                 match events[0] {
7064                         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, .. } } => {
7065                                 assert!(update_add_htlcs.is_empty());
7066                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7067                                 assert!(update_fail_htlcs.is_empty());
7068                                 assert!(update_fail_malformed_htlcs.is_empty());
7069                                 assert!(update_fee.is_none());
7070                                 update_fulfill_htlcs[0].clone()
7071                         },
7072                         _ => panic!("Unexpected event"),
7073                 }
7074         };
7075
7076         update_fulfill_msg.htlc_id = 1;
7077
7078         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7079
7080         assert!(nodes[0].node.list_channels().is_empty());
7081         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7082         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7083         check_added_monitors!(nodes[0], 1);
7084 }
7085
7086 #[test]
7087 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7088         //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.
7089
7090         let chanmon_cfgs = create_chanmon_cfgs(2);
7091         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7092         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7093         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7094         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7095
7096         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7097
7098         nodes[1].node.claim_funds(our_payment_preimage);
7099         check_added_monitors!(nodes[1], 1);
7100
7101         let events = nodes[1].node.get_and_clear_pending_msg_events();
7102         assert_eq!(events.len(), 1);
7103         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7104                 match events[0] {
7105                         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, .. } } => {
7106                                 assert!(update_add_htlcs.is_empty());
7107                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7108                                 assert!(update_fail_htlcs.is_empty());
7109                                 assert!(update_fail_malformed_htlcs.is_empty());
7110                                 assert!(update_fee.is_none());
7111                                 update_fulfill_htlcs[0].clone()
7112                         },
7113                         _ => panic!("Unexpected event"),
7114                 }
7115         };
7116
7117         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7118
7119         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7120
7121         assert!(nodes[0].node.list_channels().is_empty());
7122         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7123         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7124         check_added_monitors!(nodes[0], 1);
7125 }
7126
7127 #[test]
7128 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7129         //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.
7130
7131         let chanmon_cfgs = create_chanmon_cfgs(2);
7132         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7134         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7135         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7136         let logger = test_utils::TestLogger::new();
7137
7138         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7139         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7140         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();
7141         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7142         check_added_monitors!(nodes[0], 1);
7143
7144         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7145         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7146
7147         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7148         check_added_monitors!(nodes[1], 0);
7149         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7150
7151         let events = nodes[1].node.get_and_clear_pending_msg_events();
7152
7153         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7154                 match events[0] {
7155                         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, .. } } => {
7156                                 assert!(update_add_htlcs.is_empty());
7157                                 assert!(update_fulfill_htlcs.is_empty());
7158                                 assert!(update_fail_htlcs.is_empty());
7159                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7160                                 assert!(update_fee.is_none());
7161                                 update_fail_malformed_htlcs[0].clone()
7162                         },
7163                         _ => panic!("Unexpected event"),
7164                 }
7165         };
7166         update_msg.failure_code &= !0x8000;
7167         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7168
7169         assert!(nodes[0].node.list_channels().is_empty());
7170         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7171         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7172         check_added_monitors!(nodes[0], 1);
7173 }
7174
7175 #[test]
7176 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7177         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7178         //    * 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.
7179
7180         let chanmon_cfgs = create_chanmon_cfgs(3);
7181         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7182         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7183         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7184         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7185         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7186         let logger = test_utils::TestLogger::new();
7187
7188         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7189
7190         //First hop
7191         let mut payment_event = {
7192                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7193                 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();
7194                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7195                 check_added_monitors!(nodes[0], 1);
7196                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7197                 assert_eq!(events.len(), 1);
7198                 SendEvent::from_event(events.remove(0))
7199         };
7200         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7201         check_added_monitors!(nodes[1], 0);
7202         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7203         expect_pending_htlcs_forwardable!(nodes[1]);
7204         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7205         assert_eq!(events_2.len(), 1);
7206         check_added_monitors!(nodes[1], 1);
7207         payment_event = SendEvent::from_event(events_2.remove(0));
7208         assert_eq!(payment_event.msgs.len(), 1);
7209
7210         //Second Hop
7211         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7212         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7213         check_added_monitors!(nodes[2], 0);
7214         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7215
7216         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7217         assert_eq!(events_3.len(), 1);
7218         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7219                 match events_3[0] {
7220                         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 } } => {
7221                                 assert!(update_add_htlcs.is_empty());
7222                                 assert!(update_fulfill_htlcs.is_empty());
7223                                 assert!(update_fail_htlcs.is_empty());
7224                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7225                                 assert!(update_fee.is_none());
7226                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7227                         },
7228                         _ => panic!("Unexpected event"),
7229                 }
7230         };
7231
7232         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7233
7234         check_added_monitors!(nodes[1], 0);
7235         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7236         expect_pending_htlcs_forwardable!(nodes[1]);
7237         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7238         assert_eq!(events_4.len(), 1);
7239
7240         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7241         match events_4[0] {
7242                 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, .. } } => {
7243                         assert!(update_add_htlcs.is_empty());
7244                         assert!(update_fulfill_htlcs.is_empty());
7245                         assert_eq!(update_fail_htlcs.len(), 1);
7246                         assert!(update_fail_malformed_htlcs.is_empty());
7247                         assert!(update_fee.is_none());
7248                 },
7249                 _ => panic!("Unexpected event"),
7250         };
7251
7252         check_added_monitors!(nodes[1], 1);
7253 }
7254
7255 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7256         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7257         // 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
7258         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7259
7260         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7261         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7262         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7263         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7264         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7265         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7266
7267         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7268
7269         // We route 2 dust-HTLCs between A and B
7270         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7271         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7272         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7273
7274         // Cache one local commitment tx as previous
7275         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7276
7277         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7278         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7279         check_added_monitors!(nodes[1], 0);
7280         expect_pending_htlcs_forwardable!(nodes[1]);
7281         check_added_monitors!(nodes[1], 1);
7282
7283         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7284         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7285         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7286         check_added_monitors!(nodes[0], 1);
7287
7288         // Cache one local commitment tx as lastest
7289         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7290
7291         let events = nodes[0].node.get_and_clear_pending_msg_events();
7292         match events[0] {
7293                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7294                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7295                 },
7296                 _ => panic!("Unexpected event"),
7297         }
7298         match events[1] {
7299                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7300                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7301                 },
7302                 _ => panic!("Unexpected event"),
7303         }
7304
7305         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7306         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7307         if announce_latest {
7308                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7309         } else {
7310                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7311         }
7312
7313         check_closed_broadcast!(nodes[0], true);
7314         check_added_monitors!(nodes[0], 1);
7315
7316         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7317         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7318         let events = nodes[0].node.get_and_clear_pending_events();
7319         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7320         assert_eq!(events.len(), 2);
7321         let mut first_failed = false;
7322         for event in events {
7323                 match event {
7324                         Event::PaymentFailed { payment_hash, .. } => {
7325                                 if payment_hash == payment_hash_1 {
7326                                         assert!(!first_failed);
7327                                         first_failed = true;
7328                                 } else {
7329                                         assert_eq!(payment_hash, payment_hash_2);
7330                                 }
7331                         }
7332                         _ => panic!("Unexpected event"),
7333                 }
7334         }
7335 }
7336
7337 #[test]
7338 fn test_failure_delay_dust_htlc_local_commitment() {
7339         do_test_failure_delay_dust_htlc_local_commitment(true);
7340         do_test_failure_delay_dust_htlc_local_commitment(false);
7341 }
7342
7343 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7344         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7345         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7346         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7347         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7348         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7349         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7350
7351         let chanmon_cfgs = create_chanmon_cfgs(3);
7352         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7353         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7354         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7355         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7356
7357         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7358
7359         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7360         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7361
7362         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7363         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7364
7365         // We revoked bs_commitment_tx
7366         if revoked {
7367                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7368                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7369         }
7370
7371         let mut timeout_tx = Vec::new();
7372         if local {
7373                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7374                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7375                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7376                 expect_payment_failed!(nodes[0], dust_hash, true);
7377
7378                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7379                 check_closed_broadcast!(nodes[0], true);
7380                 check_added_monitors!(nodes[0], 1);
7381                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7382                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7383                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7384                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7385                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7386                 mine_transaction(&nodes[0], &timeout_tx[0]);
7387                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7388                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7389         } else {
7390                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7391                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7392                 check_closed_broadcast!(nodes[0], true);
7393                 check_added_monitors!(nodes[0], 1);
7394                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7395                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7396                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7397                 if !revoked {
7398                         expect_payment_failed!(nodes[0], dust_hash, true);
7399                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7400                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7401                         mine_transaction(&nodes[0], &timeout_tx[0]);
7402                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7403                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7404                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7405                 } else {
7406                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7407                         // commitment tx
7408                         let events = nodes[0].node.get_and_clear_pending_events();
7409                         assert_eq!(events.len(), 2);
7410                         let first;
7411                         match events[0] {
7412                                 Event::PaymentFailed { payment_hash, .. } => {
7413                                         if payment_hash == dust_hash { first = true; }
7414                                         else { first = false; }
7415                                 },
7416                                 _ => panic!("Unexpected event"),
7417                         }
7418                         match events[1] {
7419                                 Event::PaymentFailed { payment_hash, .. } => {
7420                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7421                                         else { assert_eq!(payment_hash, dust_hash); }
7422                                 },
7423                                 _ => panic!("Unexpected event"),
7424                         }
7425                 }
7426         }
7427 }
7428
7429 #[test]
7430 fn test_sweep_outbound_htlc_failure_update() {
7431         do_test_sweep_outbound_htlc_failure_update(false, true);
7432         do_test_sweep_outbound_htlc_failure_update(false, false);
7433         do_test_sweep_outbound_htlc_failure_update(true, false);
7434 }
7435
7436 #[test]
7437 fn test_upfront_shutdown_script() {
7438         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7439         // enforce it at shutdown message
7440
7441         let mut config = UserConfig::default();
7442         config.channel_options.announced_channel = true;
7443         config.peer_channel_config_limits.force_announced_channel_preference = false;
7444         config.channel_options.commit_upfront_shutdown_pubkey = false;
7445         let user_cfgs = [None, Some(config), None];
7446         let chanmon_cfgs = create_chanmon_cfgs(3);
7447         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7448         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7449         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7450
7451         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7452         let flags = InitFeatures::known();
7453         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7454         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7455         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7456         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7457         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7458         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7459     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()));
7460         check_added_monitors!(nodes[2], 1);
7461
7462         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7463         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7464         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7465         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7466         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7467         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7468         let events = nodes[2].node.get_and_clear_pending_msg_events();
7469         assert_eq!(events.len(), 1);
7470         match events[0] {
7471                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7472                 _ => panic!("Unexpected event"),
7473         }
7474
7475         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7476         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7477         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7478         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7479         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7480         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7481         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7482         let events = nodes[1].node.get_and_clear_pending_msg_events();
7483         assert_eq!(events.len(), 1);
7484         match events[0] {
7485                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7486                 _ => panic!("Unexpected event"),
7487         }
7488
7489         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7490         // channel smoothly, opt-out is from channel initiator here
7491         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7492         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7493         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7494         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7495         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7496         let events = nodes[0].node.get_and_clear_pending_msg_events();
7497         assert_eq!(events.len(), 1);
7498         match events[0] {
7499                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7500                 _ => panic!("Unexpected event"),
7501         }
7502
7503         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7504         //// channel smoothly
7505         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7506         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7507         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7508         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7509         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7510         let events = nodes[0].node.get_and_clear_pending_msg_events();
7511         assert_eq!(events.len(), 2);
7512         match events[0] {
7513                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7514                 _ => panic!("Unexpected event"),
7515         }
7516         match events[1] {
7517                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7518                 _ => panic!("Unexpected event"),
7519         }
7520 }
7521
7522 #[test]
7523 fn test_upfront_shutdown_script_unsupport_segwit() {
7524         // We test that channel is closed early
7525         // if a segwit program is passed as upfront shutdown script,
7526         // but the peer does not support segwit.
7527         let chanmon_cfgs = create_chanmon_cfgs(2);
7528         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7530         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7531
7532         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7533
7534         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7535         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7536                 .push_slice(&[0, 0])
7537                 .into_script());
7538
7539         let features = InitFeatures::known().clear_shutdown_anysegwit();
7540         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7541
7542         let events = nodes[0].node.get_and_clear_pending_msg_events();
7543         assert_eq!(events.len(), 1);
7544         match events[0] {
7545                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7546                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7547                         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));
7548                 },
7549                 _ => panic!("Unexpected event"),
7550         }
7551 }
7552
7553 #[test]
7554 fn test_shutdown_script_any_segwit_allowed() {
7555         let mut config = UserConfig::default();
7556         config.channel_options.announced_channel = true;
7557         config.peer_channel_config_limits.force_announced_channel_preference = false;
7558         config.channel_options.commit_upfront_shutdown_pubkey = false;
7559         let user_cfgs = [None, Some(config), None];
7560         let chanmon_cfgs = create_chanmon_cfgs(3);
7561         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7562         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7563         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7564
7565         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7566         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7567         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7568         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7569         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7570                 .push_slice(&[0, 0])
7571                 .into_script();
7572         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7573         let events = nodes[0].node.get_and_clear_pending_msg_events();
7574         assert_eq!(events.len(), 2);
7575         match events[0] {
7576                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7577                 _ => panic!("Unexpected event"),
7578         }
7579         match events[1] {
7580                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7581                 _ => panic!("Unexpected event"),
7582         }
7583 }
7584
7585 #[test]
7586 fn test_shutdown_script_any_segwit_not_allowed() {
7587         let mut config = UserConfig::default();
7588         config.channel_options.announced_channel = true;
7589         config.peer_channel_config_limits.force_announced_channel_preference = false;
7590         config.channel_options.commit_upfront_shutdown_pubkey = false;
7591         let user_cfgs = [None, Some(config), None];
7592         let chanmon_cfgs = create_chanmon_cfgs(3);
7593         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7594         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7595         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7596
7597         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7598         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7599         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7600         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7601         // Make an any segwit version script
7602         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7603                 .push_slice(&[0, 0])
7604                 .into_script();
7605         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7606         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7607         let events = nodes[0].node.get_and_clear_pending_msg_events();
7608         assert_eq!(events.len(), 2);
7609         match events[1] {
7610                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7611                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7612                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7613                 },
7614                 _ => panic!("Unexpected event"),
7615         }
7616         check_added_monitors!(nodes[0], 1);
7617 }
7618
7619 #[test]
7620 fn test_shutdown_script_segwit_but_not_anysegwit() {
7621         let mut config = UserConfig::default();
7622         config.channel_options.announced_channel = true;
7623         config.peer_channel_config_limits.force_announced_channel_preference = false;
7624         config.channel_options.commit_upfront_shutdown_pubkey = false;
7625         let user_cfgs = [None, Some(config), None];
7626         let chanmon_cfgs = create_chanmon_cfgs(3);
7627         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7628         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7629         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7630
7631         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7632         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7633         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7634         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7635         // Make a segwit script that is not a valid as any segwit
7636         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7637                 .push_slice(&[0, 0])
7638                 .into_script();
7639         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7640         let events = nodes[0].node.get_and_clear_pending_msg_events();
7641         assert_eq!(events.len(), 2);
7642         match events[1] {
7643                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7644                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7645                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7646                 },
7647                 _ => panic!("Unexpected event"),
7648         }
7649         check_added_monitors!(nodes[0], 1);
7650 }
7651
7652 #[test]
7653 fn test_user_configurable_csv_delay() {
7654         // We test our channel constructors yield errors when we pass them absurd csv delay
7655
7656         let mut low_our_to_self_config = UserConfig::default();
7657         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7658         let mut high_their_to_self_config = UserConfig::default();
7659         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7660         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7661         let chanmon_cfgs = create_chanmon_cfgs(2);
7662         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7663         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7664         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7665
7666         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7667         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) {
7668                 match error {
7669                         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())); },
7670                         _ => panic!("Unexpected event"),
7671                 }
7672         } else { assert!(false) }
7673
7674         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7675         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7676         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7677         open_channel.to_self_delay = 200;
7678         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) {
7679                 match error {
7680                         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()));  },
7681                         _ => panic!("Unexpected event"),
7682                 }
7683         } else { assert!(false); }
7684
7685         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7686         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7687         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()));
7688         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7689         accept_channel.to_self_delay = 200;
7690         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7691         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7692                 match action {
7693                         &ErrorAction::SendErrorMessage { ref msg } => {
7694                                 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()));
7695                         },
7696                         _ => { assert!(false); }
7697                 }
7698         } else { assert!(false); }
7699
7700         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7701         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7702         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7703         open_channel.to_self_delay = 200;
7704         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) {
7705                 match error {
7706                         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())); },
7707                         _ => panic!("Unexpected event"),
7708                 }
7709         } else { assert!(false); }
7710 }
7711
7712 #[test]
7713 fn test_data_loss_protect() {
7714         // We want to be sure that :
7715         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7716         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7717         // * we close channel in case of detecting other being fallen behind
7718         // * we are able to claim our own outputs thanks to to_remote being static
7719         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7720         let persister;
7721         let logger;
7722         let fee_estimator;
7723         let tx_broadcaster;
7724         let chain_source;
7725         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7726         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7727         // during signing due to revoked tx
7728         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7729         let keys_manager = &chanmon_cfgs[0].keys_manager;
7730         let monitor;
7731         let node_state_0;
7732         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7733         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7734         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7735
7736         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7737
7738         // Cache node A state before any channel update
7739         let previous_node_state = nodes[0].node.encode();
7740         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7741         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7742
7743         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7744         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7745
7746         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7747         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7748
7749         // Restore node A from previous state
7750         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7751         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7752         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7753         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7754         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7755         persister = test_utils::TestPersister::new();
7756         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7757         node_state_0 = {
7758                 let mut channel_monitors = HashMap::new();
7759                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7760                 <(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 {
7761                         keys_manager: keys_manager,
7762                         fee_estimator: &fee_estimator,
7763                         chain_monitor: &monitor,
7764                         logger: &logger,
7765                         tx_broadcaster: &tx_broadcaster,
7766                         default_config: UserConfig::default(),
7767                         channel_monitors,
7768                 }).unwrap().1
7769         };
7770         nodes[0].node = &node_state_0;
7771         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7772         nodes[0].chain_monitor = &monitor;
7773         nodes[0].chain_source = &chain_source;
7774
7775         check_added_monitors!(nodes[0], 1);
7776
7777         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7778         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7779
7780         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7781
7782         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7783         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7784         check_added_monitors!(nodes[0], 1);
7785
7786         {
7787                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7788                 assert_eq!(node_txn.len(), 0);
7789         }
7790
7791         let mut reestablish_1 = Vec::with_capacity(1);
7792         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7793                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7794                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7795                         reestablish_1.push(msg.clone());
7796                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7797                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7798                         match action {
7799                                 &ErrorAction::SendErrorMessage { ref msg } => {
7800                                         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");
7801                                 },
7802                                 _ => panic!("Unexpected event!"),
7803                         }
7804                 } else {
7805                         panic!("Unexpected event")
7806                 }
7807         }
7808
7809         // Check we close channel detecting A is fallen-behind
7810         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7811         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7812         check_added_monitors!(nodes[1], 1);
7813
7814
7815         // Check A is able to claim to_remote output
7816         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7817         assert_eq!(node_txn.len(), 1);
7818         check_spends!(node_txn[0], chan.3);
7819         assert_eq!(node_txn[0].output.len(), 2);
7820         mine_transaction(&nodes[0], &node_txn[0]);
7821         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7822         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7823         assert_eq!(spend_txn.len(), 1);
7824         check_spends!(spend_txn[0], node_txn[0]);
7825 }
7826
7827 #[test]
7828 fn test_check_htlc_underpaying() {
7829         // Send payment through A -> B but A is maliciously
7830         // sending a probe payment (i.e less than expected value0
7831         // to B, B should refuse payment.
7832
7833         let chanmon_cfgs = create_chanmon_cfgs(2);
7834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7836         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7837
7838         // Create some initial channels
7839         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7840
7841         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();
7842         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7843         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7844         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7845         check_added_monitors!(nodes[0], 1);
7846
7847         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7848         assert_eq!(events.len(), 1);
7849         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7850         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7851         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7852
7853         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7854         // and then will wait a second random delay before failing the HTLC back:
7855         expect_pending_htlcs_forwardable!(nodes[1]);
7856         expect_pending_htlcs_forwardable!(nodes[1]);
7857
7858         // Node 3 is expecting payment of 100_000 but received 10_000,
7859         // it should fail htlc like we didn't know the preimage.
7860         nodes[1].node.process_pending_htlc_forwards();
7861
7862         let events = nodes[1].node.get_and_clear_pending_msg_events();
7863         assert_eq!(events.len(), 1);
7864         let (update_fail_htlc, commitment_signed) = match events[0] {
7865                 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 } } => {
7866                         assert!(update_add_htlcs.is_empty());
7867                         assert!(update_fulfill_htlcs.is_empty());
7868                         assert_eq!(update_fail_htlcs.len(), 1);
7869                         assert!(update_fail_malformed_htlcs.is_empty());
7870                         assert!(update_fee.is_none());
7871                         (update_fail_htlcs[0].clone(), commitment_signed)
7872                 },
7873                 _ => panic!("Unexpected event"),
7874         };
7875         check_added_monitors!(nodes[1], 1);
7876
7877         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7878         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7879
7880         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7881         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7882         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7883         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7884 }
7885
7886 #[test]
7887 fn test_announce_disable_channels() {
7888         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7889         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7890
7891         let chanmon_cfgs = create_chanmon_cfgs(2);
7892         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7894         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7895
7896         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7897         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7898         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7899
7900         // Disconnect peers
7901         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7902         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7903
7904         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7905         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7906         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7907         assert_eq!(msg_events.len(), 3);
7908         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7909         for e in msg_events {
7910                 match e {
7911                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7912                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7913                                 // Check that each channel gets updated exactly once
7914                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7915                                         panic!("Generated ChannelUpdate for wrong chan!");
7916                                 }
7917                         },
7918                         _ => panic!("Unexpected event"),
7919                 }
7920         }
7921         // Reconnect peers
7922         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7923         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7924         assert_eq!(reestablish_1.len(), 3);
7925         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7926         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7927         assert_eq!(reestablish_2.len(), 3);
7928
7929         // Reestablish chan_1
7930         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7931         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7932         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7933         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7934         // Reestablish chan_2
7935         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7936         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7937         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7938         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7939         // Reestablish chan_3
7940         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7941         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7942         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7943         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7944
7945         nodes[0].node.timer_tick_occurred();
7946         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7947         nodes[0].node.timer_tick_occurred();
7948         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7949         assert_eq!(msg_events.len(), 3);
7950         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7951         for e in msg_events {
7952                 match e {
7953                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7954                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7955                                 // Check that each channel gets updated exactly once
7956                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7957                                         panic!("Generated ChannelUpdate for wrong chan!");
7958                                 }
7959                         },
7960                         _ => panic!("Unexpected event"),
7961                 }
7962         }
7963 }
7964
7965 #[test]
7966 fn test_priv_forwarding_rejection() {
7967         // If we have a private channel with outbound liquidity, and
7968         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7969         // to forward through that channel.
7970         let chanmon_cfgs = create_chanmon_cfgs(3);
7971         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7972         let mut no_announce_cfg = test_default_channel_config();
7973         no_announce_cfg.channel_options.announced_channel = false;
7974         no_announce_cfg.accept_forwards_to_priv_channels = false;
7975         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7976         let persister: test_utils::TestPersister;
7977         let new_chain_monitor: test_utils::TestChainMonitor;
7978         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7979         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7980
7981         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7982
7983         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7984         // not send for private channels.
7985         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7986         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7987         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7988         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7989         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7990
7991         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7992         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7993         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()));
7994         check_added_monitors!(nodes[2], 1);
7995
7996         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()));
7997         check_added_monitors!(nodes[1], 1);
7998
7999         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
8000         confirm_transaction_at(&nodes[1], &tx, conf_height);
8001         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
8002         confirm_transaction_at(&nodes[2], &tx, conf_height);
8003         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
8004         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
8005         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()));
8006         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8007         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
8008         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8009
8010         assert!(nodes[0].node.list_usable_channels()[0].is_public);
8011         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8012         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
8013
8014         // We should always be able to forward through nodes[1] as long as its out through a public
8015         // channel:
8016         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
8017
8018         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
8019         // to nodes[2], which should be rejected:
8020         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
8021         let route = get_route(&nodes[0].node.get_our_node_id(),
8022                 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8023                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
8024                 &[&RouteHint(vec![RouteHintHop {
8025                         src_node_id: nodes[1].node.get_our_node_id(),
8026                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
8027                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
8028                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
8029                         htlc_minimum_msat: None,
8030                         htlc_maximum_msat: None,
8031                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
8032
8033         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8034         check_added_monitors!(nodes[0], 1);
8035         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
8036         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8037         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
8038
8039         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8040         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
8041         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
8042         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
8043         assert!(htlc_fail_updates.update_fee.is_none());
8044
8045         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
8046         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
8047         expect_payment_failed!(nodes[0], our_payment_hash, false);
8048         expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
8049
8050         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
8051         // to true. Sadly there is currently no way to change it at runtime.
8052
8053         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8054         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8055
8056         let nodes_1_serialized = nodes[1].node.encode();
8057         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
8058         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
8059         {
8060                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
8061                 let mut mon_iter = mons.iter();
8062                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
8063                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
8064         }
8065
8066         persister = test_utils::TestPersister::new();
8067         let keys_manager = &chanmon_cfgs[1].keys_manager;
8068         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);
8069         nodes[1].chain_monitor = &new_chain_monitor;
8070
8071         let mut monitor_a_read = &monitor_a_serialized.0[..];
8072         let mut monitor_b_read = &monitor_b_serialized.0[..];
8073         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
8074         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
8075         assert!(monitor_a_read.is_empty());
8076         assert!(monitor_b_read.is_empty());
8077
8078         no_announce_cfg.accept_forwards_to_priv_channels = true;
8079
8080         let mut nodes_1_read = &nodes_1_serialized[..];
8081         let (_, nodes_1_deserialized_tmp) = {
8082                 let mut channel_monitors = HashMap::new();
8083                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
8084                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
8085                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
8086                         default_config: no_announce_cfg,
8087                         keys_manager,
8088                         fee_estimator: node_cfgs[1].fee_estimator,
8089                         chain_monitor: nodes[1].chain_monitor,
8090                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
8091                         logger: nodes[1].logger,
8092                         channel_monitors,
8093                 }).unwrap()
8094         };
8095         assert!(nodes_1_read.is_empty());
8096         nodes_1_deserialized = nodes_1_deserialized_tmp;
8097
8098         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
8099         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
8100         check_added_monitors!(nodes[1], 2);
8101         nodes[1].node = &nodes_1_deserialized;
8102
8103         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8104         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8105         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8106         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8107         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
8108         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8109         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8110         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
8111
8112         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8113         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8114         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
8115         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8116         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8117         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
8118         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8119         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8120
8121         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8122         check_added_monitors!(nodes[0], 1);
8123         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
8124         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
8125 }
8126
8127 #[test]
8128 fn test_bump_penalty_txn_on_revoked_commitment() {
8129         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8130         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8131
8132         let chanmon_cfgs = create_chanmon_cfgs(2);
8133         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8134         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8135         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8136
8137         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8138         let logger = test_utils::TestLogger::new();
8139
8140         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8141         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8142         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();
8143         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8144
8145         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8146         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8147         assert_eq!(revoked_txn[0].output.len(), 4);
8148         assert_eq!(revoked_txn[0].input.len(), 1);
8149         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8150         let revoked_txid = revoked_txn[0].txid();
8151
8152         let mut penalty_sum = 0;
8153         for outp in revoked_txn[0].output.iter() {
8154                 if outp.script_pubkey.is_v0_p2wsh() {
8155                         penalty_sum += outp.value;
8156                 }
8157         }
8158
8159         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8160         let header_114 = connect_blocks(&nodes[1], 14);
8161
8162         // Actually revoke tx by claiming a HTLC
8163         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8164         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8165         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
8166         check_added_monitors!(nodes[1], 1);
8167
8168         // One or more justice tx should have been broadcast, check it
8169         let penalty_1;
8170         let feerate_1;
8171         {
8172                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8173                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
8174                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8175                 assert_eq!(node_txn[0].output.len(), 1);
8176                 check_spends!(node_txn[0], revoked_txn[0]);
8177                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8178                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8179                 penalty_1 = node_txn[0].txid();
8180                 node_txn.clear();
8181         };
8182
8183         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8184         connect_blocks(&nodes[1], 15);
8185         let mut penalty_2 = penalty_1;
8186         let mut feerate_2 = 0;
8187         {
8188                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8189                 assert_eq!(node_txn.len(), 1);
8190                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8191                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8192                         assert_eq!(node_txn[0].output.len(), 1);
8193                         check_spends!(node_txn[0], revoked_txn[0]);
8194                         penalty_2 = node_txn[0].txid();
8195                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8196                         assert_ne!(penalty_2, penalty_1);
8197                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8198                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8199                         // Verify 25% bump heuristic
8200                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8201                         node_txn.clear();
8202                 }
8203         }
8204         assert_ne!(feerate_2, 0);
8205
8206         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8207         connect_blocks(&nodes[1], 1);
8208         let penalty_3;
8209         let mut feerate_3 = 0;
8210         {
8211                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8212                 assert_eq!(node_txn.len(), 1);
8213                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8214                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8215                         assert_eq!(node_txn[0].output.len(), 1);
8216                         check_spends!(node_txn[0], revoked_txn[0]);
8217                         penalty_3 = node_txn[0].txid();
8218                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8219                         assert_ne!(penalty_3, penalty_2);
8220                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8221                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8222                         // Verify 25% bump heuristic
8223                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8224                         node_txn.clear();
8225                 }
8226         }
8227         assert_ne!(feerate_3, 0);
8228
8229         nodes[1].node.get_and_clear_pending_events();
8230         nodes[1].node.get_and_clear_pending_msg_events();
8231 }
8232
8233 #[test]
8234 fn test_bump_penalty_txn_on_revoked_htlcs() {
8235         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8236         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8237
8238         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8239         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8240         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8241         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8242         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8243
8244         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8245         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8246         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8247                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8248         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8249         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8250                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8251         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8252
8253         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8254         assert_eq!(revoked_local_txn[0].input.len(), 1);
8255         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8256
8257         // Revoke local commitment tx
8258         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8259
8260         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8261         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8262         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8263         check_closed_broadcast!(nodes[1], true);
8264         check_added_monitors!(nodes[1], 1);
8265         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8266
8267         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8268         assert_eq!(revoked_htlc_txn.len(), 3);
8269         check_spends!(revoked_htlc_txn[1], chan.3);
8270
8271         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8272         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8273         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8274
8275         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8276         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8277         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8278         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8279
8280         // Broadcast set of revoked txn on A
8281         let hash_128 = connect_blocks(&nodes[0], 40);
8282         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8283         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8284         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8285         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8286         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8287         let first;
8288         let feerate_1;
8289         let penalty_txn;
8290         {
8291                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8292                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8293                 // Verify claim tx are spending revoked HTLC txn
8294
8295                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8296                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8297                 // which are included in the same block (they are broadcasted because we scan the
8298                 // transactions linearly and generate claims as we go, they likely should be removed in the
8299                 // future).
8300                 assert_eq!(node_txn[0].input.len(), 1);
8301                 check_spends!(node_txn[0], revoked_local_txn[0]);
8302                 assert_eq!(node_txn[1].input.len(), 1);
8303                 check_spends!(node_txn[1], revoked_local_txn[0]);
8304                 assert_eq!(node_txn[2].input.len(), 1);
8305                 check_spends!(node_txn[2], revoked_local_txn[0]);
8306
8307                 // Each of the three justice transactions claim a separate (single) output of the three
8308                 // available, which we check here:
8309                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8310                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8311                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8312
8313                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8314                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8315
8316                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8317                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8318                 // a remote commitment tx has already been confirmed).
8319                 check_spends!(node_txn[3], chan.3);
8320
8321                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8322                 // output, checked above).
8323                 assert_eq!(node_txn[4].input.len(), 2);
8324                 assert_eq!(node_txn[4].output.len(), 1);
8325                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8326
8327                 first = node_txn[4].txid();
8328                 // Store both feerates for later comparison
8329                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8330                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8331                 penalty_txn = vec![node_txn[2].clone()];
8332                 node_txn.clear();
8333         }
8334
8335         // Connect one more block to see if bumped penalty are issued for HTLC txn
8336         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8337         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8338         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8339         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8340         {
8341                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8342                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8343
8344                 check_spends!(node_txn[0], revoked_local_txn[0]);
8345                 check_spends!(node_txn[1], revoked_local_txn[0]);
8346                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8347                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8348                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8349                 } else {
8350                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8351                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8352                 }
8353
8354                 node_txn.clear();
8355         };
8356
8357         // Few more blocks to confirm penalty txn
8358         connect_blocks(&nodes[0], 4);
8359         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8360         let header_144 = connect_blocks(&nodes[0], 9);
8361         let node_txn = {
8362                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8363                 assert_eq!(node_txn.len(), 1);
8364
8365                 assert_eq!(node_txn[0].input.len(), 2);
8366                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8367                 // Verify bumped tx is different and 25% bump heuristic
8368                 assert_ne!(first, node_txn[0].txid());
8369                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8370                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8371                 assert!(feerate_2 * 100 > feerate_1 * 125);
8372                 let txn = vec![node_txn[0].clone()];
8373                 node_txn.clear();
8374                 txn
8375         };
8376         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8377         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8378         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8379         connect_blocks(&nodes[0], 20);
8380         {
8381                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8382                 // We verify than no new transaction has been broadcast because previously
8383                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8384                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8385                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8386                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8387                 // up bumped justice generation.
8388                 assert_eq!(node_txn.len(), 0);
8389                 node_txn.clear();
8390         }
8391         check_closed_broadcast!(nodes[0], true);
8392         check_added_monitors!(nodes[0], 1);
8393 }
8394
8395 #[test]
8396 fn test_bump_penalty_txn_on_remote_commitment() {
8397         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8398         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8399
8400         // Create 2 HTLCs
8401         // Provide preimage for one
8402         // Check aggregation
8403
8404         let chanmon_cfgs = create_chanmon_cfgs(2);
8405         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8406         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8407         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8408
8409         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8410         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8411         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8412
8413         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8414         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8415         assert_eq!(remote_txn[0].output.len(), 4);
8416         assert_eq!(remote_txn[0].input.len(), 1);
8417         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8418
8419         // Claim a HTLC without revocation (provide B monitor with preimage)
8420         nodes[1].node.claim_funds(payment_preimage);
8421         mine_transaction(&nodes[1], &remote_txn[0]);
8422         check_added_monitors!(nodes[1], 2);
8423         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8424
8425         // One or more claim tx should have been broadcast, check it
8426         let timeout;
8427         let preimage;
8428         let preimage_bump;
8429         let feerate_timeout;
8430         let feerate_preimage;
8431         {
8432                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8433                 // 9 transactions including:
8434                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8435                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8436                 // 2 * HTLC-Success (one RBF bump we'll check later)
8437                 // 1 * HTLC-Timeout
8438                 assert_eq!(node_txn.len(), 8);
8439                 assert_eq!(node_txn[0].input.len(), 1);
8440                 assert_eq!(node_txn[6].input.len(), 1);
8441                 check_spends!(node_txn[0], remote_txn[0]);
8442                 check_spends!(node_txn[6], remote_txn[0]);
8443                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8444                 preimage_bump = node_txn[3].clone();
8445
8446                 check_spends!(node_txn[1], chan.3);
8447                 check_spends!(node_txn[2], node_txn[1]);
8448                 assert_eq!(node_txn[1], node_txn[4]);
8449                 assert_eq!(node_txn[2], node_txn[5]);
8450
8451                 timeout = node_txn[6].txid();
8452                 let index = node_txn[6].input[0].previous_output.vout;
8453                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8454                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8455
8456                 preimage = node_txn[0].txid();
8457                 let index = node_txn[0].input[0].previous_output.vout;
8458                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8459                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8460
8461                 node_txn.clear();
8462         };
8463         assert_ne!(feerate_timeout, 0);
8464         assert_ne!(feerate_preimage, 0);
8465
8466         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8467         connect_blocks(&nodes[1], 15);
8468         {
8469                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8470                 assert_eq!(node_txn.len(), 1);
8471                 assert_eq!(node_txn[0].input.len(), 1);
8472                 assert_eq!(preimage_bump.input.len(), 1);
8473                 check_spends!(node_txn[0], remote_txn[0]);
8474                 check_spends!(preimage_bump, remote_txn[0]);
8475
8476                 let index = preimage_bump.input[0].previous_output.vout;
8477                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8478                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8479                 assert!(new_feerate * 100 > feerate_timeout * 125);
8480                 assert_ne!(timeout, preimage_bump.txid());
8481
8482                 let index = node_txn[0].input[0].previous_output.vout;
8483                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8484                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8485                 assert!(new_feerate * 100 > feerate_preimage * 125);
8486                 assert_ne!(preimage, node_txn[0].txid());
8487
8488                 node_txn.clear();
8489         }
8490
8491         nodes[1].node.get_and_clear_pending_events();
8492         nodes[1].node.get_and_clear_pending_msg_events();
8493 }
8494
8495 #[test]
8496 fn test_counterparty_raa_skip_no_crash() {
8497         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8498         // commitment transaction, we would have happily carried on and provided them the next
8499         // commitment transaction based on one RAA forward. This would probably eventually have led to
8500         // channel closure, but it would not have resulted in funds loss. Still, our
8501         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8502         // check simply that the channel is closed in response to such an RAA, but don't check whether
8503         // we decide to punish our counterparty for revoking their funds (as we don't currently
8504         // implement that).
8505         let chanmon_cfgs = create_chanmon_cfgs(2);
8506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8508         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8509         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8510
8511         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8512         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8513         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8514         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8515         // Must revoke without gaps
8516         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8517         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8518                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8519
8520         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8521                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8522         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8523         check_added_monitors!(nodes[1], 1);
8524 }
8525
8526 #[test]
8527 fn test_bump_txn_sanitize_tracking_maps() {
8528         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8529         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8530
8531         let chanmon_cfgs = create_chanmon_cfgs(2);
8532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8535
8536         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8537         // Lock HTLC in both directions
8538         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8539         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8540
8541         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8542         assert_eq!(revoked_local_txn[0].input.len(), 1);
8543         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8544
8545         // Revoke local commitment tx
8546         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8547
8548         // Broadcast set of revoked txn on A
8549         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8550         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8551         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8552
8553         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8554         check_closed_broadcast!(nodes[0], true);
8555         check_added_monitors!(nodes[0], 1);
8556         let penalty_txn = {
8557                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8558                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8559                 check_spends!(node_txn[0], revoked_local_txn[0]);
8560                 check_spends!(node_txn[1], revoked_local_txn[0]);
8561                 check_spends!(node_txn[2], revoked_local_txn[0]);
8562                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8563                 node_txn.clear();
8564                 penalty_txn
8565         };
8566         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8567         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8568         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8569         {
8570                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8571                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8572                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8573                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8574                 }
8575         }
8576 }
8577
8578 #[test]
8579 fn test_override_channel_config() {
8580         let chanmon_cfgs = create_chanmon_cfgs(2);
8581         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8582         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8583         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8584
8585         // Node0 initiates a channel to node1 using the override config.
8586         let mut override_config = UserConfig::default();
8587         override_config.own_channel_config.our_to_self_delay = 200;
8588
8589         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8590
8591         // Assert the channel created by node0 is using the override config.
8592         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8593         assert_eq!(res.channel_flags, 0);
8594         assert_eq!(res.to_self_delay, 200);
8595 }
8596
8597 #[test]
8598 fn test_override_0msat_htlc_minimum() {
8599         let mut zero_config = UserConfig::default();
8600         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8601         let chanmon_cfgs = create_chanmon_cfgs(2);
8602         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8603         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8604         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8605
8606         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8607         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8608         assert_eq!(res.htlc_minimum_msat, 1);
8609
8610         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8611         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8612         assert_eq!(res.htlc_minimum_msat, 1);
8613 }
8614
8615 #[test]
8616 fn test_simple_mpp() {
8617         // Simple test of sending a multi-path payment.
8618         let chanmon_cfgs = create_chanmon_cfgs(4);
8619         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8620         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8621         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8622
8623         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8624         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8625         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8626         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8627         let logger = test_utils::TestLogger::new();
8628
8629         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8630         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8631         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();
8632         let path = route.paths[0].clone();
8633         route.paths.push(path);
8634         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8635         route.paths[0][0].short_channel_id = chan_1_id;
8636         route.paths[0][1].short_channel_id = chan_3_id;
8637         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8638         route.paths[1][0].short_channel_id = chan_2_id;
8639         route.paths[1][1].short_channel_id = chan_4_id;
8640         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8641         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8642 }
8643
8644 #[test]
8645 fn test_preimage_storage() {
8646         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8647         let chanmon_cfgs = create_chanmon_cfgs(2);
8648         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8649         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8650         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8651
8652         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8653
8654         {
8655                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8656
8657                 let logger = test_utils::TestLogger::new();
8658                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8659                 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();
8660                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8661                 check_added_monitors!(nodes[0], 1);
8662                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8663                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8664                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8665                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8666         }
8667         // Note that after leaving the above scope we have no knowledge of any arguments or return
8668         // values from previous calls.
8669         expect_pending_htlcs_forwardable!(nodes[1]);
8670         let events = nodes[1].node.get_and_clear_pending_events();
8671         assert_eq!(events.len(), 1);
8672         match events[0] {
8673                 Event::PaymentReceived { ref purpose, .. } => {
8674                         match &purpose {
8675                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8676                                         assert_eq!(*user_payment_id, 42);
8677                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8678                                 },
8679                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8680                         }
8681                 },
8682                 _ => panic!("Unexpected event"),
8683         }
8684 }
8685
8686 #[test]
8687 fn test_secret_timeout() {
8688         // Simple test of payment secret storage time outs
8689         let chanmon_cfgs = create_chanmon_cfgs(2);
8690         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8691         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8692         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8693
8694         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8695
8696         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8697
8698         // We should fail to register the same payment hash twice, at least until we've connected a
8699         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8700         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8701                 assert_eq!(err, "Duplicate payment hash");
8702         } else { panic!(); }
8703         let mut block = {
8704                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8705                 Block {
8706                         header: BlockHeader {
8707                                 version: 0x2000000,
8708                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8709                                 merkle_root: Default::default(),
8710                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8711                         txdata: vec![],
8712                 }
8713         };
8714         connect_block(&nodes[1], &block);
8715         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8716                 assert_eq!(err, "Duplicate payment hash");
8717         } else { panic!(); }
8718
8719         // If we then connect the second block, we should be able to register the same payment hash
8720         // again with a different user_payment_id (this time getting a new payment secret).
8721         block.header.prev_blockhash = block.header.block_hash();
8722         block.header.time += 1;
8723         connect_block(&nodes[1], &block);
8724         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8725         assert_ne!(payment_secret_1, our_payment_secret);
8726
8727         {
8728                 let logger = test_utils::TestLogger::new();
8729                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8730                 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();
8731                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8732                 check_added_monitors!(nodes[0], 1);
8733                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8734                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8735                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8736                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8737         }
8738         // Note that after leaving the above scope we have no knowledge of any arguments or return
8739         // values from previous calls.
8740         expect_pending_htlcs_forwardable!(nodes[1]);
8741         let events = nodes[1].node.get_and_clear_pending_events();
8742         assert_eq!(events.len(), 1);
8743         match events[0] {
8744                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8745                         assert!(payment_preimage.is_none());
8746                         assert_eq!(user_payment_id, 42);
8747                         assert_eq!(payment_secret, our_payment_secret);
8748                         // We don't actually have the payment preimage with which to claim this payment!
8749                 },
8750                 _ => panic!("Unexpected event"),
8751         }
8752 }
8753
8754 #[test]
8755 fn test_bad_secret_hash() {
8756         // Simple test of unregistered payment hash/invalid payment secret handling
8757         let chanmon_cfgs = create_chanmon_cfgs(2);
8758         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8759         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8760         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8761
8762         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8763
8764         let random_payment_hash = PaymentHash([42; 32]);
8765         let random_payment_secret = PaymentSecret([43; 32]);
8766         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8767
8768         let logger = test_utils::TestLogger::new();
8769         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8770         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();
8771
8772         // All the below cases should end up being handled exactly identically, so we macro the
8773         // resulting events.
8774         macro_rules! handle_unknown_invalid_payment_data {
8775                 () => {
8776                         check_added_monitors!(nodes[0], 1);
8777                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8778                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8779                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8780                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8781
8782                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8783                         // again to process the pending backwards-failure of the HTLC
8784                         expect_pending_htlcs_forwardable!(nodes[1]);
8785                         expect_pending_htlcs_forwardable!(nodes[1]);
8786                         check_added_monitors!(nodes[1], 1);
8787
8788                         // We should fail the payment back
8789                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8790                         match events.pop().unwrap() {
8791                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8792                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8793                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8794                                 },
8795                                 _ => panic!("Unexpected event"),
8796                         }
8797                 }
8798         }
8799
8800         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8801         // Error data is the HTLC value (100,000) and current block height
8802         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8803
8804         // Send a payment with the right payment hash but the wrong payment secret
8805         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8806         handle_unknown_invalid_payment_data!();
8807         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8808
8809         // Send a payment with a random payment hash, but the right payment secret
8810         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8811         handle_unknown_invalid_payment_data!();
8812         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8813
8814         // Send a payment with a random payment hash and random payment secret
8815         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8816         handle_unknown_invalid_payment_data!();
8817         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8818 }
8819
8820 #[test]
8821 fn test_update_err_monitor_lockdown() {
8822         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8823         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8824         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8825         //
8826         // This scenario may happen in a watchtower setup, where watchtower process a block height
8827         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8828         // commitment at same time.
8829
8830         let chanmon_cfgs = create_chanmon_cfgs(2);
8831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8833         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8834
8835         // Create some initial channel
8836         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8837         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8838
8839         // Rebalance the network to generate htlc in the two directions
8840         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8841
8842         // Route a HTLC from node 0 to node 1 (but don't settle)
8843         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8844
8845         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8846         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8847         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8848         let persister = test_utils::TestPersister::new();
8849         let watchtower = {
8850                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8851                 let monitor = monitors.get(&outpoint).unwrap();
8852                 let mut w = test_utils::TestVecWriter(Vec::new());
8853                 monitor.write(&mut w).unwrap();
8854                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8855                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8856                 assert!(new_monitor == *monitor);
8857                 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);
8858                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8859                 watchtower
8860         };
8861         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8862         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8863         // transaction lock time requirements here.
8864         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8865         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8866
8867         // Try to update ChannelMonitor
8868         assert!(nodes[1].node.claim_funds(preimage));
8869         check_added_monitors!(nodes[1], 1);
8870         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8871         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8872         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8873         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8874                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8875                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8876                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8877                 } else { assert!(false); }
8878         } else { assert!(false); };
8879         // Our local monitor is in-sync and hasn't processed yet timeout
8880         check_added_monitors!(nodes[0], 1);
8881         let events = nodes[0].node.get_and_clear_pending_events();
8882         assert_eq!(events.len(), 1);
8883 }
8884
8885 #[test]
8886 fn test_concurrent_monitor_claim() {
8887         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8888         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8889         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8890         // state N+1 confirms. Alice claims output from state N+1.
8891
8892         let chanmon_cfgs = create_chanmon_cfgs(2);
8893         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8894         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8895         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8896
8897         // Create some initial channel
8898         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8899         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8900
8901         // Rebalance the network to generate htlc in the two directions
8902         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8903
8904         // Route a HTLC from node 0 to node 1 (but don't settle)
8905         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8906
8907         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8908         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8909         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8910         let persister = test_utils::TestPersister::new();
8911         let watchtower_alice = {
8912                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8913                 let monitor = monitors.get(&outpoint).unwrap();
8914                 let mut w = test_utils::TestVecWriter(Vec::new());
8915                 monitor.write(&mut w).unwrap();
8916                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8917                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8918                 assert!(new_monitor == *monitor);
8919                 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);
8920                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8921                 watchtower
8922         };
8923         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8924         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8925         // transaction lock time requirements here.
8926         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8927         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8928
8929         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8930         {
8931                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8932                 assert_eq!(txn.len(), 2);
8933                 txn.clear();
8934         }
8935
8936         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8937         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8938         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8939         let persister = test_utils::TestPersister::new();
8940         let watchtower_bob = {
8941                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8942                 let monitor = monitors.get(&outpoint).unwrap();
8943                 let mut w = test_utils::TestVecWriter(Vec::new());
8944                 monitor.write(&mut w).unwrap();
8945                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8946                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8947                 assert!(new_monitor == *monitor);
8948                 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);
8949                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8950                 watchtower
8951         };
8952         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8953         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8954
8955         // Route another payment to generate another update with still previous HTLC pending
8956         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8957         {
8958                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8959                 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();
8960                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8961         }
8962         check_added_monitors!(nodes[1], 1);
8963
8964         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8965         assert_eq!(updates.update_add_htlcs.len(), 1);
8966         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8967         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8968                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8969                         // Watchtower Alice should already have seen the block and reject the update
8970                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8971                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8972                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8973                 } else { assert!(false); }
8974         } else { assert!(false); };
8975         // Our local monitor is in-sync and hasn't processed yet timeout
8976         check_added_monitors!(nodes[0], 1);
8977
8978         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8979         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8980         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8981
8982         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8983         let bob_state_y;
8984         {
8985                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8986                 assert_eq!(txn.len(), 2);
8987                 bob_state_y = txn[0].clone();
8988                 txn.clear();
8989         };
8990
8991         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8992         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8993         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);
8994         {
8995                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8996                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8997                 // the onchain detection of the HTLC output
8998                 assert_eq!(htlc_txn.len(), 2);
8999                 check_spends!(htlc_txn[0], bob_state_y);
9000                 check_spends!(htlc_txn[1], bob_state_y);
9001         }
9002 }
9003
9004 #[test]
9005 fn test_pre_lockin_no_chan_closed_update() {
9006         // Test that if a peer closes a channel in response to a funding_created message we don't
9007         // generate a channel update (as the channel cannot appear on chain without a funding_signed
9008         // message).
9009         //
9010         // Doing so would imply a channel monitor update before the initial channel monitor
9011         // registration, violating our API guarantees.
9012         //
9013         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
9014         // then opening a second channel with the same funding output as the first (which is not
9015         // rejected because the first channel does not exist in the ChannelManager) and closing it
9016         // before receiving funding_signed.
9017         let chanmon_cfgs = create_chanmon_cfgs(2);
9018         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9019         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9020         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9021
9022         // Create an initial channel
9023         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9024         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9025         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9026         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9027         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
9028
9029         // Move the first channel through the funding flow...
9030         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
9031
9032         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9033         check_added_monitors!(nodes[0], 0);
9034
9035         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9036         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
9037         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
9038         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
9039 }
9040
9041 #[test]
9042 fn test_htlc_no_detection() {
9043         // This test is a mutation to underscore the detection logic bug we had
9044         // before #653. HTLC value routed is above the remaining balance, thus
9045         // inverting HTLC and `to_remote` output. HTLC will come second and
9046         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
9047         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
9048         // outputs order detection for correct spending children filtring.
9049
9050         let chanmon_cfgs = create_chanmon_cfgs(2);
9051         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9052         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9053         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9054
9055         // Create some initial channels
9056         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9057
9058         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
9059         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
9060         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
9061         assert_eq!(local_txn[0].input.len(), 1);
9062         assert_eq!(local_txn[0].output.len(), 3);
9063         check_spends!(local_txn[0], chan_1.3);
9064
9065         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9066         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9067         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
9068         // We deliberately connect the local tx twice as this should provoke a failure calling
9069         // this test before #653 fix.
9070         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);
9071         check_closed_broadcast!(nodes[0], true);
9072         check_added_monitors!(nodes[0], 1);
9073         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
9074
9075         let htlc_timeout = {
9076                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9077                 assert_eq!(node_txn[1].input.len(), 1);
9078                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9079                 check_spends!(node_txn[1], local_txn[0]);
9080                 node_txn[1].clone()
9081         };
9082
9083         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9084         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
9085         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
9086         expect_payment_failed!(nodes[0], our_payment_hash, true);
9087 }
9088
9089 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
9090         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
9091         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
9092         // Carol, Alice would be the upstream node, and Carol the downstream.)
9093         //
9094         // Steps of the test:
9095         // 1) Alice sends a HTLC to Carol through Bob.
9096         // 2) Carol doesn't settle the HTLC.
9097         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
9098         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
9099         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
9100         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
9101         // 5) Carol release the preimage to Bob off-chain.
9102         // 6) Bob claims the offered output on the broadcasted commitment.
9103         let chanmon_cfgs = create_chanmon_cfgs(3);
9104         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9105         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9106         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9107
9108         // Create some initial channels
9109         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9110         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9111
9112         // Steps (1) and (2):
9113         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
9114         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
9115
9116         // Check that Alice's commitment transaction now contains an output for this HTLC.
9117         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
9118         check_spends!(alice_txn[0], chan_ab.3);
9119         assert_eq!(alice_txn[0].output.len(), 2);
9120         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
9121         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9122         assert_eq!(alice_txn.len(), 2);
9123
9124         // Steps (3) and (4):
9125         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
9126         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
9127         let mut force_closing_node = 0; // Alice force-closes
9128         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
9129         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
9130         check_closed_broadcast!(nodes[force_closing_node], true);
9131         check_added_monitors!(nodes[force_closing_node], 1);
9132         if go_onchain_before_fulfill {
9133                 let txn_to_broadcast = match broadcast_alice {
9134                         true => alice_txn.clone(),
9135                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
9136                 };
9137                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9138                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9139                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9140                 if broadcast_alice {
9141                         check_closed_broadcast!(nodes[1], true);
9142                         check_added_monitors!(nodes[1], 1);
9143                 }
9144                 assert_eq!(bob_txn.len(), 1);
9145                 check_spends!(bob_txn[0], chan_ab.3);
9146         }
9147
9148         // Step (5):
9149         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
9150         // process of removing the HTLC from their commitment transactions.
9151         assert!(nodes[2].node.claim_funds(payment_preimage));
9152         check_added_monitors!(nodes[2], 1);
9153         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
9154         assert!(carol_updates.update_add_htlcs.is_empty());
9155         assert!(carol_updates.update_fail_htlcs.is_empty());
9156         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
9157         assert!(carol_updates.update_fee.is_none());
9158         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
9159
9160         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
9161         expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
9162         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
9163         if !go_onchain_before_fulfill && broadcast_alice {
9164                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9165                 assert_eq!(events.len(), 1);
9166                 match events[0] {
9167                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
9168                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9169                         },
9170                         _ => panic!("Unexpected event"),
9171                 };
9172         }
9173         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
9174         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
9175         // Carol<->Bob's updated commitment transaction info.
9176         check_added_monitors!(nodes[1], 2);
9177
9178         let events = nodes[1].node.get_and_clear_pending_msg_events();
9179         assert_eq!(events.len(), 2);
9180         let bob_revocation = match events[0] {
9181                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9182                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9183                         (*msg).clone()
9184                 },
9185                 _ => panic!("Unexpected event"),
9186         };
9187         let bob_updates = match events[1] {
9188                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
9189                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9190                         (*updates).clone()
9191                 },
9192                 _ => panic!("Unexpected event"),
9193         };
9194
9195         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
9196         check_added_monitors!(nodes[2], 1);
9197         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
9198         check_added_monitors!(nodes[2], 1);
9199
9200         let events = nodes[2].node.get_and_clear_pending_msg_events();
9201         assert_eq!(events.len(), 1);
9202         let carol_revocation = match events[0] {
9203                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9204                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9205                         (*msg).clone()
9206                 },
9207                 _ => panic!("Unexpected event"),
9208         };
9209         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9210         check_added_monitors!(nodes[1], 1);
9211
9212         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9213         // here's where we put said channel's commitment tx on-chain.
9214         let mut txn_to_broadcast = alice_txn.clone();
9215         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9216         if !go_onchain_before_fulfill {
9217                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9218                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9219                 // If Bob was the one to force-close, he will have already passed these checks earlier.
9220                 if broadcast_alice {
9221                         check_closed_broadcast!(nodes[1], true);
9222                         check_added_monitors!(nodes[1], 1);
9223                 }
9224                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9225                 if broadcast_alice {
9226                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9227                         // new block being connected. The ChannelManager being notified triggers a monitor update,
9228                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9229                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9230                         // broadcasted.
9231                         assert_eq!(bob_txn.len(), 3);
9232                         check_spends!(bob_txn[1], chan_ab.3);
9233                 } else {
9234                         assert_eq!(bob_txn.len(), 2);
9235                         check_spends!(bob_txn[0], chan_ab.3);
9236                 }
9237         }
9238
9239         // Step (6):
9240         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9241         // broadcasted commitment transaction.
9242         {
9243                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9244                 if go_onchain_before_fulfill {
9245                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9246                         assert_eq!(bob_txn.len(), 2);
9247                 }
9248                 let script_weight = match broadcast_alice {
9249                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9250                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9251                 };
9252                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9253                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9254                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9255                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9256                 if broadcast_alice && !go_onchain_before_fulfill {
9257                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9258                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9259                 } else {
9260                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9261                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9262                 }
9263         }
9264 }
9265
9266 #[test]
9267 fn test_onchain_htlc_settlement_after_close() {
9268         do_test_onchain_htlc_settlement_after_close(true, true);
9269         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9270         do_test_onchain_htlc_settlement_after_close(true, false);
9271         do_test_onchain_htlc_settlement_after_close(false, false);
9272 }
9273
9274 #[test]
9275 fn test_duplicate_chan_id() {
9276         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9277         // already open we reject it and keep the old channel.
9278         //
9279         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9280         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9281         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9282         // updating logic for the existing channel.
9283         let chanmon_cfgs = create_chanmon_cfgs(2);
9284         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9285         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9286         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9287
9288         // Create an initial channel
9289         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9290         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9291         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9292         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()));
9293
9294         // Try to create a second channel with the same temporary_channel_id as the first and check
9295         // that it is rejected.
9296         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9297         {
9298                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9299                 assert_eq!(events.len(), 1);
9300                 match events[0] {
9301                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9302                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9303                                 // first (valid) and second (invalid) channels are closed, given they both have
9304                                 // the same non-temporary channel_id. However, currently we do not, so we just
9305                                 // move forward with it.
9306                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9307                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9308                         },
9309                         _ => panic!("Unexpected event"),
9310                 }
9311         }
9312
9313         // Move the first channel through the funding flow...
9314         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9315
9316         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9317         check_added_monitors!(nodes[0], 0);
9318
9319         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9320         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9321         {
9322                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9323                 assert_eq!(added_monitors.len(), 1);
9324                 assert_eq!(added_monitors[0].0, funding_output);
9325                 added_monitors.clear();
9326         }
9327         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9328
9329         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9330         let channel_id = funding_outpoint.to_channel_id();
9331
9332         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9333         // temporary one).
9334
9335         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9336         // Technically this is allowed by the spec, but we don't support it and there's little reason
9337         // to. Still, it shouldn't cause any other issues.
9338         open_chan_msg.temporary_channel_id = channel_id;
9339         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9340         {
9341                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9342                 assert_eq!(events.len(), 1);
9343                 match events[0] {
9344                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9345                                 // Technically, at this point, nodes[1] would be justified in thinking both
9346                                 // channels are closed, but currently we do not, so we just move forward with it.
9347                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9348                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9349                         },
9350                         _ => panic!("Unexpected event"),
9351                 }
9352         }
9353
9354         // Now try to create a second channel which has a duplicate funding output.
9355         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9356         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9357         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9358         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()));
9359         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9360
9361         let funding_created = {
9362                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9363                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9364                 let logger = test_utils::TestLogger::new();
9365                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9366         };
9367         check_added_monitors!(nodes[0], 0);
9368         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9369         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9370         // still needs to be cleared here.
9371         check_added_monitors!(nodes[1], 1);
9372
9373         // ...still, nodes[1] will reject the duplicate channel.
9374         {
9375                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9376                 assert_eq!(events.len(), 1);
9377                 match events[0] {
9378                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9379                                 // Technically, at this point, nodes[1] would be justified in thinking both
9380                                 // channels are closed, but currently we do not, so we just move forward with it.
9381                                 assert_eq!(msg.channel_id, channel_id);
9382                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9383                         },
9384                         _ => panic!("Unexpected event"),
9385                 }
9386         }
9387
9388         // finally, finish creating the original channel and send a payment over it to make sure
9389         // everything is functional.
9390         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9391         {
9392                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9393                 assert_eq!(added_monitors.len(), 1);
9394                 assert_eq!(added_monitors[0].0, funding_output);
9395                 added_monitors.clear();
9396         }
9397
9398         let events_4 = nodes[0].node.get_and_clear_pending_events();
9399         assert_eq!(events_4.len(), 0);
9400         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9401         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9402
9403         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9404         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9405         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9406         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9407 }
9408
9409 #[test]
9410 fn test_error_chans_closed() {
9411         // Test that we properly handle error messages, closing appropriate channels.
9412         //
9413         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9414         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9415         // we can test various edge cases around it to ensure we don't regress.
9416         let chanmon_cfgs = create_chanmon_cfgs(3);
9417         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9418         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9419         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9420
9421         // Create some initial channels
9422         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9423         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9424         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9425
9426         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9427         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9428         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9429
9430         // Closing a channel from a different peer has no effect
9431         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9432         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9433
9434         // Closing one channel doesn't impact others
9435         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9436         check_added_monitors!(nodes[0], 1);
9437         check_closed_broadcast!(nodes[0], false);
9438         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9439         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9440         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);
9441         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);
9442
9443         // A null channel ID should close all channels
9444         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9445         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9446         check_added_monitors!(nodes[0], 2);
9447         let events = nodes[0].node.get_and_clear_pending_msg_events();
9448         assert_eq!(events.len(), 2);
9449         match events[0] {
9450                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9451                         assert_eq!(msg.contents.flags & 2, 2);
9452                 },
9453                 _ => panic!("Unexpected event"),
9454         }
9455         match events[1] {
9456                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9457                         assert_eq!(msg.contents.flags & 2, 2);
9458                 },
9459                 _ => panic!("Unexpected event"),
9460         }
9461         // Note that at this point users of a standard PeerHandler will end up calling
9462         // peer_disconnected with no_connection_possible set to false, duplicating the
9463         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9464         // users with their own peer handling logic. We duplicate the call here, however.
9465         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9466         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9467
9468         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9469         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9470         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9471 }
9472
9473 #[test]
9474 fn test_invalid_funding_tx() {
9475         // Test that we properly handle invalid funding transactions sent to us from a peer.
9476         //
9477         // Previously, all other major lightning implementations had failed to properly sanitize
9478         // funding transactions from their counterparties, leading to a multi-implementation critical
9479         // security vulnerability (though we always sanitized properly, we've previously had
9480         // un-released crashes in the sanitization process).
9481         let chanmon_cfgs = create_chanmon_cfgs(2);
9482         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9483         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9484         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9485
9486         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9487         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()));
9488         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()));
9489
9490         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9491         for output in tx.output.iter_mut() {
9492                 // Make the confirmed funding transaction have a bogus script_pubkey
9493                 output.script_pubkey = bitcoin::Script::new();
9494         }
9495
9496         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9497         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()));
9498         check_added_monitors!(nodes[1], 1);
9499
9500         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()));
9501         check_added_monitors!(nodes[0], 1);
9502
9503         let events_1 = nodes[0].node.get_and_clear_pending_events();
9504         assert_eq!(events_1.len(), 0);
9505
9506         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9507         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9508         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9509
9510         confirm_transaction_at(&nodes[1], &tx, 1);
9511         check_added_monitors!(nodes[1], 1);
9512         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9513         assert_eq!(events_2.len(), 1);
9514         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9515                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9516                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9517                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9518                 } else { panic!(); }
9519         } else { panic!(); }
9520         assert_eq!(nodes[1].node.list_channels().len(), 0);
9521 }
9522
9523 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9524         // In the first version of the chain::Confirm interface, after a refactor was made to not
9525         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9526         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9527         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9528         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9529         // spending transaction until height N+1 (or greater). This was due to the way
9530         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9531         // spending transaction at the height the input transaction was confirmed at, not whether we
9532         // should broadcast a spending transaction at the current height.
9533         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9534         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9535         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9536         // until we learned about an additional block.
9537         //
9538         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9539         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9540         let chanmon_cfgs = create_chanmon_cfgs(3);
9541         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9542         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9543         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9544         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9545
9546         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9547         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9548         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9549         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9550         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9551
9552         nodes[1].node.force_close_channel(&channel_id).unwrap();
9553         check_closed_broadcast!(nodes[1], true);
9554         check_added_monitors!(nodes[1], 1);
9555         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9556         assert_eq!(node_txn.len(), 1);
9557
9558         let conf_height = nodes[1].best_block_info().1;
9559         if !test_height_before_timelock {
9560                 connect_blocks(&nodes[1], 24 * 6);
9561         }
9562         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9563                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9564         if test_height_before_timelock {
9565                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9566                 // generate any events or broadcast any transactions
9567                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9568                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9569         } else {
9570                 // We should broadcast an HTLC transaction spending our funding transaction first
9571                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9572                 assert_eq!(spending_txn.len(), 2);
9573                 assert_eq!(spending_txn[0], node_txn[0]);
9574                 check_spends!(spending_txn[1], node_txn[0]);
9575                 // We should also generate a SpendableOutputs event with the to_self output (as its
9576                 // timelock is up).
9577                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9578                 assert_eq!(descriptor_spend_txn.len(), 1);
9579
9580                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9581                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9582                 // additional block built on top of the current chain.
9583                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9584                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9585                 expect_pending_htlcs_forwardable!(nodes[1]);
9586                 check_added_monitors!(nodes[1], 1);
9587
9588                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9589                 assert!(updates.update_add_htlcs.is_empty());
9590                 assert!(updates.update_fulfill_htlcs.is_empty());
9591                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9592                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9593                 assert!(updates.update_fee.is_none());
9594                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9595                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9596                 expect_payment_failed!(nodes[0], payment_hash, false);
9597                 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9598         }
9599 }
9600
9601 #[test]
9602 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9603         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9604         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9605 }
9606
9607 #[test]
9608 fn test_keysend_payments_to_public_node() {
9609         let chanmon_cfgs = create_chanmon_cfgs(2);
9610         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9611         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9612         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9613
9614         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9615         let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9616         let payer_pubkey = nodes[0].node.get_our_node_id();
9617         let payee_pubkey = nodes[1].node.get_our_node_id();
9618         let route = get_route(&payer_pubkey, &network_graph, &payee_pubkey, None,
9619                         None, &vec![], 10000, 40,
9620                         nodes[0].logger).unwrap();
9621
9622         let test_preimage = PaymentPreimage([42; 32]);
9623         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9624         check_added_monitors!(nodes[0], 1);
9625         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9626         assert_eq!(events.len(), 1);
9627         let event = events.pop().unwrap();
9628         let path = vec![&nodes[1]];
9629         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9630         claim_payment(&nodes[0], &path, test_preimage);
9631 }
9632
9633 #[test]
9634 fn test_keysend_payments_to_private_node() {
9635         let chanmon_cfgs = create_chanmon_cfgs(2);
9636         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9637         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9638         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9639
9640         let payer_pubkey = nodes[0].node.get_our_node_id();
9641         let payee_pubkey = nodes[1].node.get_our_node_id();
9642         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9643         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9644
9645         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9646         let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9647         let first_hops = nodes[0].node.list_usable_channels();
9648         let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9649                                 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9650                                 nodes[0].logger).unwrap();
9651
9652         let test_preimage = PaymentPreimage([42; 32]);
9653         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9654         check_added_monitors!(nodes[0], 1);
9655         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9656         assert_eq!(events.len(), 1);
9657         let event = events.pop().unwrap();
9658         let path = vec![&nodes[1]];
9659         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9660         claim_payment(&nodes[0], &path, test_preimage);
9661 }