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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain;
  15 use chain::{Confirm, Listen, Watch};
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface::{KeysInterface, BaseSign};
  20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
  26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route};
  27 use routing::network_graph::RoutingFees;
  28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  29 use ln::msgs;
  30 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  31 use util::enforcing_trait_impls::EnforcingSigner;
  32 use util::{byte_utils, test_utils};
  33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
  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 std::sync::{Arc, Mutex};
  58
  59 use ln::functional_test_utils::*;
  60 use ln::chan_utils::CommitmentTransaction;
  61 use ln::msgs::OptionalField::Present;
  62
  63 #[test]
  64 fn test_insane_channel_opens() {
  65         // Stand up a network of 2 nodes
  66         let chanmon_cfgs = create_chanmon_cfgs(2);
  67         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  68         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  69         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  70
  71         // Instantiate channel parameters where we push the maximum msats given our
  72         // funding satoshis
  73         let channel_value_sat = 31337; // same as funding satoshis
  74         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  75         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  76
  77         // Have node0 initiate a channel to node1 with aforementioned parameters
  78         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  79
  80         // Extract the channel open message from node0 to node1
  81         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  82
  83         // Test helper that asserts we get the correct error string given a mutator
  84         // that supposedly makes the channel open message insane
  85         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  86                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  87                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  88                 assert_eq!(msg_events.len(), 1);
  89                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  90                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  91                         match action {
  92                                 &ErrorAction::SendErrorMessage { .. } => {
  93                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  94                                 },
  95                                 _ => panic!("unexpected event!"),
  96                         }
  97                 } else { assert!(false); }
  98         };
  99
 100         use ln::channel::MAX_FUNDING_SATOSHIS;
 101         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 102
 103         // Test all mutations that would make the channel open message insane
 104         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 105
 106         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 107
 108         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 109
 110         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 111
 112         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 113
 114         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 115
 116         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 117
 118         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 119
 120         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 121 }
 122
 123 #[test]
 124 fn test_async_inbound_update_fee() {
 125         let chanmon_cfgs = create_chanmon_cfgs(2);
 126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 128         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 129         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 130         let logger = test_utils::TestLogger::new();
 131         let channel_id = chan.2;
 132
 133         // balancing
 134         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 135
 136         // A                                        B
 137         // update_fee                            ->
 138         // send (1) commitment_signed            -.
 139         //                                       <- update_add_htlc/commitment_signed
 140         // send (2) RAA (awaiting remote revoke) -.
 141         // (1) commitment_signed is delivered    ->
 142         //                                       .- send (3) RAA (awaiting remote revoke)
 143         // (2) RAA is delivered                  ->
 144         //                                       .- send (4) commitment_signed
 145         //                                       <- (3) RAA is delivered
 146         // send (5) commitment_signed            -.
 147         //                                       <- (4) commitment_signed is delivered
 148         // send (6) RAA                          -.
 149         // (5) commitment_signed is delivered    ->
 150         //                                       <- RAA
 151         // (6) RAA is delivered                  ->
 152
 153         // First nodes[0] generates an update_fee
 154         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 155         check_added_monitors!(nodes[0], 1);
 156
 157         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 158         assert_eq!(events_0.len(), 1);
 159         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 160                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 161                         (update_fee.as_ref(), commitment_signed)
 162                 },
 163                 _ => panic!("Unexpected event"),
 164         };
 165
 166         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 167
 168         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 169         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 170         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 171         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 172         check_added_monitors!(nodes[1], 1);
 173
 174         let payment_event = {
 175                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 176                 assert_eq!(events_1.len(), 1);
 177                 SendEvent::from_event(events_1.remove(0))
 178         };
 179         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 180         assert_eq!(payment_event.msgs.len(), 1);
 181
 182         // ...now when the messages get delivered everyone should be happy
 183         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 184         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 185         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 186         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 187         check_added_monitors!(nodes[0], 1);
 188
 189         // deliver(1), generate (3):
 190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 191         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 192         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 193         check_added_monitors!(nodes[1], 1);
 194
 195         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 196         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 197         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fee.is_none()); // (4)
 202         check_added_monitors!(nodes[1], 1);
 203
 204         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 205         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 206         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fee.is_none()); // (5)
 211         check_added_monitors!(nodes[0], 1);
 212
 213         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 214         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 215         // only (6) so get_event_msg's assert(len == 1) passes
 216         check_added_monitors!(nodes[0], 1);
 217
 218         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 219         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 220         check_added_monitors!(nodes[1], 1);
 221
 222         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 223         check_added_monitors!(nodes[0], 1);
 224
 225         let events_2 = nodes[0].node.get_and_clear_pending_events();
 226         assert_eq!(events_2.len(), 1);
 227         match events_2[0] {
 228                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 229                 _ => panic!("Unexpected event"),
 230         }
 231
 232         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 233         check_added_monitors!(nodes[1], 1);
 234 }
 235
 236 #[test]
 237 fn test_update_fee_unordered_raa() {
 238         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 239         // crash in an earlier version of the update_fee patch)
 240         let chanmon_cfgs = create_chanmon_cfgs(2);
 241         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 242         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 243         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 244         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 245         let channel_id = chan.2;
 246         let logger = test_utils::TestLogger::new();
 247
 248         // balancing
 249         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 250
 251         // First nodes[0] generates an update_fee
 252         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 253         check_added_monitors!(nodes[0], 1);
 254
 255         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 256         assert_eq!(events_0.len(), 1);
 257         let update_msg = match events_0[0] { // (1)
 258                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 259                         update_fee.as_ref()
 260                 },
 261                 _ => panic!("Unexpected event"),
 262         };
 263
 264         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 265
 266         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 267         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 268         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 269         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 270         check_added_monitors!(nodes[1], 1);
 271
 272         let payment_event = {
 273                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 274                 assert_eq!(events_1.len(), 1);
 275                 SendEvent::from_event(events_1.remove(0))
 276         };
 277         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 278         assert_eq!(payment_event.msgs.len(), 1);
 279
 280         // ...now when the messages get delivered everyone should be happy
 281         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 282         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 283         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 284         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 285         check_added_monitors!(nodes[0], 1);
 286
 287         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 288         check_added_monitors!(nodes[1], 1);
 289
 290         // We can't continue, sadly, because our (1) now has a bogus signature
 291 }
 292
 293 #[test]
 294 fn test_multi_flight_update_fee() {
 295         let chanmon_cfgs = create_chanmon_cfgs(2);
 296         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 297         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 298         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 299         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 300         let channel_id = chan.2;
 301
 302         // A                                        B
 303         // update_fee/commitment_signed          ->
 304         //                                       .- send (1) RAA and (2) commitment_signed
 305         // update_fee (never committed)          ->
 306         // (3) update_fee                        ->
 307         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 308         // don't track which updates correspond to which revoke_and_ack responses so we're in
 309         // AwaitingRAA mode and will not generate the update_fee yet.
 310         //                                       <- (1) RAA delivered
 311         // (3) is generated and send (4) CS      -.
 312         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 313         // know the per_commitment_point to use for it.
 314         //                                       <- (2) commitment_signed delivered
 315         // revoke_and_ack                        ->
 316         //                                          B should send no response here
 317         // (4) commitment_signed delivered       ->
 318         //                                       <- RAA/commitment_signed delivered
 319         // revoke_and_ack                        ->
 320
 321         // First nodes[0] generates an update_fee
 322         let initial_feerate = get_feerate!(nodes[0], channel_id);
 323         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 324         check_added_monitors!(nodes[0], 1);
 325
 326         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 327         assert_eq!(events_0.len(), 1);
 328         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 329                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 330                         (update_fee.as_ref().unwrap(), commitment_signed)
 331                 },
 332                 _ => panic!("Unexpected event"),
 333         };
 334
 335         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 336         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 337         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 338         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 339         check_added_monitors!(nodes[1], 1);
 340
 341         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 342         // transaction:
 343         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 344         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 346
 347         // Create the (3) update_fee message that nodes[0] will generate before it does...
 348         let mut update_msg_2 = msgs::UpdateFee {
 349                 channel_id: update_msg_1.channel_id.clone(),
 350                 feerate_per_kw: (initial_feerate + 30) as u32,
 351         };
 352
 353         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 354
 355         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 356         // Deliver (3)
 357         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 358
 359         // Deliver (1), generating (3) and (4)
 360         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 361         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 362         check_added_monitors!(nodes[0], 1);
 363         assert!(as_second_update.update_add_htlcs.is_empty());
 364         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 365         assert!(as_second_update.update_fail_htlcs.is_empty());
 366         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 367         // Check that the update_fee newly generated matches what we delivered:
 368         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 369         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 370
 371         // Deliver (2) commitment_signed
 372         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 373         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 374         check_added_monitors!(nodes[0], 1);
 375         // No commitment_signed so get_event_msg's assert(len == 1) passes
 376
 377         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 378         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 379         check_added_monitors!(nodes[1], 1);
 380
 381         // Delever (4)
 382         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 383         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 384         check_added_monitors!(nodes[1], 1);
 385
 386         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 387         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 388         check_added_monitors!(nodes[0], 1);
 389
 390         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 391         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 392         // No commitment_signed so get_event_msg's assert(len == 1) passes
 393         check_added_monitors!(nodes[0], 1);
 394
 395         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 396         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 397         check_added_monitors!(nodes[1], 1);
 398 }
 399
 400 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 401         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 402         // tests that we properly send one in that case.
 403         let mut alice_config = UserConfig::default();
 404         alice_config.own_channel_config.minimum_depth = 1;
 405         alice_config.channel_options.announced_channel = true;
 406         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 407         let mut bob_config = UserConfig::default();
 408         bob_config.own_channel_config.minimum_depth = 1;
 409         bob_config.channel_options.announced_channel = true;
 410         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 411         let chanmon_cfgs = create_chanmon_cfgs(2);
 412         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 413         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 414         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 415         *nodes[0].connect_style.borrow_mut() = connect_style;
 416
 417         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 418         mine_transaction(&nodes[1], &tx);
 419         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 420
 421         mine_transaction(&nodes[0], &tx);
 422         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 423         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 424
 425         for node in nodes {
 426                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 427                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 428                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 429         }
 430 }
 431 #[test]
 432 fn test_1_conf_open() {
 433         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 434         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 435         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 436 }
 437
 438 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 439         // Previously, we had issues deserializing channels when we hadn't connected the first block
 440         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 441         // serialization round-trips and simply do steps towards opening a channel and then drop the
 442         // Node objects.
 443
 444         let chanmon_cfgs = create_chanmon_cfgs(2);
 445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 448
 449         if steps & 0b1000_0000 != 0{
 450                 let block = Block {
 451                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 452                         txdata: vec![],
 453                 };
 454                 connect_block(&nodes[0], &block);
 455                 connect_block(&nodes[1], &block);
 456         }
 457
 458         if steps & 0x0f == 0 { return; }
 459         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 460         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 461
 462         if steps & 0x0f == 1 { return; }
 463         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 464         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 465
 466         if steps & 0x0f == 2 { return; }
 467         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 468
 469         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 470
 471         if steps & 0x0f == 3 { return; }
 472         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 473         check_added_monitors!(nodes[0], 0);
 474         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 475
 476         if steps & 0x0f == 4 { return; }
 477         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 478         {
 479                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 480                 assert_eq!(added_monitors.len(), 1);
 481                 assert_eq!(added_monitors[0].0, funding_output);
 482                 added_monitors.clear();
 483         }
 484         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 485
 486         if steps & 0x0f == 5 { return; }
 487         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 488         {
 489                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 490                 assert_eq!(added_monitors.len(), 1);
 491                 assert_eq!(added_monitors[0].0, funding_output);
 492                 added_monitors.clear();
 493         }
 494
 495         let events_4 = nodes[0].node.get_and_clear_pending_events();
 496         assert_eq!(events_4.len(), 0);
 497
 498         if steps & 0x0f == 6 { return; }
 499         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 500
 501         if steps & 0x0f == 7 { return; }
 502         confirm_transaction_at(&nodes[0], &tx, 2);
 503         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 504         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 505 }
 506
 507 #[test]
 508 fn test_sanity_on_in_flight_opens() {
 509         do_test_sanity_on_in_flight_opens(0);
 510         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(1);
 512         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(2);
 514         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(3);
 516         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(4);
 518         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(5);
 520         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(6);
 522         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(7);
 524         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(8);
 526         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 527 }
 528
 529 #[test]
 530 fn test_update_fee_vanilla() {
 531         let chanmon_cfgs = create_chanmon_cfgs(2);
 532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 535         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 536         let channel_id = chan.2;
 537
 538         let feerate = get_feerate!(nodes[0], channel_id);
 539         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 540         check_added_monitors!(nodes[0], 1);
 541
 542         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 543         assert_eq!(events_0.len(), 1);
 544         let (update_msg, commitment_signed) = match events_0[0] {
 545                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 546                         (update_fee.as_ref(), commitment_signed)
 547                 },
 548                 _ => panic!("Unexpected event"),
 549         };
 550         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 551
 552         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 553         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 554         check_added_monitors!(nodes[1], 1);
 555
 556         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[0], 1);
 559
 560         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 561         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 562         // No commitment_signed so get_event_msg's assert(len == 1) passes
 563         check_added_monitors!(nodes[0], 1);
 564
 565         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 567         check_added_monitors!(nodes[1], 1);
 568 }
 569
 570 #[test]
 571 fn test_update_fee_that_funder_cannot_afford() {
 572         let chanmon_cfgs = create_chanmon_cfgs(2);
 573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 575         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 576         let channel_value = 1888;
 577         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 578         let channel_id = chan.2;
 579
 580         let feerate = 260;
 581         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 582         check_added_monitors!(nodes[0], 1);
 583         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 584
 585         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 586
 587         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 588
 589         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 590         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 591         {
 592                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 593
 594                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 595                 let num_htlcs = commitment_tx.output.len() - 2;
 596                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 597                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 598                 actual_fee = channel_value - actual_fee;
 599                 assert_eq!(total_fee, actual_fee);
 600         }
 601
 602         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 603         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 604         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 605         check_added_monitors!(nodes[0], 1);
 606
 607         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 608
 609         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 610
 611         //While producing the commitment_signed response after handling a received update_fee request the
 612         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 613         //Should produce and error.
 614         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 615         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 616         check_added_monitors!(nodes[1], 1);
 617         check_closed_broadcast!(nodes[1], true);
 618 }
 619
 620 #[test]
 621 fn test_update_fee_with_fundee_update_add_htlc() {
 622         let chanmon_cfgs = create_chanmon_cfgs(2);
 623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 626         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 627         let channel_id = chan.2;
 628         let logger = test_utils::TestLogger::new();
 629
 630         // balancing
 631         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 632
 633         let feerate = get_feerate!(nodes[0], channel_id);
 634         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 635         check_added_monitors!(nodes[0], 1);
 636
 637         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 638         assert_eq!(events_0.len(), 1);
 639         let (update_msg, commitment_signed) = match events_0[0] {
 640                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 641                         (update_fee.as_ref(), commitment_signed)
 642                 },
 643                 _ => panic!("Unexpected event"),
 644         };
 645         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 646         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 647         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         check_added_monitors!(nodes[1], 1);
 649
 650         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 651         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 652         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 653
 654         // nothing happens since node[1] is in AwaitingRemoteRevoke
 655         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 656         {
 657                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 658                 assert_eq!(added_monitors.len(), 0);
 659                 added_monitors.clear();
 660         }
 661         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 663         // node[1] has nothing to do
 664
 665         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         check_added_monitors!(nodes[0], 1);
 668
 669         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 670         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 671         // No commitment_signed so get_event_msg's assert(len == 1) passes
 672         check_added_monitors!(nodes[0], 1);
 673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 674         check_added_monitors!(nodes[1], 1);
 675         // AwaitingRemoteRevoke ends here
 676
 677         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 678         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 679         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 681         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 682         assert_eq!(commitment_update.update_fee.is_none(), true);
 683
 684         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 685         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 686         check_added_monitors!(nodes[0], 1);
 687         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 688
 689         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 690         check_added_monitors!(nodes[1], 1);
 691         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 692
 693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 694         check_added_monitors!(nodes[1], 1);
 695         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 696         // No commitment_signed so get_event_msg's assert(len == 1) passes
 697
 698         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 699         check_added_monitors!(nodes[0], 1);
 700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 701
 702         expect_pending_htlcs_forwardable!(nodes[0]);
 703
 704         let events = nodes[0].node.get_and_clear_pending_events();
 705         assert_eq!(events.len(), 1);
 706         match events[0] {
 707                 Event::PaymentReceived { .. } => { },
 708                 _ => panic!("Unexpected event"),
 709         };
 710
 711         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 712
 713         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 714         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 715         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 716 }
 717
 718 #[test]
 719 fn test_update_fee() {
 720         let chanmon_cfgs = create_chanmon_cfgs(2);
 721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 724         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 725         let channel_id = chan.2;
 726
 727         // A                                        B
 728         // (1) update_fee/commitment_signed      ->
 729         //                                       <- (2) revoke_and_ack
 730         //                                       .- send (3) commitment_signed
 731         // (4) update_fee/commitment_signed      ->
 732         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 733         //                                       <- (3) commitment_signed delivered
 734         // send (6) revoke_and_ack               -.
 735         //                                       <- (5) deliver revoke_and_ack
 736         // (6) deliver revoke_and_ack            ->
 737         //                                       .- send (7) commitment_signed in response to (4)
 738         //                                       <- (7) deliver commitment_signed
 739         // revoke_and_ack                        ->
 740
 741         // Create and deliver (1)...
 742         let feerate = get_feerate!(nodes[0], channel_id);
 743         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 744         check_added_monitors!(nodes[0], 1);
 745
 746         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(events_0.len(), 1);
 748         let (update_msg, commitment_signed) = match events_0[0] {
 749                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 750                         (update_fee.as_ref(), commitment_signed)
 751                 },
 752                 _ => panic!("Unexpected event"),
 753         };
 754         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 755
 756         // Generate (2) and (3):
 757         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 758         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 759         check_added_monitors!(nodes[1], 1);
 760
 761         // Deliver (2):
 762         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 763         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 764         check_added_monitors!(nodes[0], 1);
 765
 766         // Create and deliver (4)...
 767         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 768         check_added_monitors!(nodes[0], 1);
 769         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 770         assert_eq!(events_0.len(), 1);
 771         let (update_msg, commitment_signed) = match events_0[0] {
 772                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 773                         (update_fee.as_ref(), commitment_signed)
 774                 },
 775                 _ => panic!("Unexpected event"),
 776         };
 777
 778         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 779         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 780         check_added_monitors!(nodes[1], 1);
 781         // ... creating (5)
 782         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 783         // No commitment_signed so get_event_msg's assert(len == 1) passes
 784
 785         // Handle (3), creating (6):
 786         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 787         check_added_monitors!(nodes[0], 1);
 788         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 789         // No commitment_signed so get_event_msg's assert(len == 1) passes
 790
 791         // Deliver (5):
 792         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 793         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 794         check_added_monitors!(nodes[0], 1);
 795
 796         // Deliver (6), creating (7):
 797         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 798         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 799         assert!(commitment_update.update_add_htlcs.is_empty());
 800         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 801         assert!(commitment_update.update_fail_htlcs.is_empty());
 802         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 803         assert!(commitment_update.update_fee.is_none());
 804         check_added_monitors!(nodes[1], 1);
 805
 806         // Deliver (7)
 807         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 808         check_added_monitors!(nodes[0], 1);
 809         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 810         // No commitment_signed so get_event_msg's assert(len == 1) passes
 811
 812         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 813         check_added_monitors!(nodes[1], 1);
 814         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 815
 816         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 817         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 818         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 819 }
 820
 821 #[test]
 822 fn pre_funding_lock_shutdown_test() {
 823         // Test sending a shutdown prior to funding_locked after funding generation
 824         let chanmon_cfgs = create_chanmon_cfgs(2);
 825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 828         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 829         mine_transaction(&nodes[0], &tx);
 830         mine_transaction(&nodes[1], &tx);
 831
 832         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 833         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 834         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 835         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 836         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 837
 838         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 840         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 842         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 843         assert!(node_0_none.is_none());
 844
 845         assert!(nodes[0].node.list_channels().is_empty());
 846         assert!(nodes[1].node.list_channels().is_empty());
 847 }
 848
 849 #[test]
 850 fn updates_shutdown_wait() {
 851         // Test sending a shutdown with outstanding updates pending
 852         let chanmon_cfgs = create_chanmon_cfgs(3);
 853         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 854         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 855         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 856         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 857         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 858         let logger = test_utils::TestLogger::new();
 859
 860         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 861
 862         nodes[0].node.close_channel(&chan_1.2).unwrap();
 863         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 864         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 865         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 866         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 867
 868         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 869         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 870
 871         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 872
 873         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 874         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 875         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 876         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 877         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 878         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 879
 880         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 881         check_added_monitors!(nodes[2], 1);
 882         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 883         assert!(updates.update_add_htlcs.is_empty());
 884         assert!(updates.update_fail_htlcs.is_empty());
 885         assert!(updates.update_fail_malformed_htlcs.is_empty());
 886         assert!(updates.update_fee.is_none());
 887         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 888         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 889         check_added_monitors!(nodes[1], 1);
 890         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 891         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 892
 893         assert!(updates_2.update_add_htlcs.is_empty());
 894         assert!(updates_2.update_fail_htlcs.is_empty());
 895         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 896         assert!(updates_2.update_fee.is_none());
 897         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 898         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 899         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 900
 901         let events = nodes[0].node.get_and_clear_pending_events();
 902         assert_eq!(events.len(), 1);
 903         match events[0] {
 904                 Event::PaymentSent { ref payment_preimage } => {
 905                         assert_eq!(our_payment_preimage, *payment_preimage);
 906                 },
 907                 _ => panic!("Unexpected event"),
 908         }
 909
 910         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 911         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 912         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 913         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 914         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 915         assert!(node_0_none.is_none());
 916
 917         assert!(nodes[0].node.list_channels().is_empty());
 918
 919         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 920         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 921         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 922         assert!(nodes[1].node.list_channels().is_empty());
 923         assert!(nodes[2].node.list_channels().is_empty());
 924 }
 925
 926 #[test]
 927 fn htlc_fail_async_shutdown() {
 928         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 929         let chanmon_cfgs = create_chanmon_cfgs(3);
 930         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 931         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 932         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 933         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 934         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 935         let logger = test_utils::TestLogger::new();
 936
 937         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 938         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 939         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 940         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 941         check_added_monitors!(nodes[0], 1);
 942         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 943         assert_eq!(updates.update_add_htlcs.len(), 1);
 944         assert!(updates.update_fulfill_htlcs.is_empty());
 945         assert!(updates.update_fail_htlcs.is_empty());
 946         assert!(updates.update_fail_malformed_htlcs.is_empty());
 947         assert!(updates.update_fee.is_none());
 948
 949         nodes[1].node.close_channel(&chan_1.2).unwrap();
 950         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 951         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 952         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 953
 954         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 955         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 956         check_added_monitors!(nodes[1], 1);
 957         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 958         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 959
 960         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 961         assert!(updates_2.update_add_htlcs.is_empty());
 962         assert!(updates_2.update_fulfill_htlcs.is_empty());
 963         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 964         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 965         assert!(updates_2.update_fee.is_none());
 966
 967         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 968         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 969
 970         expect_payment_failed!(nodes[0], our_payment_hash, false);
 971
 972         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 973         assert_eq!(msg_events.len(), 2);
 974         let node_0_closing_signed = match msg_events[0] {
 975                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 976                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 977                         (*msg).clone()
 978                 },
 979                 _ => panic!("Unexpected event"),
 980         };
 981         match msg_events[1] {
 982                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 983                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 984                 },
 985                 _ => panic!("Unexpected event"),
 986         }
 987
 988         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 989         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 990         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 991         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 992         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 993         assert!(node_0_none.is_none());
 994
 995         assert!(nodes[0].node.list_channels().is_empty());
 996
 997         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 998         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 999         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1000         assert!(nodes[1].node.list_channels().is_empty());
1001         assert!(nodes[2].node.list_channels().is_empty());
1002 }
1003
1004 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1005         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1006         // messages delivered prior to disconnect
1007         let chanmon_cfgs = create_chanmon_cfgs(3);
1008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1010         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1011         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1012         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013
1014         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1015
1016         nodes[1].node.close_channel(&chan_1.2).unwrap();
1017         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1018         if recv_count > 0 {
1019                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1020                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1021                 if recv_count > 1 {
1022                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1023                 }
1024         }
1025
1026         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1027         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1028
1029         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1031         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1032         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1033
1034         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1035         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1036         assert!(node_1_shutdown == node_1_2nd_shutdown);
1037
1038         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1039         let node_0_2nd_shutdown = if recv_count > 0 {
1040                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1041                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1042                 node_0_2nd_shutdown
1043         } else {
1044                 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1045                 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1047                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1048         };
1049         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1050
1051         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1052         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1053
1054         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1055         check_added_monitors!(nodes[2], 1);
1056         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1057         assert!(updates.update_add_htlcs.is_empty());
1058         assert!(updates.update_fail_htlcs.is_empty());
1059         assert!(updates.update_fail_malformed_htlcs.is_empty());
1060         assert!(updates.update_fee.is_none());
1061         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1062         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1063         check_added_monitors!(nodes[1], 1);
1064         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1065         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1066
1067         assert!(updates_2.update_add_htlcs.is_empty());
1068         assert!(updates_2.update_fail_htlcs.is_empty());
1069         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1070         assert!(updates_2.update_fee.is_none());
1071         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1072         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1073         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1074
1075         let events = nodes[0].node.get_and_clear_pending_events();
1076         assert_eq!(events.len(), 1);
1077         match events[0] {
1078                 Event::PaymentSent { ref payment_preimage } => {
1079                         assert_eq!(our_payment_preimage, *payment_preimage);
1080                 },
1081                 _ => panic!("Unexpected event"),
1082         }
1083
1084         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1085         if recv_count > 0 {
1086                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1087                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1088                 assert!(node_1_closing_signed.is_some());
1089         }
1090
1091         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1092         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1093
1094         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1096         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1097         if recv_count == 0 {
1098                 // If all closing_signeds weren't delivered we can just resume where we left off...
1099                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1100
1101                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1102                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1103                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1104
1105                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1106                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1107                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1108
1109                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1110                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1111
1112                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1113                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1115
1116                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1117                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1118                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1119                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1120                 assert!(node_0_none.is_none());
1121         } else {
1122                 // If one node, however, received + responded with an identical closing_signed we end
1123                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1124                 // There isn't really anything better we can do simply, but in the future we might
1125                 // explore storing a set of recently-closed channels that got disconnected during
1126                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1127                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1128                 // transaction.
1129                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1130
1131                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1132                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1133                 assert_eq!(msg_events.len(), 1);
1134                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1135                         match action {
1136                                 &ErrorAction::SendErrorMessage { ref msg } => {
1137                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1138                                         assert_eq!(msg.channel_id, chan_1.2);
1139                                 },
1140                                 _ => panic!("Unexpected event!"),
1141                         }
1142                 } else { panic!("Needed SendErrorMessage close"); }
1143
1144                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1145                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1146                 // closing_signed so we do it ourselves
1147                 check_closed_broadcast!(nodes[0], false);
1148                 check_added_monitors!(nodes[0], 1);
1149         }
1150
1151         assert!(nodes[0].node.list_channels().is_empty());
1152
1153         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1154         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1155         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1156         assert!(nodes[1].node.list_channels().is_empty());
1157         assert!(nodes[2].node.list_channels().is_empty());
1158 }
1159
1160 #[test]
1161 fn test_shutdown_rebroadcast() {
1162         do_test_shutdown_rebroadcast(0);
1163         do_test_shutdown_rebroadcast(1);
1164         do_test_shutdown_rebroadcast(2);
1165 }
1166
1167 #[test]
1168 fn fake_network_test() {
1169         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1170         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1171         let chanmon_cfgs = create_chanmon_cfgs(4);
1172         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1173         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1174         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1175
1176         // Create some initial channels
1177         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1178         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1179         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1180
1181         // Rebalance the network a bit by relaying one payment through all the channels...
1182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1183         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1184         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1185         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1186
1187         // Send some more payments
1188         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1189         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1190         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1191
1192         // Test failure packets
1193         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1194         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1195
1196         // Add a new channel that skips 3
1197         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1198
1199         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1200         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1202         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1203         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1204         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1206
1207         // Do some rebalance loop payments, simultaneously
1208         let mut hops = Vec::with_capacity(3);
1209         hops.push(RouteHop {
1210                 pubkey: nodes[2].node.get_our_node_id(),
1211                 node_features: NodeFeatures::empty(),
1212                 short_channel_id: chan_2.0.contents.short_channel_id,
1213                 channel_features: ChannelFeatures::empty(),
1214                 fee_msat: 0,
1215                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1216         });
1217         hops.push(RouteHop {
1218                 pubkey: nodes[3].node.get_our_node_id(),
1219                 node_features: NodeFeatures::empty(),
1220                 short_channel_id: chan_3.0.contents.short_channel_id,
1221                 channel_features: ChannelFeatures::empty(),
1222                 fee_msat: 0,
1223                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1224         });
1225         hops.push(RouteHop {
1226                 pubkey: nodes[1].node.get_our_node_id(),
1227                 node_features: NodeFeatures::known(),
1228                 short_channel_id: chan_4.0.contents.short_channel_id,
1229                 channel_features: ChannelFeatures::known(),
1230                 fee_msat: 1000000,
1231                 cltv_expiry_delta: TEST_FINAL_CLTV,
1232         });
1233         hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1234         hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1235         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1236
1237         let mut hops = Vec::with_capacity(3);
1238         hops.push(RouteHop {
1239                 pubkey: nodes[3].node.get_our_node_id(),
1240                 node_features: NodeFeatures::empty(),
1241                 short_channel_id: chan_4.0.contents.short_channel_id,
1242                 channel_features: ChannelFeatures::empty(),
1243                 fee_msat: 0,
1244                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1245         });
1246         hops.push(RouteHop {
1247                 pubkey: nodes[2].node.get_our_node_id(),
1248                 node_features: NodeFeatures::empty(),
1249                 short_channel_id: chan_3.0.contents.short_channel_id,
1250                 channel_features: ChannelFeatures::empty(),
1251                 fee_msat: 0,
1252                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1253         });
1254         hops.push(RouteHop {
1255                 pubkey: nodes[1].node.get_our_node_id(),
1256                 node_features: NodeFeatures::known(),
1257                 short_channel_id: chan_2.0.contents.short_channel_id,
1258                 channel_features: ChannelFeatures::known(),
1259                 fee_msat: 1000000,
1260                 cltv_expiry_delta: TEST_FINAL_CLTV,
1261         });
1262         hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1263         hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1264         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1265
1266         // Claim the rebalances...
1267         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1268         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1269
1270         // Add a duplicate new channel from 2 to 4
1271         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1272
1273         // Send some payments across both channels
1274         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1277
1278
1279         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1280         let events = nodes[0].node.get_and_clear_pending_msg_events();
1281         assert_eq!(events.len(), 0);
1282         nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1283
1284         //TODO: Test that routes work again here as we've been notified that the channel is full
1285
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1287         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1288         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1289
1290         // Close down the channels...
1291         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1292         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1293         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1294         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1295         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1296 }
1297
1298 #[test]
1299 fn holding_cell_htlc_counting() {
1300         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1301         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1302         // commitment dance rounds.
1303         let chanmon_cfgs = create_chanmon_cfgs(3);
1304         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1305         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1306         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1307         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1308         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1309         let logger = test_utils::TestLogger::new();
1310
1311         let mut payments = Vec::new();
1312         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1313                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1314                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1315                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1316                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1317                 payments.push((payment_preimage, payment_hash));
1318         }
1319         check_added_monitors!(nodes[1], 1);
1320
1321         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1322         assert_eq!(events.len(), 1);
1323         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1324         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1325
1326         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1327         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1328         // another HTLC.
1329         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1330         {
1331                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1332                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1333                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1334                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1335                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1336                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1337         }
1338
1339         // This should also be true if we try to forward a payment.
1340         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1341         {
1342                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1343                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1344                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1345                 check_added_monitors!(nodes[0], 1);
1346         }
1347
1348         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1349         assert_eq!(events.len(), 1);
1350         let payment_event = SendEvent::from_event(events.pop().unwrap());
1351         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1352
1353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1354         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1355         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1356         // fails), the second will process the resulting failure and fail the HTLC backward.
1357         expect_pending_htlcs_forwardable!(nodes[1]);
1358         expect_pending_htlcs_forwardable!(nodes[1]);
1359         check_added_monitors!(nodes[1], 1);
1360
1361         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1362         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1363         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1364
1365         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1366         expect_payment_failed!(nodes[0], payment_hash_2, false);
1367
1368         // Now forward all the pending HTLCs and claim them back
1369         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1370         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1371         check_added_monitors!(nodes[2], 1);
1372
1373         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1374         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1375         check_added_monitors!(nodes[1], 1);
1376         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1377
1378         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1379         check_added_monitors!(nodes[1], 1);
1380         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1381
1382         for ref update in as_updates.update_add_htlcs.iter() {
1383                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1384         }
1385         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1386         check_added_monitors!(nodes[2], 1);
1387         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1388         check_added_monitors!(nodes[2], 1);
1389         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1390
1391         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1392         check_added_monitors!(nodes[1], 1);
1393         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1394         check_added_monitors!(nodes[1], 1);
1395         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1396
1397         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1398         check_added_monitors!(nodes[2], 1);
1399
1400         expect_pending_htlcs_forwardable!(nodes[2]);
1401
1402         let events = nodes[2].node.get_and_clear_pending_events();
1403         assert_eq!(events.len(), payments.len());
1404         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1405                 match event {
1406                         &Event::PaymentReceived { ref payment_hash, .. } => {
1407                                 assert_eq!(*payment_hash, *hash);
1408                         },
1409                         _ => panic!("Unexpected event"),
1410                 };
1411         }
1412
1413         for (preimage, _) in payments.drain(..) {
1414                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1415         }
1416
1417         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1418 }
1419
1420 #[test]
1421 fn duplicate_htlc_test() {
1422         // Test that we accept duplicate payment_hash HTLCs across the network and that
1423         // claiming/failing them are all separate and don't affect each other
1424         let chanmon_cfgs = create_chanmon_cfgs(6);
1425         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1426         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1427         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1428
1429         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1430         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1431         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1432         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1433         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1434         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1435
1436         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1437
1438         *nodes[0].network_payment_count.borrow_mut() -= 1;
1439         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1443
1444         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1445         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1446         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1447 }
1448
1449 #[test]
1450 fn test_duplicate_htlc_different_direction_onchain() {
1451         // Test that ChannelMonitor doesn't generate 2 preimage txn
1452         // when we have 2 HTLCs with same preimage that go across a node
1453         // in opposite directions, even with the same payment secret.
1454         let chanmon_cfgs = create_chanmon_cfgs(2);
1455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1457         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1458
1459         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1460         let logger = test_utils::TestLogger::new();
1461
1462         // balancing
1463         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1464
1465         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1466
1467         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1468         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1469         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1470         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1471
1472         // Provide preimage to node 0 by claiming payment
1473         nodes[0].node.claim_funds(payment_preimage);
1474         check_added_monitors!(nodes[0], 1);
1475
1476         // Broadcast node 1 commitment txn
1477         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1478
1479         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1480         let mut has_both_htlcs = 0; // check htlcs match ones committed
1481         for outp in remote_txn[0].output.iter() {
1482                 if outp.value == 800_000 / 1000 {
1483                         has_both_htlcs += 1;
1484                 } else if outp.value == 900_000 / 1000 {
1485                         has_both_htlcs += 1;
1486                 }
1487         }
1488         assert_eq!(has_both_htlcs, 2);
1489
1490         mine_transaction(&nodes[0], &remote_txn[0]);
1491         check_added_monitors!(nodes[0], 1);
1492         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1493
1494         // Check we only broadcast 1 timeout tx
1495         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1496         assert_eq!(claim_txn.len(), 8);
1497         assert_eq!(claim_txn[1], claim_txn[4]);
1498         assert_eq!(claim_txn[2], claim_txn[5]);
1499         check_spends!(claim_txn[1], chan_1.3);
1500         check_spends!(claim_txn[2], claim_txn[1]);
1501         check_spends!(claim_txn[7], claim_txn[1]);
1502
1503         assert_eq!(claim_txn[0].input.len(), 1);
1504         assert_eq!(claim_txn[3].input.len(), 1);
1505         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1506
1507         assert_eq!(claim_txn[0].input.len(), 1);
1508         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1509         check_spends!(claim_txn[0], remote_txn[0]);
1510         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1511         assert_eq!(claim_txn[6].input.len(), 1);
1512         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1513         check_spends!(claim_txn[6], remote_txn[0]);
1514         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1515
1516         let events = nodes[0].node.get_and_clear_pending_msg_events();
1517         assert_eq!(events.len(), 3);
1518         for e in events {
1519                 match e {
1520                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1521                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1522                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1523                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1524                         },
1525                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1526                                 assert!(update_add_htlcs.is_empty());
1527                                 assert!(update_fail_htlcs.is_empty());
1528                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1529                                 assert!(update_fail_malformed_htlcs.is_empty());
1530                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1531                         },
1532                         _ => panic!("Unexpected event"),
1533                 }
1534         }
1535 }
1536
1537 #[test]
1538 fn test_basic_channel_reserve() {
1539         let chanmon_cfgs = create_chanmon_cfgs(2);
1540         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1541         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1542         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1543         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1544         let logger = test_utils::TestLogger::new();
1545
1546         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1547         let channel_reserve = chan_stat.channel_reserve_msat;
1548
1549         // The 2* and +1 are for the fee spike reserve.
1550         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1551         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1552         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1553         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1554         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1555         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1556         match err {
1557                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1558                         match &fails[0] {
1559                                 &APIError::ChannelUnavailable{ref err} =>
1560                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1561                                 _ => panic!("Unexpected error variant"),
1562                         }
1563                 },
1564                 _ => panic!("Unexpected error variant"),
1565         }
1566         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1567         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1568
1569         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1570 }
1571
1572 #[test]
1573 fn test_fee_spike_violation_fails_htlc() {
1574         let chanmon_cfgs = create_chanmon_cfgs(2);
1575         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1576         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1577         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1578         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1579
1580         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1581         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1582         let secp_ctx = Secp256k1::new();
1583         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1584
1585         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1586
1587         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1588         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1589         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1590         let msg = msgs::UpdateAddHTLC {
1591                 channel_id: chan.2,
1592                 htlc_id: 0,
1593                 amount_msat: htlc_msat,
1594                 payment_hash: payment_hash,
1595                 cltv_expiry: htlc_cltv,
1596                 onion_routing_packet: onion_packet,
1597         };
1598
1599         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1600
1601         // Now manually create the commitment_signed message corresponding to the update_add
1602         // nodes[0] just sent. In the code for construction of this message, "local" refers
1603         // to the sender of the message, and "remote" refers to the receiver.
1604
1605         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1606
1607         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1608
1609         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1610         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1611         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1612                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1613                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1614                 let chan_signer = local_chan.get_signer();
1615                 let pubkeys = chan_signer.pubkeys();
1616                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1617                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1618                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1619         };
1620         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1621                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1622                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1623                 let chan_signer = remote_chan.get_signer();
1624                 let pubkeys = chan_signer.pubkeys();
1625                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1626                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1627         };
1628
1629         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1630         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1631                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1632
1633         // Build the remote commitment transaction so we can sign it, and then later use the
1634         // signature for the commitment_signed message.
1635         let local_chan_balance = 1313;
1636
1637         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1638                 offered: false,
1639                 amount_msat: 3460001,
1640                 cltv_expiry: htlc_cltv,
1641                 payment_hash,
1642                 transaction_output_index: Some(1),
1643         };
1644
1645         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1646
1647         let res = {
1648                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1649                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1650                 let local_chan_signer = local_chan.get_signer();
1651                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1652                         commitment_number,
1653                         95000,
1654                         local_chan_balance,
1655                         commit_tx_keys.clone(),
1656                         feerate_per_kw,
1657                         &mut vec![(accepted_htlc_info, ())],
1658                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1659                 );
1660                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1661         };
1662
1663         let commit_signed_msg = msgs::CommitmentSigned {
1664                 channel_id: chan.2,
1665                 signature: res.0,
1666                 htlc_signatures: res.1
1667         };
1668
1669         // Send the commitment_signed message to the nodes[1].
1670         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1671         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1672
1673         // Send the RAA to nodes[1].
1674         let raa_msg = msgs::RevokeAndACK {
1675                 channel_id: chan.2,
1676                 per_commitment_secret: local_secret,
1677                 next_per_commitment_point: next_local_point
1678         };
1679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1680
1681         let events = nodes[1].node.get_and_clear_pending_msg_events();
1682         assert_eq!(events.len(), 1);
1683         // Make sure the HTLC failed in the way we expect.
1684         match events[0] {
1685                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1686                         assert_eq!(update_fail_htlcs.len(), 1);
1687                         update_fail_htlcs[0].clone()
1688                 },
1689                 _ => panic!("Unexpected event"),
1690         };
1691         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1692                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1693
1694         check_added_monitors!(nodes[1], 2);
1695 }
1696
1697 #[test]
1698 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1699         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1700         // Set the fee rate for the channel very high, to the point where the fundee
1701         // sending any above-dust amount would result in a channel reserve violation.
1702         // In this test we check that we would be prevented from sending an HTLC in
1703         // this situation.
1704         let feerate_per_kw = 253;
1705         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1706         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1707         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1708         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1709         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1710
1711         let mut push_amt = 100_000_000;
1712         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1713         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1714
1715         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1716
1717         // Sending exactly enough to hit the reserve amount should be accepted
1718         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1719
1720         // However one more HTLC should be significantly over the reserve amount and fail.
1721         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1722         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1723                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1724         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1725         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_string(), 1);
1726 }
1727
1728 #[test]
1729 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1730         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1731         // Set the fee rate for the channel very high, to the point where the funder
1732         // receiving 1 update_add_htlc would result in them closing the channel due
1733         // to channel reserve violation. This close could also happen if the fee went
1734         // up a more realistic amount, but many HTLCs were outstanding at the time of
1735         // the update_add_htlc.
1736         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1737         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1738         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1739         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1740         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1741         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1742
1743         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1744         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1745         let secp_ctx = Secp256k1::new();
1746         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1747         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1748         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1749         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1750         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1751         let msg = msgs::UpdateAddHTLC {
1752                 channel_id: chan.2,
1753                 htlc_id: 1,
1754                 amount_msat: htlc_msat + 1,
1755                 payment_hash: payment_hash,
1756                 cltv_expiry: htlc_cltv,
1757                 onion_routing_packet: onion_packet,
1758         };
1759
1760         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1761         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1762         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1763         assert_eq!(nodes[0].node.list_channels().len(), 0);
1764         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1765         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1766         check_added_monitors!(nodes[0], 1);
1767 }
1768
1769 #[test]
1770 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1771         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1772         // calculating our commitment transaction fee (this was previously broken).
1773         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1774         let feerate_per_kw = 253;
1775         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1776         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1777
1778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1780         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1781
1782         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1783         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1784         // transaction fee with 0 HTLCs (183 sats)).
1785         let mut push_amt = 100_000_000;
1786         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1787         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1788         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1789
1790         let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1791                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1792         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1793         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1794         // commitment transaction fee.
1795         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1796
1797         // One more than the dust amt should fail, however.
1798         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1799         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1800                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1801 }
1802
1803 #[test]
1804 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1805         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1806         // calculating our counterparty's commitment transaction fee (this was previously broken).
1807         let chanmon_cfgs = create_chanmon_cfgs(2);
1808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1810         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1811         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1812
1813         let payment_amt = 46000; // Dust amount
1814         // In the previous code, these first four payments would succeed.
1815         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1816         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1817         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1818         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819
1820         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1821         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1822         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1823         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1824         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1825         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1826
1827         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1828         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1829         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1830         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1831 }
1832
1833 #[test]
1834 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1835         let chanmon_cfgs = create_chanmon_cfgs(3);
1836         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1837         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1838         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1839         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1840         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1841
1842         let feemsat = 239;
1843         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1844         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1845         let feerate = get_feerate!(nodes[0], chan.2);
1846
1847         // Add a 2* and +1 for the fee spike reserve.
1848         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1849         let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1850         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1851
1852         // Add a pending HTLC.
1853         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1854         let payment_event_1 = {
1855                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1856                 check_added_monitors!(nodes[0], 1);
1857
1858                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1859                 assert_eq!(events.len(), 1);
1860                 SendEvent::from_event(events.remove(0))
1861         };
1862         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1863
1864         // Attempt to trigger a channel reserve violation --> payment failure.
1865         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1866         let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1867         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1868         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1869
1870         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1871         let secp_ctx = Secp256k1::new();
1872         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1873         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1874         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1875         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1876         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1877         let msg = msgs::UpdateAddHTLC {
1878                 channel_id: chan.2,
1879                 htlc_id: 1,
1880                 amount_msat: htlc_msat + 1,
1881                 payment_hash: our_payment_hash_1,
1882                 cltv_expiry: htlc_cltv,
1883                 onion_routing_packet: onion_packet,
1884         };
1885
1886         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1887         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1888         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1889         assert_eq!(nodes[1].node.list_channels().len(), 1);
1890         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1891         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1892         check_added_monitors!(nodes[1], 1);
1893 }
1894
1895 #[test]
1896 fn test_inbound_outbound_capacity_is_not_zero() {
1897         let chanmon_cfgs = create_chanmon_cfgs(2);
1898         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1899         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1900         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1901         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1902         let channels0 = node_chanmgrs[0].list_channels();
1903         let channels1 = node_chanmgrs[1].list_channels();
1904         assert_eq!(channels0.len(), 1);
1905         assert_eq!(channels1.len(), 1);
1906
1907         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1908         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1909         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1910
1911         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1912         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1913 }
1914
1915 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1916         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1917 }
1918
1919 #[test]
1920 fn test_channel_reserve_holding_cell_htlcs() {
1921         let chanmon_cfgs = create_chanmon_cfgs(3);
1922         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1923         // When this test was written, the default base fee floated based on the HTLC count.
1924         // It is now fixed, so we simply set the fee to the expected value here.
1925         let mut config = test_default_channel_config();
1926         config.channel_options.forwarding_fee_base_msat = 239;
1927         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1928         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1929         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1930         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1931
1932         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1933         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1934
1935         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1936         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1937
1938         macro_rules! expect_forward {
1939                 ($node: expr) => {{
1940                         let mut events = $node.node.get_and_clear_pending_msg_events();
1941                         assert_eq!(events.len(), 1);
1942                         check_added_monitors!($node, 1);
1943                         let payment_event = SendEvent::from_event(events.remove(0));
1944                         payment_event
1945                 }}
1946         }
1947
1948         let feemsat = 239; // set above
1949         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1950         let feerate = get_feerate!(nodes[0], chan_1.2);
1951
1952         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1953
1954         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1955         {
1956                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1957                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1958                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1959                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1960                         assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
1961                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1962                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1963         }
1964
1965         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1966         // nodes[0]'s wealth
1967         loop {
1968                 let amt_msat = recv_value_0 + total_fee_msat;
1969                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1970                 // Also, ensure that each payment has enough to be over the dust limit to
1971                 // ensure it'll be included in each commit tx fee calculation.
1972                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1973                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1974                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1975                         break;
1976                 }
1977                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1978
1979                 let (stat01_, stat11_, stat12_, stat22_) = (
1980                         get_channel_value_stat!(nodes[0], chan_1.2),
1981                         get_channel_value_stat!(nodes[1], chan_1.2),
1982                         get_channel_value_stat!(nodes[1], chan_2.2),
1983                         get_channel_value_stat!(nodes[2], chan_2.2),
1984                 );
1985
1986                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1987                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1988                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1989                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1990                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1991         }
1992
1993         // adding pending output.
1994         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1995         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1996         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1997         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1998         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1999         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2000         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2001         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2002         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2003         // policy.
2004         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2005         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2006         let amt_msat_1 = recv_value_1 + total_fee_msat;
2007
2008         let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
2009         let payment_event_1 = {
2010                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
2011                 check_added_monitors!(nodes[0], 1);
2012
2013                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2014                 assert_eq!(events.len(), 1);
2015                 SendEvent::from_event(events.remove(0))
2016         };
2017         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2018
2019         // channel reserve test with htlc pending output > 0
2020         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2021         {
2022                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2023                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2024                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2025                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2026         }
2027
2028         // split the rest to test holding cell
2029         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2030         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2031         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2032         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2033         {
2034                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2035                 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
2036         }
2037
2038         // now see if they go through on both sides
2039         let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
2040         // but this will stuck in the holding cell
2041         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2042         check_added_monitors!(nodes[0], 0);
2043         let events = nodes[0].node.get_and_clear_pending_events();
2044         assert_eq!(events.len(), 0);
2045
2046         // test with outbound holding cell amount > 0
2047         {
2048                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2049                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2050                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2051                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2052                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
2053         }
2054
2055         let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
2056         // this will also stuck in the holding cell
2057         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2058         check_added_monitors!(nodes[0], 0);
2059         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2060         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2061
2062         // flush the pending htlc
2063         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2064         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2065         check_added_monitors!(nodes[1], 1);
2066
2067         // the pending htlc should be promoted to committed
2068         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2069         check_added_monitors!(nodes[0], 1);
2070         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2071
2072         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2073         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2074         // No commitment_signed so get_event_msg's assert(len == 1) passes
2075         check_added_monitors!(nodes[0], 1);
2076
2077         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2078         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2079         check_added_monitors!(nodes[1], 1);
2080
2081         expect_pending_htlcs_forwardable!(nodes[1]);
2082
2083         let ref payment_event_11 = expect_forward!(nodes[1]);
2084         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2085         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2086
2087         expect_pending_htlcs_forwardable!(nodes[2]);
2088         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2089
2090         // flush the htlcs in the holding cell
2091         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2092         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2093         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2094         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2095         expect_pending_htlcs_forwardable!(nodes[1]);
2096
2097         let ref payment_event_3 = expect_forward!(nodes[1]);
2098         assert_eq!(payment_event_3.msgs.len(), 2);
2099         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2100         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2101
2102         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2103         expect_pending_htlcs_forwardable!(nodes[2]);
2104
2105         let events = nodes[2].node.get_and_clear_pending_events();
2106         assert_eq!(events.len(), 2);
2107         match events[0] {
2108                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2109                         assert_eq!(our_payment_hash_21, *payment_hash);
2110                         assert!(payment_preimage.is_none());
2111                         assert_eq!(our_payment_secret_21, *payment_secret);
2112                         assert_eq!(recv_value_21, amt);
2113                 },
2114                 _ => panic!("Unexpected event"),
2115         }
2116         match events[1] {
2117                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2118                         assert_eq!(our_payment_hash_22, *payment_hash);
2119                         assert!(payment_preimage.is_none());
2120                         assert_eq!(our_payment_secret_22, *payment_secret);
2121                         assert_eq!(recv_value_22, amt);
2122                 },
2123                 _ => panic!("Unexpected event"),
2124         }
2125
2126         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2127         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2128         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2129
2130         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2131         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2132         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2133
2134         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2135         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);
2136         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2137         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2138         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2139
2140         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2141         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2142 }
2143
2144 #[test]
2145 fn channel_reserve_in_flight_removes() {
2146         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2147         // can send to its counterparty, but due to update ordering, the other side may not yet have
2148         // considered those HTLCs fully removed.
2149         // This tests that we don't count HTLCs which will not be included in the next remote
2150         // commitment transaction towards the reserve value (as it implies no commitment transaction
2151         // will be generated which violates the remote reserve value).
2152         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2153         // To test this we:
2154         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2155         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2156         //    you only consider the value of the first HTLC, it may not),
2157         //  * start routing a third HTLC from A to B,
2158         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2159         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2160         //  * deliver the first fulfill from B
2161         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2162         //    claim,
2163         //  * deliver A's response CS and RAA.
2164         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2165         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2166         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2167         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2168         let chanmon_cfgs = create_chanmon_cfgs(2);
2169         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2170         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2171         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2172         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2173         let logger = test_utils::TestLogger::new();
2174
2175         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2176         // Route the first two HTLCs.
2177         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2178         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2179
2180         // Start routing the third HTLC (this is just used to get everyone in the right state).
2181         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2182         let send_1 = {
2183                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2184                 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();
2185                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2186                 check_added_monitors!(nodes[0], 1);
2187                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2188                 assert_eq!(events.len(), 1);
2189                 SendEvent::from_event(events.remove(0))
2190         };
2191
2192         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2193         // initial fulfill/CS.
2194         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2195         check_added_monitors!(nodes[1], 1);
2196         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2197
2198         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2199         // remove the second HTLC when we send the HTLC back from B to A.
2200         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2201         check_added_monitors!(nodes[1], 1);
2202         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2203
2204         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2205         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2206         check_added_monitors!(nodes[0], 1);
2207         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2208         expect_payment_sent!(nodes[0], payment_preimage_1);
2209
2210         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2211         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2212         check_added_monitors!(nodes[1], 1);
2213         // B is already AwaitingRAA, so cant generate a CS here
2214         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2215
2216         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2217         check_added_monitors!(nodes[1], 1);
2218         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2219
2220         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2221         check_added_monitors!(nodes[0], 1);
2222         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2223
2224         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2225         check_added_monitors!(nodes[1], 1);
2226         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2227
2228         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2229         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2230         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2231         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2232         // on-chain as necessary).
2233         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2234         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2235         check_added_monitors!(nodes[0], 1);
2236         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2237         expect_payment_sent!(nodes[0], payment_preimage_2);
2238
2239         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2240         check_added_monitors!(nodes[1], 1);
2241         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2242
2243         expect_pending_htlcs_forwardable!(nodes[1]);
2244         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2245
2246         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2247         // resolve the second HTLC from A's point of view.
2248         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2249         check_added_monitors!(nodes[0], 1);
2250         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2251
2252         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2253         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2254         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2255         let send_2 = {
2256                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2257                 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();
2258                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2259                 check_added_monitors!(nodes[1], 1);
2260                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2261                 assert_eq!(events.len(), 1);
2262                 SendEvent::from_event(events.remove(0))
2263         };
2264
2265         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2266         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2267         check_added_monitors!(nodes[0], 1);
2268         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2269
2270         // Now just resolve all the outstanding messages/HTLCs for completeness...
2271
2272         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2273         check_added_monitors!(nodes[1], 1);
2274         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2275
2276         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2277         check_added_monitors!(nodes[1], 1);
2278
2279         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2280         check_added_monitors!(nodes[0], 1);
2281         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2282
2283         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2284         check_added_monitors!(nodes[1], 1);
2285         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2286
2287         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2288         check_added_monitors!(nodes[0], 1);
2289
2290         expect_pending_htlcs_forwardable!(nodes[0]);
2291         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2292
2293         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2294         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2295 }
2296
2297 #[test]
2298 fn channel_monitor_network_test() {
2299         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2300         // tests that ChannelMonitor is able to recover from various states.
2301         let chanmon_cfgs = create_chanmon_cfgs(5);
2302         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2303         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2304         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2305
2306         // Create some initial channels
2307         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2308         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2309         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2310         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2311
2312         // Make sure all nodes are at the same starting height
2313         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2314         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2315         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2316         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2317         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2318
2319         // Rebalance the network a bit by relaying one payment through all the channels...
2320         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2321         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2322         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2323         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2324
2325         // Simple case with no pending HTLCs:
2326         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2327         check_added_monitors!(nodes[1], 1);
2328         check_closed_broadcast!(nodes[1], false);
2329         {
2330                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2331                 assert_eq!(node_txn.len(), 1);
2332                 mine_transaction(&nodes[0], &node_txn[0]);
2333                 check_added_monitors!(nodes[0], 1);
2334                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2335         }
2336         check_closed_broadcast!(nodes[0], true);
2337         assert_eq!(nodes[0].node.list_channels().len(), 0);
2338         assert_eq!(nodes[1].node.list_channels().len(), 1);
2339
2340         // One pending HTLC is discarded by the force-close:
2341         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2342
2343         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2344         // broadcasted until we reach the timelock time).
2345         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2346         check_closed_broadcast!(nodes[1], false);
2347         check_added_monitors!(nodes[1], 1);
2348         {
2349                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2350                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2351                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2352                 mine_transaction(&nodes[2], &node_txn[0]);
2353                 check_added_monitors!(nodes[2], 1);
2354                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2355         }
2356         check_closed_broadcast!(nodes[2], true);
2357         assert_eq!(nodes[1].node.list_channels().len(), 0);
2358         assert_eq!(nodes[2].node.list_channels().len(), 1);
2359
2360         macro_rules! claim_funds {
2361                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2362                         {
2363                                 assert!($node.node.claim_funds($preimage));
2364                                 check_added_monitors!($node, 1);
2365
2366                                 let events = $node.node.get_and_clear_pending_msg_events();
2367                                 assert_eq!(events.len(), 1);
2368                                 match events[0] {
2369                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2370                                                 assert!(update_add_htlcs.is_empty());
2371                                                 assert!(update_fail_htlcs.is_empty());
2372                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2373                                         },
2374                                         _ => panic!("Unexpected event"),
2375                                 };
2376                         }
2377                 }
2378         }
2379
2380         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2381         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2382         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2383         check_added_monitors!(nodes[2], 1);
2384         check_closed_broadcast!(nodes[2], false);
2385         let node2_commitment_txid;
2386         {
2387                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2388                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2389                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2390                 node2_commitment_txid = node_txn[0].txid();
2391
2392                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2393                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2394                 mine_transaction(&nodes[3], &node_txn[0]);
2395                 check_added_monitors!(nodes[3], 1);
2396                 check_preimage_claim(&nodes[3], &node_txn);
2397         }
2398         check_closed_broadcast!(nodes[3], true);
2399         assert_eq!(nodes[2].node.list_channels().len(), 0);
2400         assert_eq!(nodes[3].node.list_channels().len(), 1);
2401
2402         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2403         // confusing us in the following tests.
2404         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2405
2406         // One pending HTLC to time out:
2407         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2408         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2409         // buffer space).
2410
2411         let (close_chan_update_1, close_chan_update_2) = {
2412                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2413                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2414                 assert_eq!(events.len(), 2);
2415                 let close_chan_update_1 = match events[0] {
2416                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2417                                 msg.clone()
2418                         },
2419                         _ => panic!("Unexpected event"),
2420                 };
2421                 match events[1] {
2422                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2423                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2424                         },
2425                         _ => panic!("Unexpected event"),
2426                 }
2427                 check_added_monitors!(nodes[3], 1);
2428
2429                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2430                 {
2431                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2432                         node_txn.retain(|tx| {
2433                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2434                                         false
2435                                 } else { true }
2436                         });
2437                 }
2438
2439                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2440
2441                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2442                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2443
2444                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2445                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2446                 assert_eq!(events.len(), 2);
2447                 let close_chan_update_2 = match events[0] {
2448                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2449                                 msg.clone()
2450                         },
2451                         _ => panic!("Unexpected event"),
2452                 };
2453                 match events[1] {
2454                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2455                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2456                         },
2457                         _ => panic!("Unexpected event"),
2458                 }
2459                 check_added_monitors!(nodes[4], 1);
2460                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2461
2462                 mine_transaction(&nodes[4], &node_txn[0]);
2463                 check_preimage_claim(&nodes[4], &node_txn);
2464                 (close_chan_update_1, close_chan_update_2)
2465         };
2466         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2467         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2468         assert_eq!(nodes[3].node.list_channels().len(), 0);
2469         assert_eq!(nodes[4].node.list_channels().len(), 0);
2470
2471         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2472 }
2473
2474 #[test]
2475 fn test_justice_tx() {
2476         // Test justice txn built on revoked HTLC-Success tx, against both sides
2477         let mut alice_config = UserConfig::default();
2478         alice_config.channel_options.announced_channel = true;
2479         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2480         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2481         let mut bob_config = UserConfig::default();
2482         bob_config.channel_options.announced_channel = true;
2483         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2484         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2485         let user_cfgs = [Some(alice_config), Some(bob_config)];
2486         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2487         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2488         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2489         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2490         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2491         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2492         // Create some new channels:
2493         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2494
2495         // A pending HTLC which will be revoked:
2496         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2497         // Get the will-be-revoked local txn from nodes[0]
2498         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2499         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2500         assert_eq!(revoked_local_txn[0].input.len(), 1);
2501         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2502         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2503         assert_eq!(revoked_local_txn[1].input.len(), 1);
2504         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2505         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2506         // Revoke the old state
2507         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2508
2509         {
2510                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2511                 {
2512                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2513                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2514                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2515
2516                         check_spends!(node_txn[0], revoked_local_txn[0]);
2517                         node_txn.swap_remove(0);
2518                         node_txn.truncate(1);
2519                 }
2520                 check_added_monitors!(nodes[1], 1);
2521                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2522
2523                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2524                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2525                 // Verify broadcast of revoked HTLC-timeout
2526                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2527                 check_added_monitors!(nodes[0], 1);
2528                 // Broadcast revoked HTLC-timeout on node 1
2529                 mine_transaction(&nodes[1], &node_txn[1]);
2530                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2531         }
2532         get_announce_close_broadcast_events(&nodes, 0, 1);
2533
2534         assert_eq!(nodes[0].node.list_channels().len(), 0);
2535         assert_eq!(nodes[1].node.list_channels().len(), 0);
2536
2537         // We test justice_tx build by A on B's revoked HTLC-Success tx
2538         // Create some new channels:
2539         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2540         {
2541                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2542                 node_txn.clear();
2543         }
2544
2545         // A pending HTLC which will be revoked:
2546         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2547         // Get the will-be-revoked local txn from B
2548         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2549         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2550         assert_eq!(revoked_local_txn[0].input.len(), 1);
2551         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2552         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2553         // Revoke the old state
2554         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2555         {
2556                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2557                 {
2558                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2559                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2560                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2561
2562                         check_spends!(node_txn[0], revoked_local_txn[0]);
2563                         node_txn.swap_remove(0);
2564                 }
2565                 check_added_monitors!(nodes[0], 1);
2566                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2567
2568                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2569                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2570                 check_added_monitors!(nodes[1], 1);
2571                 mine_transaction(&nodes[0], &node_txn[1]);
2572                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2573         }
2574         get_announce_close_broadcast_events(&nodes, 0, 1);
2575         assert_eq!(nodes[0].node.list_channels().len(), 0);
2576         assert_eq!(nodes[1].node.list_channels().len(), 0);
2577 }
2578
2579 #[test]
2580 fn revoked_output_claim() {
2581         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2582         // transaction is broadcast by its counterparty
2583         let chanmon_cfgs = create_chanmon_cfgs(2);
2584         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2585         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2586         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2587         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2588         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2589         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2590         assert_eq!(revoked_local_txn.len(), 1);
2591         // Only output is the full channel value back to nodes[0]:
2592         assert_eq!(revoked_local_txn[0].output.len(), 1);
2593         // Send a payment through, updating everyone's latest commitment txn
2594         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2595
2596         // Inform nodes[1] that nodes[0] broadcast a stale tx
2597         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2598         check_added_monitors!(nodes[1], 1);
2599         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2600         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2601
2602         check_spends!(node_txn[0], revoked_local_txn[0]);
2603         check_spends!(node_txn[1], chan_1.3);
2604
2605         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2606         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2607         get_announce_close_broadcast_events(&nodes, 0, 1);
2608         check_added_monitors!(nodes[0], 1)
2609 }
2610
2611 #[test]
2612 fn claim_htlc_outputs_shared_tx() {
2613         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2614         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2615         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2616         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2617         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2618         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2619
2620         // Create some new channel:
2621         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2622
2623         // Rebalance the network to generate htlc in the two directions
2624         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2625         // 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
2626         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2627         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2628
2629         // Get the will-be-revoked local txn from node[0]
2630         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2631         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2632         assert_eq!(revoked_local_txn[0].input.len(), 1);
2633         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2634         assert_eq!(revoked_local_txn[1].input.len(), 1);
2635         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2636         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2637         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2638
2639         //Revoke the old state
2640         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2641
2642         {
2643                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2644                 check_added_monitors!(nodes[0], 1);
2645                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2646                 check_added_monitors!(nodes[1], 1);
2647                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2648                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2649
2650                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2651                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2652
2653                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2654                 check_spends!(node_txn[0], revoked_local_txn[0]);
2655
2656                 let mut witness_lens = BTreeSet::new();
2657                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2658                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2659                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2660                 assert_eq!(witness_lens.len(), 3);
2661                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2662                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2663                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2664
2665                 // Next nodes[1] broadcasts its current local tx state:
2666                 assert_eq!(node_txn[1].input.len(), 1);
2667                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2668         }
2669         get_announce_close_broadcast_events(&nodes, 0, 1);
2670         assert_eq!(nodes[0].node.list_channels().len(), 0);
2671         assert_eq!(nodes[1].node.list_channels().len(), 0);
2672 }
2673
2674 #[test]
2675 fn claim_htlc_outputs_single_tx() {
2676         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2677         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2678         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2679         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2680         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2681         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2682
2683         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2684
2685         // Rebalance the network to generate htlc in the two directions
2686         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2687         // 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
2688         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2689         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2690         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2691
2692         // Get the will-be-revoked local txn from node[0]
2693         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2694
2695         //Revoke the old state
2696         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2697
2698         {
2699                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2700                 check_added_monitors!(nodes[0], 1);
2701                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2702                 check_added_monitors!(nodes[1], 1);
2703                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2704
2705                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2706                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2707
2708                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2709                 assert_eq!(node_txn.len(), 9);
2710                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2711                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2712                 // 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)
2713                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2714
2715                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2716                 assert_eq!(node_txn[0].input.len(), 1);
2717                 check_spends!(node_txn[0], chan_1.3);
2718                 assert_eq!(node_txn[1].input.len(), 1);
2719                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2720                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2721                 check_spends!(node_txn[1], node_txn[0]);
2722
2723                 // Justice transactions are indices 1-2-4
2724                 assert_eq!(node_txn[2].input.len(), 1);
2725                 assert_eq!(node_txn[3].input.len(), 1);
2726                 assert_eq!(node_txn[4].input.len(), 1);
2727
2728                 check_spends!(node_txn[2], revoked_local_txn[0]);
2729                 check_spends!(node_txn[3], revoked_local_txn[0]);
2730                 check_spends!(node_txn[4], revoked_local_txn[0]);
2731
2732                 let mut witness_lens = BTreeSet::new();
2733                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2734                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2735                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2736                 assert_eq!(witness_lens.len(), 3);
2737                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2738                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2739                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2740         }
2741         get_announce_close_broadcast_events(&nodes, 0, 1);
2742         assert_eq!(nodes[0].node.list_channels().len(), 0);
2743         assert_eq!(nodes[1].node.list_channels().len(), 0);
2744 }
2745
2746 #[test]
2747 fn test_htlc_on_chain_success() {
2748         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2749         // the preimage backward accordingly. So here we test that ChannelManager is
2750         // broadcasting the right event to other nodes in payment path.
2751         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2752         // A --------------------> B ----------------------> C (preimage)
2753         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2754         // commitment transaction was broadcast.
2755         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2756         // towards B.
2757         // B should be able to claim via preimage if A then broadcasts its local tx.
2758         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2759         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2760         // PaymentSent event).
2761
2762         let chanmon_cfgs = create_chanmon_cfgs(3);
2763         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2764         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2765         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2766
2767         // Create some initial channels
2768         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2769         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2770
2771         // Ensure all nodes are at the same height
2772         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2773         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2774         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2775         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2776
2777         // Rebalance the network a bit by relaying one payment through all the channels...
2778         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2779         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2780
2781         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2782         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2783
2784         // Broadcast legit commitment tx from C on B's chain
2785         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2786         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2787         assert_eq!(commitment_tx.len(), 1);
2788         check_spends!(commitment_tx[0], chan_2.3);
2789         nodes[2].node.claim_funds(our_payment_preimage);
2790         nodes[2].node.claim_funds(our_payment_preimage_2);
2791         check_added_monitors!(nodes[2], 2);
2792         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2793         assert!(updates.update_add_htlcs.is_empty());
2794         assert!(updates.update_fail_htlcs.is_empty());
2795         assert!(updates.update_fail_malformed_htlcs.is_empty());
2796         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2797
2798         mine_transaction(&nodes[2], &commitment_tx[0]);
2799         check_closed_broadcast!(nodes[2], true);
2800         check_added_monitors!(nodes[2], 1);
2801         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)
2802         assert_eq!(node_txn.len(), 5);
2803         assert_eq!(node_txn[0], node_txn[3]);
2804         assert_eq!(node_txn[1], node_txn[4]);
2805         assert_eq!(node_txn[2], commitment_tx[0]);
2806         check_spends!(node_txn[0], commitment_tx[0]);
2807         check_spends!(node_txn[1], commitment_tx[0]);
2808         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2809         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2810         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2811         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2812         assert_eq!(node_txn[0].lock_time, 0);
2813         assert_eq!(node_txn[1].lock_time, 0);
2814
2815         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2816         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2817         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2818         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2819         {
2820                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2821                 assert_eq!(added_monitors.len(), 1);
2822                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2823                 added_monitors.clear();
2824         }
2825         let events = nodes[1].node.get_and_clear_pending_msg_events();
2826         {
2827                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2828                 assert_eq!(added_monitors.len(), 2);
2829                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2830                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2831                 added_monitors.clear();
2832         }
2833         assert_eq!(events.len(), 3);
2834         match events[0] {
2835                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2836                 _ => panic!("Unexpected event"),
2837         }
2838         match events[1] {
2839                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2840                 _ => panic!("Unexpected event"),
2841         }
2842
2843         match events[2] {
2844                 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, .. } } => {
2845                         assert!(update_add_htlcs.is_empty());
2846                         assert!(update_fail_htlcs.is_empty());
2847                         assert_eq!(update_fulfill_htlcs.len(), 1);
2848                         assert!(update_fail_malformed_htlcs.is_empty());
2849                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2850                 },
2851                 _ => panic!("Unexpected event"),
2852         };
2853         macro_rules! check_tx_local_broadcast {
2854                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2855                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2856                         assert_eq!(node_txn.len(), 3);
2857                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2858                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2859                         check_spends!(node_txn[1], $commitment_tx);
2860                         check_spends!(node_txn[2], $commitment_tx);
2861                         assert_ne!(node_txn[1].lock_time, 0);
2862                         assert_ne!(node_txn[2].lock_time, 0);
2863                         if $htlc_offered {
2864                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2865                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2866                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2867                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2868                         } else {
2869                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2870                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2871                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2872                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2873                         }
2874                         check_spends!(node_txn[0], $chan_tx);
2875                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2876                         node_txn.clear();
2877                 } }
2878         }
2879         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2880         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2881         // timeout-claim of the output that nodes[2] just claimed via success.
2882         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2883
2884         // Broadcast legit commitment tx from A on B's chain
2885         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2886         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2887         check_spends!(node_a_commitment_tx[0], chan_1.3);
2888         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2889         check_closed_broadcast!(nodes[1], true);
2890         check_added_monitors!(nodes[1], 1);
2891         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2892         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2893         let commitment_spend =
2894                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2895                         check_spends!(node_txn[1], commitment_tx[0]);
2896                         check_spends!(node_txn[2], commitment_tx[0]);
2897                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2898                         &node_txn[0]
2899                 } else {
2900                         check_spends!(node_txn[0], commitment_tx[0]);
2901                         check_spends!(node_txn[1], commitment_tx[0]);
2902                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2903                         &node_txn[2]
2904                 };
2905
2906         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2907         assert_eq!(commitment_spend.input.len(), 2);
2908         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2909         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2910         assert_eq!(commitment_spend.lock_time, 0);
2911         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2912         check_spends!(node_txn[3], chan_1.3);
2913         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2914         check_spends!(node_txn[4], node_txn[3]);
2915         check_spends!(node_txn[5], node_txn[3]);
2916         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2917         // we already checked the same situation with A.
2918
2919         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2920         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2921         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2922         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2923         check_closed_broadcast!(nodes[0], true);
2924         check_added_monitors!(nodes[0], 1);
2925         let events = nodes[0].node.get_and_clear_pending_events();
2926         assert_eq!(events.len(), 2);
2927         let mut first_claimed = false;
2928         for event in events {
2929                 match event {
2930                         Event::PaymentSent { payment_preimage } => {
2931                                 if payment_preimage == our_payment_preimage {
2932                                         assert!(!first_claimed);
2933                                         first_claimed = true;
2934                                 } else {
2935                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2936                                 }
2937                         },
2938                         _ => panic!("Unexpected event"),
2939                 }
2940         }
2941         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2942 }
2943
2944 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2945         // Test that in case of a unilateral close onchain, we detect the state of output and
2946         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2947         // broadcasting the right event to other nodes in payment path.
2948         // A ------------------> B ----------------------> C (timeout)
2949         //    B's commitment tx                 C's commitment tx
2950         //            \                                  \
2951         //         B's HTLC timeout tx               B's timeout tx
2952
2953         let chanmon_cfgs = create_chanmon_cfgs(3);
2954         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2955         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2956         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2957         *nodes[0].connect_style.borrow_mut() = connect_style;
2958         *nodes[1].connect_style.borrow_mut() = connect_style;
2959         *nodes[2].connect_style.borrow_mut() = connect_style;
2960
2961         // Create some intial channels
2962         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2963         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2964
2965         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2966         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2967         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2968
2969         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2970
2971         // Broadcast legit commitment tx from C on B's chain
2972         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2973         check_spends!(commitment_tx[0], chan_2.3);
2974         nodes[2].node.fail_htlc_backwards(&payment_hash);
2975         check_added_monitors!(nodes[2], 0);
2976         expect_pending_htlcs_forwardable!(nodes[2]);
2977         check_added_monitors!(nodes[2], 1);
2978
2979         let events = nodes[2].node.get_and_clear_pending_msg_events();
2980         assert_eq!(events.len(), 1);
2981         match events[0] {
2982                 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, .. } } => {
2983                         assert!(update_add_htlcs.is_empty());
2984                         assert!(!update_fail_htlcs.is_empty());
2985                         assert!(update_fulfill_htlcs.is_empty());
2986                         assert!(update_fail_malformed_htlcs.is_empty());
2987                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2988                 },
2989                 _ => panic!("Unexpected event"),
2990         };
2991         mine_transaction(&nodes[2], &commitment_tx[0]);
2992         check_closed_broadcast!(nodes[2], true);
2993         check_added_monitors!(nodes[2], 1);
2994         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2995         assert_eq!(node_txn.len(), 1);
2996         check_spends!(node_txn[0], chan_2.3);
2997         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2998
2999         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3000         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3001         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3002         mine_transaction(&nodes[1], &commitment_tx[0]);
3003         let timeout_tx;
3004         {
3005                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3006                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3007                 assert_eq!(node_txn[0], node_txn[3]);
3008                 assert_eq!(node_txn[1], node_txn[4]);
3009
3010                 check_spends!(node_txn[2], commitment_tx[0]);
3011                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3012
3013                 check_spends!(node_txn[0], chan_2.3);
3014                 check_spends!(node_txn[1], node_txn[0]);
3015                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3016                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3017
3018                 timeout_tx = node_txn[2].clone();
3019                 node_txn.clear();
3020         }
3021
3022         mine_transaction(&nodes[1], &timeout_tx);
3023         check_added_monitors!(nodes[1], 1);
3024         check_closed_broadcast!(nodes[1], true);
3025         {
3026                 // B will rebroadcast a fee-bumped timeout transaction here.
3027                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3028                 assert_eq!(node_txn.len(), 1);
3029                 check_spends!(node_txn[0], commitment_tx[0]);
3030         }
3031
3032         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3033         {
3034                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3035                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3036                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3037                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3038                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3039                 if node_txn.len() == 1 {
3040                         check_spends!(node_txn[0], chan_2.3);
3041                 } else {
3042                         assert_eq!(node_txn.len(), 0);
3043                 }
3044         }
3045
3046         expect_pending_htlcs_forwardable!(nodes[1]);
3047         check_added_monitors!(nodes[1], 1);
3048         let events = nodes[1].node.get_and_clear_pending_msg_events();
3049         assert_eq!(events.len(), 1);
3050         match events[0] {
3051                 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, .. } } => {
3052                         assert!(update_add_htlcs.is_empty());
3053                         assert!(!update_fail_htlcs.is_empty());
3054                         assert!(update_fulfill_htlcs.is_empty());
3055                         assert!(update_fail_malformed_htlcs.is_empty());
3056                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3057                 },
3058                 _ => panic!("Unexpected event"),
3059         };
3060
3061         // Broadcast legit commitment tx from B on A's chain
3062         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3063         check_spends!(commitment_tx[0], chan_1.3);
3064
3065         mine_transaction(&nodes[0], &commitment_tx[0]);
3066         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3067
3068         check_closed_broadcast!(nodes[0], true);
3069         check_added_monitors!(nodes[0], 1);
3070         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3071         assert_eq!(node_txn.len(), 2);
3072         check_spends!(node_txn[0], chan_1.3);
3073         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3074         check_spends!(node_txn[1], commitment_tx[0]);
3075         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3076 }
3077
3078 #[test]
3079 fn test_htlc_on_chain_timeout() {
3080         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3081         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3082         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3083 }
3084
3085 #[test]
3086 fn test_simple_commitment_revoked_fail_backward() {
3087         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3088         // and fail backward accordingly.
3089
3090         let chanmon_cfgs = create_chanmon_cfgs(3);
3091         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3092         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3093         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3094
3095         // Create some initial channels
3096         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3097         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3098
3099         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3100         // Get the will-be-revoked local txn from nodes[2]
3101         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3102         // Revoke the old state
3103         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3104
3105         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3106
3107         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3108         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3109         check_added_monitors!(nodes[1], 1);
3110         check_closed_broadcast!(nodes[1], true);
3111
3112         expect_pending_htlcs_forwardable!(nodes[1]);
3113         check_added_monitors!(nodes[1], 1);
3114         let events = nodes[1].node.get_and_clear_pending_msg_events();
3115         assert_eq!(events.len(), 1);
3116         match events[0] {
3117                 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, .. } } => {
3118                         assert!(update_add_htlcs.is_empty());
3119                         assert_eq!(update_fail_htlcs.len(), 1);
3120                         assert!(update_fulfill_htlcs.is_empty());
3121                         assert!(update_fail_malformed_htlcs.is_empty());
3122                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3123
3124                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3125                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3126                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3127                         expect_payment_failed!(nodes[0], payment_hash, false);
3128                 },
3129                 _ => panic!("Unexpected event"),
3130         }
3131 }
3132
3133 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3134         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3135         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3136         // commitment transaction anymore.
3137         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3138         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3139         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3140         // technically disallowed and we should probably handle it reasonably.
3141         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3142         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3143         // transactions:
3144         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3145         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3146         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3147         //   and once they revoke the previous commitment transaction (allowing us to send a new
3148         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3149         let chanmon_cfgs = create_chanmon_cfgs(3);
3150         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3151         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3152         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3153
3154         // Create some initial channels
3155         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3156         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3157
3158         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 });
3159         // Get the will-be-revoked local txn from nodes[2]
3160         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3161         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3162         // Revoke the old state
3163         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3164
3165         let value = if use_dust {
3166                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3167                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3168                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3169         } else { 3000000 };
3170
3171         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3172         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3173         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3174
3175         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3176         expect_pending_htlcs_forwardable!(nodes[2]);
3177         check_added_monitors!(nodes[2], 1);
3178         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3179         assert!(updates.update_add_htlcs.is_empty());
3180         assert!(updates.update_fulfill_htlcs.is_empty());
3181         assert!(updates.update_fail_malformed_htlcs.is_empty());
3182         assert_eq!(updates.update_fail_htlcs.len(), 1);
3183         assert!(updates.update_fee.is_none());
3184         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3185         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3186         // Drop the last RAA from 3 -> 2
3187
3188         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3189         expect_pending_htlcs_forwardable!(nodes[2]);
3190         check_added_monitors!(nodes[2], 1);
3191         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3192         assert!(updates.update_add_htlcs.is_empty());
3193         assert!(updates.update_fulfill_htlcs.is_empty());
3194         assert!(updates.update_fail_malformed_htlcs.is_empty());
3195         assert_eq!(updates.update_fail_htlcs.len(), 1);
3196         assert!(updates.update_fee.is_none());
3197         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3198         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3199         check_added_monitors!(nodes[1], 1);
3200         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3201         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3202         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3203         check_added_monitors!(nodes[2], 1);
3204
3205         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3206         expect_pending_htlcs_forwardable!(nodes[2]);
3207         check_added_monitors!(nodes[2], 1);
3208         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3209         assert!(updates.update_add_htlcs.is_empty());
3210         assert!(updates.update_fulfill_htlcs.is_empty());
3211         assert!(updates.update_fail_malformed_htlcs.is_empty());
3212         assert_eq!(updates.update_fail_htlcs.len(), 1);
3213         assert!(updates.update_fee.is_none());
3214         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3215         // At this point first_payment_hash has dropped out of the latest two commitment
3216         // transactions that nodes[1] is tracking...
3217         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3218         check_added_monitors!(nodes[1], 1);
3219         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3220         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3221         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3222         check_added_monitors!(nodes[2], 1);
3223
3224         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3225         // on nodes[2]'s RAA.
3226         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3227         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3228         let logger = test_utils::TestLogger::new();
3229         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();
3230         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3231         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3232         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3233         check_added_monitors!(nodes[1], 0);
3234
3235         if deliver_bs_raa {
3236                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3237                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3238                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3239                 check_added_monitors!(nodes[1], 1);
3240                 let events = nodes[1].node.get_and_clear_pending_events();
3241                 assert_eq!(events.len(), 1);
3242                 match events[0] {
3243                         Event::PendingHTLCsForwardable { .. } => { },
3244                         _ => panic!("Unexpected event"),
3245                 };
3246                 // Deliberately don't process the pending fail-back so they all fail back at once after
3247                 // block connection just like the !deliver_bs_raa case
3248         }
3249
3250         let mut failed_htlcs = HashSet::new();
3251         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3252
3253         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3254         check_added_monitors!(nodes[1], 1);
3255         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3256
3257         let events = nodes[1].node.get_and_clear_pending_events();
3258         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3259         match events[0] {
3260                 Event::PaymentFailed { ref payment_hash, .. } => {
3261                         assert_eq!(*payment_hash, fourth_payment_hash);
3262                 },
3263                 _ => panic!("Unexpected event"),
3264         }
3265         if !deliver_bs_raa {
3266                 match events[1] {
3267                         Event::PendingHTLCsForwardable { .. } => { },
3268                         _ => panic!("Unexpected event"),
3269                 };
3270         }
3271         nodes[1].node.process_pending_htlc_forwards();
3272         check_added_monitors!(nodes[1], 1);
3273
3274         let events = nodes[1].node.get_and_clear_pending_msg_events();
3275         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3276         match events[if deliver_bs_raa { 1 } else { 0 }] {
3277                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3278                 _ => panic!("Unexpected event"),
3279         }
3280         match events[if deliver_bs_raa { 2 } else { 1 }] {
3281                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3282                         assert_eq!(channel_id, chan_2.2);
3283                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3284                 },
3285                 _ => panic!("Unexpected event"),
3286         }
3287         if deliver_bs_raa {
3288                 match events[0] {
3289                         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, .. } } => {
3290                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3291                                 assert_eq!(update_add_htlcs.len(), 1);
3292                                 assert!(update_fulfill_htlcs.is_empty());
3293                                 assert!(update_fail_htlcs.is_empty());
3294                                 assert!(update_fail_malformed_htlcs.is_empty());
3295                         },
3296                         _ => panic!("Unexpected event"),
3297                 }
3298         }
3299         match events[if deliver_bs_raa { 3 } else { 2 }] {
3300                 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, .. } } => {
3301                         assert!(update_add_htlcs.is_empty());
3302                         assert_eq!(update_fail_htlcs.len(), 3);
3303                         assert!(update_fulfill_htlcs.is_empty());
3304                         assert!(update_fail_malformed_htlcs.is_empty());
3305                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3306
3307                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3308                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3309                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3310
3311                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3312
3313                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3314                         // If we delivered B's RAA we got an unknown preimage error, not something
3315                         // that we should update our routing table for.
3316                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3317                         for event in events {
3318                                 match event {
3319                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3320                                         _ => panic!("Unexpected event"),
3321                                 }
3322                         }
3323                         let events = nodes[0].node.get_and_clear_pending_events();
3324                         assert_eq!(events.len(), 3);
3325                         match events[0] {
3326                                 Event::PaymentFailed { ref payment_hash, .. } => {
3327                                         assert!(failed_htlcs.insert(payment_hash.0));
3328                                 },
3329                                 _ => panic!("Unexpected event"),
3330                         }
3331                         match events[1] {
3332                                 Event::PaymentFailed { ref payment_hash, .. } => {
3333                                         assert!(failed_htlcs.insert(payment_hash.0));
3334                                 },
3335                                 _ => panic!("Unexpected event"),
3336                         }
3337                         match events[2] {
3338                                 Event::PaymentFailed { ref payment_hash, .. } => {
3339                                         assert!(failed_htlcs.insert(payment_hash.0));
3340                                 },
3341                                 _ => panic!("Unexpected event"),
3342                         }
3343                 },
3344                 _ => panic!("Unexpected event"),
3345         }
3346
3347         assert!(failed_htlcs.contains(&first_payment_hash.0));
3348         assert!(failed_htlcs.contains(&second_payment_hash.0));
3349         assert!(failed_htlcs.contains(&third_payment_hash.0));
3350 }
3351
3352 #[test]
3353 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3354         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3355         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3356         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3357         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3358 }
3359
3360 #[test]
3361 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3362         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3363         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3364         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3365         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3366 }
3367
3368 #[test]
3369 fn fail_backward_pending_htlc_upon_channel_failure() {
3370         let chanmon_cfgs = create_chanmon_cfgs(2);
3371         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3372         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3373         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3374         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3375         let logger = test_utils::TestLogger::new();
3376
3377         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3378         {
3379                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3380                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3381                 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();
3382                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3383                 check_added_monitors!(nodes[0], 1);
3384
3385                 let payment_event = {
3386                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3387                         assert_eq!(events.len(), 1);
3388                         SendEvent::from_event(events.remove(0))
3389                 };
3390                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3391                 assert_eq!(payment_event.msgs.len(), 1);
3392         }
3393
3394         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3395         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3396         {
3397                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3398                 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();
3399                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3400                 check_added_monitors!(nodes[0], 0);
3401
3402                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3403         }
3404
3405         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3406         {
3407                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3408
3409                 let secp_ctx = Secp256k1::new();
3410                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3411                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3412                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3413                 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();
3414                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3415                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3416                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3417
3418                 // Send a 0-msat update_add_htlc to fail the channel.
3419                 let update_add_htlc = msgs::UpdateAddHTLC {
3420                         channel_id: chan.2,
3421                         htlc_id: 0,
3422                         amount_msat: 0,
3423                         payment_hash,
3424                         cltv_expiry,
3425                         onion_routing_packet,
3426                 };
3427                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3428         }
3429
3430         // Check that Alice fails backward the pending HTLC from the second payment.
3431         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3432         check_closed_broadcast!(nodes[0], true);
3433         check_added_monitors!(nodes[0], 1);
3434 }
3435
3436 #[test]
3437 fn test_htlc_ignore_latest_remote_commitment() {
3438         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3439         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3440         let chanmon_cfgs = create_chanmon_cfgs(2);
3441         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3442         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3443         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3444         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3445
3446         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3447         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3448         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3449         check_closed_broadcast!(nodes[0], true);
3450         check_added_monitors!(nodes[0], 1);
3451
3452         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3453         assert_eq!(node_txn.len(), 3);
3454         assert_eq!(node_txn[0], node_txn[1]);
3455
3456         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3457         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3458         check_closed_broadcast!(nodes[1], true);
3459         check_added_monitors!(nodes[1], 1);
3460
3461         // Duplicate the connect_block call since this may happen due to other listeners
3462         // registering new transactions
3463         header.prev_blockhash = header.block_hash();
3464         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3465 }
3466
3467 #[test]
3468 fn test_force_close_fail_back() {
3469         // Check which HTLCs are failed-backwards on channel force-closure
3470         let chanmon_cfgs = create_chanmon_cfgs(3);
3471         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3472         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3473         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3474         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3475         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3476         let logger = test_utils::TestLogger::new();
3477
3478         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3479
3480         let mut payment_event = {
3481                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3482                 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();
3483                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3484                 check_added_monitors!(nodes[0], 1);
3485
3486                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3487                 assert_eq!(events.len(), 1);
3488                 SendEvent::from_event(events.remove(0))
3489         };
3490
3491         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3492         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3493
3494         expect_pending_htlcs_forwardable!(nodes[1]);
3495
3496         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3497         assert_eq!(events_2.len(), 1);
3498         payment_event = SendEvent::from_event(events_2.remove(0));
3499         assert_eq!(payment_event.msgs.len(), 1);
3500
3501         check_added_monitors!(nodes[1], 1);
3502         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3503         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3504         check_added_monitors!(nodes[2], 1);
3505         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3506
3507         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3508         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3509         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3510
3511         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3512         check_closed_broadcast!(nodes[2], true);
3513         check_added_monitors!(nodes[2], 1);
3514         let tx = {
3515                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3516                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3517                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3518                 // back to nodes[1] upon timeout otherwise.
3519                 assert_eq!(node_txn.len(), 1);
3520                 node_txn.remove(0)
3521         };
3522
3523         mine_transaction(&nodes[1], &tx);
3524
3525         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3526         check_closed_broadcast!(nodes[1], true);
3527         check_added_monitors!(nodes[1], 1);
3528
3529         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3530         {
3531                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3532                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3533                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3534         }
3535         mine_transaction(&nodes[2], &tx);
3536         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3537         assert_eq!(node_txn.len(), 1);
3538         assert_eq!(node_txn[0].input.len(), 1);
3539         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3540         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3541         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3542
3543         check_spends!(node_txn[0], tx);
3544 }
3545
3546 #[test]
3547 fn test_dup_events_on_peer_disconnect() {
3548         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3549         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3550         // as we used to generate the event immediately upon receipt of the payment preimage in the
3551         // update_fulfill_htlc message.
3552
3553         let chanmon_cfgs = create_chanmon_cfgs(2);
3554         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3555         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3556         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3557         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3558
3559         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3560
3561         assert!(nodes[1].node.claim_funds(payment_preimage));
3562         check_added_monitors!(nodes[1], 1);
3563         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3564         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3565         expect_payment_sent!(nodes[0], payment_preimage);
3566
3567         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3568         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3569
3570         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3571         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3572 }
3573
3574 #[test]
3575 fn test_simple_peer_disconnect() {
3576         // Test that we can reconnect when there are no lost messages
3577         let chanmon_cfgs = create_chanmon_cfgs(3);
3578         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3579         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3580         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3581         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3582         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3583
3584         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3585         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3586         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3587
3588         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3589         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3590         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3591         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3592
3593         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3594         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3595         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3596
3597         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3598         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3599         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3600         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
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
3605         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3606         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3607
3608         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3609         {
3610                 let events = nodes[0].node.get_and_clear_pending_events();
3611                 assert_eq!(events.len(), 2);
3612                 match events[0] {
3613                         Event::PaymentSent { payment_preimage } => {
3614                                 assert_eq!(payment_preimage, payment_preimage_3);
3615                         },
3616                         _ => panic!("Unexpected event"),
3617                 }
3618                 match events[1] {
3619                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3620                                 assert_eq!(payment_hash, payment_hash_5);
3621                                 assert!(rejected_by_dest);
3622                         },
3623                         _ => panic!("Unexpected event"),
3624                 }
3625         }
3626
3627         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3628         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3629 }
3630
3631 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3632         // Test that we can reconnect when in-flight HTLC updates get dropped
3633         let chanmon_cfgs = create_chanmon_cfgs(2);
3634         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3635         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3636         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3637
3638         let mut as_funding_locked = None;
3639         if messages_delivered == 0 {
3640                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3641                 as_funding_locked = Some(funding_locked);
3642                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3643                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3644                 // it before the channel_reestablish message.
3645         } else {
3646                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3647         }
3648
3649         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3650
3651         let logger = test_utils::TestLogger::new();
3652         let payment_event = {
3653                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3654                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3655                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3656                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3657                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3658                 check_added_monitors!(nodes[0], 1);
3659
3660                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3661                 assert_eq!(events.len(), 1);
3662                 SendEvent::from_event(events.remove(0))
3663         };
3664         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3665
3666         if messages_delivered < 2 {
3667                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3668         } else {
3669                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3670                 if messages_delivered >= 3 {
3671                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3672                         check_added_monitors!(nodes[1], 1);
3673                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3674
3675                         if messages_delivered >= 4 {
3676                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3677                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3678                                 check_added_monitors!(nodes[0], 1);
3679
3680                                 if messages_delivered >= 5 {
3681                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3682                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3683                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3684                                         check_added_monitors!(nodes[0], 1);
3685
3686                                         if messages_delivered >= 6 {
3687                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3688                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3689                                                 check_added_monitors!(nodes[1], 1);
3690                                         }
3691                                 }
3692                         }
3693                 }
3694         }
3695
3696         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3697         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3698         if messages_delivered < 3 {
3699                 if simulate_broken_lnd {
3700                         // lnd has a long-standing bug where they send a funding_locked prior to a
3701                         // channel_reestablish if you reconnect prior to funding_locked time.
3702                         //
3703                         // Here we simulate that behavior, delivering a funding_locked immediately on
3704                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3705                         // in `reconnect_nodes` but we currently don't fail based on that.
3706                         //
3707                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3708                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3709                 }
3710                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3711                 // received on either side, both sides will need to resend them.
3712                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3713         } else if messages_delivered == 3 {
3714                 // nodes[0] still wants its RAA + commitment_signed
3715                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3716         } else if messages_delivered == 4 {
3717                 // nodes[0] still wants its commitment_signed
3718                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3719         } else if messages_delivered == 5 {
3720                 // nodes[1] still wants its final RAA
3721                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3722         } else if messages_delivered == 6 {
3723                 // Everything was delivered...
3724                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3725         }
3726
3727         let events_1 = nodes[1].node.get_and_clear_pending_events();
3728         assert_eq!(events_1.len(), 1);
3729         match events_1[0] {
3730                 Event::PendingHTLCsForwardable { .. } => { },
3731                 _ => panic!("Unexpected event"),
3732         };
3733
3734         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3735         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3736         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3737
3738         nodes[1].node.process_pending_htlc_forwards();
3739
3740         let events_2 = nodes[1].node.get_and_clear_pending_events();
3741         assert_eq!(events_2.len(), 1);
3742         match events_2[0] {
3743                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3744                         assert_eq!(payment_hash_1, *payment_hash);
3745                         assert!(payment_preimage.is_none());
3746                         assert_eq!(payment_secret_1, *payment_secret);
3747                         assert_eq!(amt, 1000000);
3748                 },
3749                 _ => panic!("Unexpected event"),
3750         }
3751
3752         nodes[1].node.claim_funds(payment_preimage_1);
3753         check_added_monitors!(nodes[1], 1);
3754
3755         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3756         assert_eq!(events_3.len(), 1);
3757         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3758                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3759                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3760                         assert!(updates.update_add_htlcs.is_empty());
3761                         assert!(updates.update_fail_htlcs.is_empty());
3762                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3763                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3764                         assert!(updates.update_fee.is_none());
3765                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3766                 },
3767                 _ => panic!("Unexpected event"),
3768         };
3769
3770         if messages_delivered >= 1 {
3771                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3772
3773                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3774                 assert_eq!(events_4.len(), 1);
3775                 match events_4[0] {
3776                         Event::PaymentSent { ref payment_preimage } => {
3777                                 assert_eq!(payment_preimage_1, *payment_preimage);
3778                         },
3779                         _ => panic!("Unexpected event"),
3780                 }
3781
3782                 if messages_delivered >= 2 {
3783                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3784                         check_added_monitors!(nodes[0], 1);
3785                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3786
3787                         if messages_delivered >= 3 {
3788                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3789                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3790                                 check_added_monitors!(nodes[1], 1);
3791
3792                                 if messages_delivered >= 4 {
3793                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3794                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3795                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3796                                         check_added_monitors!(nodes[1], 1);
3797
3798                                         if messages_delivered >= 5 {
3799                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3800                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3801                                                 check_added_monitors!(nodes[0], 1);
3802                                         }
3803                                 }
3804                         }
3805                 }
3806         }
3807
3808         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3809         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3810         if messages_delivered < 2 {
3811                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3812                 if messages_delivered < 1 {
3813                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3814                         assert_eq!(events_4.len(), 1);
3815                         match events_4[0] {
3816                                 Event::PaymentSent { ref payment_preimage } => {
3817                                         assert_eq!(payment_preimage_1, *payment_preimage);
3818                                 },
3819                                 _ => panic!("Unexpected event"),
3820                         }
3821                 } else {
3822                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3823                 }
3824         } else if messages_delivered == 2 {
3825                 // nodes[0] still wants its RAA + commitment_signed
3826                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3827         } else if messages_delivered == 3 {
3828                 // nodes[0] still wants its commitment_signed
3829                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3830         } else if messages_delivered == 4 {
3831                 // nodes[1] still wants its final RAA
3832                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3833         } else if messages_delivered == 5 {
3834                 // Everything was delivered...
3835                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3836         }
3837
3838         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3839         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3840         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3841
3842         // Channel should still work fine...
3843         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3844         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3845                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3846                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3847         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3848         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3849 }
3850
3851 #[test]
3852 fn test_drop_messages_peer_disconnect_a() {
3853         do_test_drop_messages_peer_disconnect(0, true);
3854         do_test_drop_messages_peer_disconnect(0, false);
3855         do_test_drop_messages_peer_disconnect(1, false);
3856         do_test_drop_messages_peer_disconnect(2, false);
3857 }
3858
3859 #[test]
3860 fn test_drop_messages_peer_disconnect_b() {
3861         do_test_drop_messages_peer_disconnect(3, false);
3862         do_test_drop_messages_peer_disconnect(4, false);
3863         do_test_drop_messages_peer_disconnect(5, false);
3864         do_test_drop_messages_peer_disconnect(6, false);
3865 }
3866
3867 #[test]
3868 fn test_funding_peer_disconnect() {
3869         // Test that we can lock in our funding tx while disconnected
3870         let chanmon_cfgs = create_chanmon_cfgs(2);
3871         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3872         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3873         let persister: test_utils::TestPersister;
3874         let new_chain_monitor: test_utils::TestChainMonitor;
3875         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3876         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3877         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3878
3879         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3880         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3881
3882         confirm_transaction(&nodes[0], &tx);
3883         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3884         assert_eq!(events_1.len(), 1);
3885         match events_1[0] {
3886                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3887                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3888                 },
3889                 _ => panic!("Unexpected event"),
3890         }
3891
3892         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3893
3894         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3895         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896
3897         confirm_transaction(&nodes[1], &tx);
3898         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3899         assert_eq!(events_2.len(), 2);
3900         let funding_locked = match events_2[0] {
3901                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3902                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3903                         msg.clone()
3904                 },
3905                 _ => panic!("Unexpected event"),
3906         };
3907         let bs_announcement_sigs = match events_2[1] {
3908                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3909                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3910                         msg.clone()
3911                 },
3912                 _ => panic!("Unexpected event"),
3913         };
3914
3915         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3916
3917         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3918         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3919         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3920         assert_eq!(events_3.len(), 2);
3921         let as_announcement_sigs = match events_3[0] {
3922                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3923                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3924                         msg.clone()
3925                 },
3926                 _ => panic!("Unexpected event"),
3927         };
3928         let (as_announcement, as_update) = match events_3[1] {
3929                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3930                         (msg.clone(), update_msg.clone())
3931                 },
3932                 _ => panic!("Unexpected event"),
3933         };
3934
3935         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3936         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3937         assert_eq!(events_4.len(), 1);
3938         let (_, bs_update) = match events_4[0] {
3939                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3940                         (msg.clone(), update_msg.clone())
3941                 },
3942                 _ => panic!("Unexpected event"),
3943         };
3944
3945         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3946         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3947         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3948
3949         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3950         let logger = test_utils::TestLogger::new();
3951         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();
3952         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3953         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3954
3955         // Check that after deserialization and reconnection we can still generate an identical
3956         // channel_announcement from the cached signatures.
3957         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3958
3959         let nodes_0_serialized = nodes[0].node.encode();
3960         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3961         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3962
3963         persister = test_utils::TestPersister::new();
3964         let keys_manager = &chanmon_cfgs[0].keys_manager;
3965         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);
3966         nodes[0].chain_monitor = &new_chain_monitor;
3967         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3968         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3969                 &mut chan_0_monitor_read, keys_manager).unwrap();
3970         assert!(chan_0_monitor_read.is_empty());
3971
3972         let mut nodes_0_read = &nodes_0_serialized[..];
3973         let (_, nodes_0_deserialized_tmp) = {
3974                 let mut channel_monitors = HashMap::new();
3975                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3976                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3977                         default_config: UserConfig::default(),
3978                         keys_manager,
3979                         fee_estimator: node_cfgs[0].fee_estimator,
3980                         chain_monitor: nodes[0].chain_monitor,
3981                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3982                         logger: nodes[0].logger,
3983                         channel_monitors,
3984                 }).unwrap()
3985         };
3986         nodes_0_deserialized = nodes_0_deserialized_tmp;
3987         assert!(nodes_0_read.is_empty());
3988
3989         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3990         nodes[0].node = &nodes_0_deserialized;
3991         check_added_monitors!(nodes[0], 1);
3992
3993         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3994
3995         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3996         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3997         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3998         let mut found_announcement = false;
3999         for event in msgs.iter() {
4000                 match event {
4001                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
4002                                 if *msg == as_announcement { found_announcement = true; }
4003                         },
4004                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
4005                         _ => panic!("Unexpected event"),
4006                 }
4007         }
4008         assert!(found_announcement);
4009 }
4010
4011 #[test]
4012 fn test_drop_messages_peer_disconnect_dual_htlc() {
4013         // Test that we can handle reconnecting when both sides of a channel have pending
4014         // commitment_updates when we disconnect.
4015         let chanmon_cfgs = create_chanmon_cfgs(2);
4016         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4017         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4018         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4019         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4020         let logger = test_utils::TestLogger::new();
4021
4022         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4023
4024         // Now try to send a second payment which will fail to send
4025         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4026         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4027         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();
4028         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4029         check_added_monitors!(nodes[0], 1);
4030
4031         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4032         assert_eq!(events_1.len(), 1);
4033         match events_1[0] {
4034                 MessageSendEvent::UpdateHTLCs { .. } => {},
4035                 _ => panic!("Unexpected event"),
4036         }
4037
4038         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4039         check_added_monitors!(nodes[1], 1);
4040
4041         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4042         assert_eq!(events_2.len(), 1);
4043         match events_2[0] {
4044                 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 } } => {
4045                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4046                         assert!(update_add_htlcs.is_empty());
4047                         assert_eq!(update_fulfill_htlcs.len(), 1);
4048                         assert!(update_fail_htlcs.is_empty());
4049                         assert!(update_fail_malformed_htlcs.is_empty());
4050                         assert!(update_fee.is_none());
4051
4052                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4053                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4054                         assert_eq!(events_3.len(), 1);
4055                         match events_3[0] {
4056                                 Event::PaymentSent { ref payment_preimage } => {
4057                                         assert_eq!(*payment_preimage, payment_preimage_1);
4058                                 },
4059                                 _ => panic!("Unexpected event"),
4060                         }
4061
4062                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4063                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4064                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4065                         check_added_monitors!(nodes[0], 1);
4066                 },
4067                 _ => panic!("Unexpected event"),
4068         }
4069
4070         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4071         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4072
4073         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4074         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4075         assert_eq!(reestablish_1.len(), 1);
4076         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4077         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4078         assert_eq!(reestablish_2.len(), 1);
4079
4080         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4081         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4082         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4083         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4084
4085         assert!(as_resp.0.is_none());
4086         assert!(bs_resp.0.is_none());
4087
4088         assert!(bs_resp.1.is_none());
4089         assert!(bs_resp.2.is_none());
4090
4091         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4092
4093         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4094         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4095         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4096         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4097         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4098         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4099         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4100         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4101         // No commitment_signed so get_event_msg's assert(len == 1) passes
4102         check_added_monitors!(nodes[1], 1);
4103
4104         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4105         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4106         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4107         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4108         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4109         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4110         assert!(bs_second_commitment_signed.update_fee.is_none());
4111         check_added_monitors!(nodes[1], 1);
4112
4113         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4114         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4115         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4116         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4117         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4118         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4119         assert!(as_commitment_signed.update_fee.is_none());
4120         check_added_monitors!(nodes[0], 1);
4121
4122         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4123         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4124         // No commitment_signed so get_event_msg's assert(len == 1) passes
4125         check_added_monitors!(nodes[0], 1);
4126
4127         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4128         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4129         // No commitment_signed so get_event_msg's assert(len == 1) passes
4130         check_added_monitors!(nodes[1], 1);
4131
4132         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4133         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4134         check_added_monitors!(nodes[1], 1);
4135
4136         expect_pending_htlcs_forwardable!(nodes[1]);
4137
4138         let events_5 = nodes[1].node.get_and_clear_pending_events();
4139         assert_eq!(events_5.len(), 1);
4140         match events_5[0] {
4141                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4142                         assert_eq!(payment_hash_2, *payment_hash);
4143                         assert!(payment_preimage.is_none());
4144                         assert_eq!(payment_secret_2, *payment_secret);
4145                 },
4146                 _ => panic!("Unexpected event"),
4147         }
4148
4149         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4150         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4151         check_added_monitors!(nodes[0], 1);
4152
4153         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4154 }
4155
4156 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4157         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4158         // to avoid our counterparty failing the channel.
4159         let chanmon_cfgs = create_chanmon_cfgs(2);
4160         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4161         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4162         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4163
4164         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4165         let logger = test_utils::TestLogger::new();
4166
4167         let our_payment_hash = if send_partial_mpp {
4168                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4169                 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();
4170                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4171                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4172                 // indicates there are more HTLCs coming.
4173                 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.
4174                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4175                 check_added_monitors!(nodes[0], 1);
4176                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4177                 assert_eq!(events.len(), 1);
4178                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4179                 // hop should *not* yet generate any PaymentReceived event(s).
4180                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4181                 our_payment_hash
4182         } else {
4183                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4184         };
4185
4186         let mut block = Block {
4187                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4188                 txdata: vec![],
4189         };
4190         connect_block(&nodes[0], &block);
4191         connect_block(&nodes[1], &block);
4192         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4193         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4194                 block.header.prev_blockhash = block.block_hash();
4195                 connect_block(&nodes[0], &block);
4196                 connect_block(&nodes[1], &block);
4197         }
4198
4199         expect_pending_htlcs_forwardable!(nodes[1]);
4200
4201         check_added_monitors!(nodes[1], 1);
4202         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4203         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4204         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4205         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4206         assert!(htlc_timeout_updates.update_fee.is_none());
4207
4208         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4209         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4210         // 100_000 msat as u64, followed by the height at which we failed back above
4211         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4212         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4213         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4214 }
4215
4216 #[test]
4217 fn test_htlc_timeout() {
4218         do_test_htlc_timeout(true);
4219         do_test_htlc_timeout(false);
4220 }
4221
4222 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4223         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4224         let chanmon_cfgs = create_chanmon_cfgs(3);
4225         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4226         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4227         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4228         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4229         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4230
4231         // Make sure all nodes are at the same starting height
4232         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4233         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4234         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4235
4236         let logger = test_utils::TestLogger::new();
4237
4238         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4239         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4240         {
4241                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4242                 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();
4243                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4244         }
4245         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4246         check_added_monitors!(nodes[1], 1);
4247
4248         // Now attempt to route a second payment, which should be placed in the holding cell
4249         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4250         if forwarded_htlc {
4251                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4252                 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();
4253                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4254                 check_added_monitors!(nodes[0], 1);
4255                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4256                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4257                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4258                 expect_pending_htlcs_forwardable!(nodes[1]);
4259                 check_added_monitors!(nodes[1], 0);
4260         } else {
4261                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4262                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4263                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4264                 check_added_monitors!(nodes[1], 0);
4265         }
4266
4267         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4268         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4269         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4270         connect_blocks(&nodes[1], 1);
4271
4272         if forwarded_htlc {
4273                 expect_pending_htlcs_forwardable!(nodes[1]);
4274                 check_added_monitors!(nodes[1], 1);
4275                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4276                 assert_eq!(fail_commit.len(), 1);
4277                 match fail_commit[0] {
4278                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4279                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4280                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4281                         },
4282                         _ => unreachable!(),
4283                 }
4284                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4285                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4286         } else {
4287                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4288         }
4289 }
4290
4291 #[test]
4292 fn test_holding_cell_htlc_add_timeouts() {
4293         do_test_holding_cell_htlc_add_timeouts(false);
4294         do_test_holding_cell_htlc_add_timeouts(true);
4295 }
4296
4297 #[test]
4298 fn test_invalid_channel_announcement() {
4299         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4300         let secp_ctx = Secp256k1::new();
4301         let chanmon_cfgs = create_chanmon_cfgs(2);
4302         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4303         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4304         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4305
4306         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4307
4308         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4309         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4310         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4311         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4312
4313         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 } );
4314
4315         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4316         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4317
4318         let as_network_key = nodes[0].node.get_our_node_id();
4319         let bs_network_key = nodes[1].node.get_our_node_id();
4320
4321         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4322
4323         let mut chan_announcement;
4324
4325         macro_rules! dummy_unsigned_msg {
4326                 () => {
4327                         msgs::UnsignedChannelAnnouncement {
4328                                 features: ChannelFeatures::known(),
4329                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4330                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4331                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4332                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4333                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4334                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4335                                 excess_data: Vec::new(),
4336                         };
4337                 }
4338         }
4339
4340         macro_rules! sign_msg {
4341                 ($unsigned_msg: expr) => {
4342                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4343                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4344                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4345                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4346                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4347                         chan_announcement = msgs::ChannelAnnouncement {
4348                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4349                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4350                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4351                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4352                                 contents: $unsigned_msg
4353                         }
4354                 }
4355         }
4356
4357         let unsigned_msg = dummy_unsigned_msg!();
4358         sign_msg!(unsigned_msg);
4359         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4360         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 } );
4361
4362         // Configured with Network::Testnet
4363         let mut unsigned_msg = dummy_unsigned_msg!();
4364         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4365         sign_msg!(unsigned_msg);
4366         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4367
4368         let mut unsigned_msg = dummy_unsigned_msg!();
4369         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4370         sign_msg!(unsigned_msg);
4371         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4372 }
4373
4374 #[test]
4375 fn test_no_txn_manager_serialize_deserialize() {
4376         let chanmon_cfgs = create_chanmon_cfgs(2);
4377         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4378         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4379         let logger: test_utils::TestLogger;
4380         let fee_estimator: test_utils::TestFeeEstimator;
4381         let persister: test_utils::TestPersister;
4382         let new_chain_monitor: test_utils::TestChainMonitor;
4383         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4384         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4385
4386         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4387
4388         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4389
4390         let nodes_0_serialized = nodes[0].node.encode();
4391         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4392         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4393
4394         logger = test_utils::TestLogger::new();
4395         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4396         persister = test_utils::TestPersister::new();
4397         let keys_manager = &chanmon_cfgs[0].keys_manager;
4398         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4399         nodes[0].chain_monitor = &new_chain_monitor;
4400         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4401         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4402                 &mut chan_0_monitor_read, keys_manager).unwrap();
4403         assert!(chan_0_monitor_read.is_empty());
4404
4405         let mut nodes_0_read = &nodes_0_serialized[..];
4406         let config = UserConfig::default();
4407         let (_, nodes_0_deserialized_tmp) = {
4408                 let mut channel_monitors = HashMap::new();
4409                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4410                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4411                         default_config: config,
4412                         keys_manager,
4413                         fee_estimator: &fee_estimator,
4414                         chain_monitor: nodes[0].chain_monitor,
4415                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4416                         logger: &logger,
4417                         channel_monitors,
4418                 }).unwrap()
4419         };
4420         nodes_0_deserialized = nodes_0_deserialized_tmp;
4421         assert!(nodes_0_read.is_empty());
4422
4423         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4424         nodes[0].node = &nodes_0_deserialized;
4425         assert_eq!(nodes[0].node.list_channels().len(), 1);
4426         check_added_monitors!(nodes[0], 1);
4427
4428         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4429         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4430         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4431         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4432
4433         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4434         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4435         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4436         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4437
4438         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4439         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4440         for node in nodes.iter() {
4441                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4442                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4443                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4444         }
4445
4446         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4447 }
4448
4449 #[test]
4450 fn test_dup_htlc_onchain_fails_on_reload() {
4451         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4452         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4453         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4454         // the ChannelMonitor tells it to.
4455         //
4456         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4457         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4458         // PaymentFailed event appearing). However, because we may not serialize the relevant
4459         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4460         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4461         // and de-duplicates ChannelMonitor events.
4462         //
4463         // This tests that explicit tracking behavior.
4464         let chanmon_cfgs = create_chanmon_cfgs(2);
4465         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4466         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4467         let persister: test_utils::TestPersister;
4468         let new_chain_monitor: test_utils::TestChainMonitor;
4469         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4470         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4471
4472         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4473
4474         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4475         // nodes[0].
4476         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4477         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4478         check_closed_broadcast!(nodes[0], true);
4479         check_added_monitors!(nodes[0], 1);
4480
4481         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4482         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4483
4484         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4485         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4486         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4487         assert_eq!(node_txn.len(), 3);
4488         assert_eq!(node_txn[0], node_txn[1]);
4489
4490         assert!(nodes[1].node.claim_funds(payment_preimage));
4491         check_added_monitors!(nodes[1], 1);
4492
4493         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4494         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4495         check_closed_broadcast!(nodes[1], true);
4496         check_added_monitors!(nodes[1], 1);
4497         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4498
4499         header.prev_blockhash = nodes[0].best_block_hash();
4500         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4501
4502         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4503         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4504         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4505         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4506         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4507
4508         header.prev_blockhash = nodes[0].best_block_hash();
4509         let claim_block = Block { header, txdata: claim_txn};
4510         connect_block(&nodes[0], &claim_block);
4511         expect_payment_sent!(nodes[0], payment_preimage);
4512
4513         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4514         // connected a highly-relevant block, it likely gets serialized out now.
4515         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4516         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4517
4518         // Now reload nodes[0]...
4519         persister = test_utils::TestPersister::new();
4520         let keys_manager = &chanmon_cfgs[0].keys_manager;
4521         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);
4522         nodes[0].chain_monitor = &new_chain_monitor;
4523         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4524         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4525                 &mut chan_0_monitor_read, keys_manager).unwrap();
4526         assert!(chan_0_monitor_read.is_empty());
4527
4528         let (_, nodes_0_deserialized_tmp) = {
4529                 let mut channel_monitors = HashMap::new();
4530                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4531                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4532                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4533                                 default_config: Default::default(),
4534                                 keys_manager,
4535                                 fee_estimator: node_cfgs[0].fee_estimator,
4536                                 chain_monitor: nodes[0].chain_monitor,
4537                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4538                                 logger: nodes[0].logger,
4539                                 channel_monitors,
4540                         }).unwrap()
4541         };
4542         nodes_0_deserialized = nodes_0_deserialized_tmp;
4543
4544         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4545         check_added_monitors!(nodes[0], 1);
4546         nodes[0].node = &nodes_0_deserialized;
4547
4548         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4549         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4550         // payment events should kick in, leaving us with no pending events here.
4551         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4552         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4553         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4554 }
4555
4556 #[test]
4557 fn test_manager_serialize_deserialize_events() {
4558         // This test makes sure the events field in ChannelManager survives de/serialization
4559         let chanmon_cfgs = create_chanmon_cfgs(2);
4560         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4561         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4562         let fee_estimator: test_utils::TestFeeEstimator;
4563         let persister: test_utils::TestPersister;
4564         let logger: test_utils::TestLogger;
4565         let new_chain_monitor: test_utils::TestChainMonitor;
4566         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4567         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4568
4569         // Start creating a channel, but stop right before broadcasting the funding transaction
4570         let channel_value = 100000;
4571         let push_msat = 10001;
4572         let a_flags = InitFeatures::known();
4573         let b_flags = InitFeatures::known();
4574         let node_a = nodes.remove(0);
4575         let node_b = nodes.remove(0);
4576         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4577         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()));
4578         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()));
4579
4580         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4581
4582         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4583         check_added_monitors!(node_a, 0);
4584
4585         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()));
4586         {
4587                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4588                 assert_eq!(added_monitors.len(), 1);
4589                 assert_eq!(added_monitors[0].0, funding_output);
4590                 added_monitors.clear();
4591         }
4592
4593         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()));
4594         {
4595                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4596                 assert_eq!(added_monitors.len(), 1);
4597                 assert_eq!(added_monitors[0].0, funding_output);
4598                 added_monitors.clear();
4599         }
4600         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4601
4602         nodes.push(node_a);
4603         nodes.push(node_b);
4604
4605         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4606         let nodes_0_serialized = nodes[0].node.encode();
4607         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4608         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4609
4610         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4611         logger = test_utils::TestLogger::new();
4612         persister = test_utils::TestPersister::new();
4613         let keys_manager = &chanmon_cfgs[0].keys_manager;
4614         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4615         nodes[0].chain_monitor = &new_chain_monitor;
4616         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4617         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4618                 &mut chan_0_monitor_read, keys_manager).unwrap();
4619         assert!(chan_0_monitor_read.is_empty());
4620
4621         let mut nodes_0_read = &nodes_0_serialized[..];
4622         let config = UserConfig::default();
4623         let (_, nodes_0_deserialized_tmp) = {
4624                 let mut channel_monitors = HashMap::new();
4625                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4626                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4627                         default_config: config,
4628                         keys_manager,
4629                         fee_estimator: &fee_estimator,
4630                         chain_monitor: nodes[0].chain_monitor,
4631                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4632                         logger: &logger,
4633                         channel_monitors,
4634                 }).unwrap()
4635         };
4636         nodes_0_deserialized = nodes_0_deserialized_tmp;
4637         assert!(nodes_0_read.is_empty());
4638
4639         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4640
4641         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4642         nodes[0].node = &nodes_0_deserialized;
4643
4644         // After deserializing, make sure the funding_transaction is still held by the channel manager
4645         let events_4 = nodes[0].node.get_and_clear_pending_events();
4646         assert_eq!(events_4.len(), 0);
4647         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4648         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4649
4650         // Make sure the channel is functioning as though the de/serialization never happened
4651         assert_eq!(nodes[0].node.list_channels().len(), 1);
4652         check_added_monitors!(nodes[0], 1);
4653
4654         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4655         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4656         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4657         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4658
4659         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4660         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4661         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4663
4664         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4665         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4666         for node in nodes.iter() {
4667                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4668                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4669                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4670         }
4671
4672         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4673 }
4674
4675 #[test]
4676 fn test_simple_manager_serialize_deserialize() {
4677         let chanmon_cfgs = create_chanmon_cfgs(2);
4678         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4679         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4680         let logger: test_utils::TestLogger;
4681         let fee_estimator: test_utils::TestFeeEstimator;
4682         let persister: test_utils::TestPersister;
4683         let new_chain_monitor: test_utils::TestChainMonitor;
4684         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4685         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4686         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4687
4688         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4689         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4690
4691         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4692
4693         let nodes_0_serialized = nodes[0].node.encode();
4694         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4695         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4696
4697         logger = test_utils::TestLogger::new();
4698         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4699         persister = test_utils::TestPersister::new();
4700         let keys_manager = &chanmon_cfgs[0].keys_manager;
4701         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4702         nodes[0].chain_monitor = &new_chain_monitor;
4703         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4704         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4705                 &mut chan_0_monitor_read, keys_manager).unwrap();
4706         assert!(chan_0_monitor_read.is_empty());
4707
4708         let mut nodes_0_read = &nodes_0_serialized[..];
4709         let (_, nodes_0_deserialized_tmp) = {
4710                 let mut channel_monitors = HashMap::new();
4711                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4712                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4713                         default_config: UserConfig::default(),
4714                         keys_manager,
4715                         fee_estimator: &fee_estimator,
4716                         chain_monitor: nodes[0].chain_monitor,
4717                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4718                         logger: &logger,
4719                         channel_monitors,
4720                 }).unwrap()
4721         };
4722         nodes_0_deserialized = nodes_0_deserialized_tmp;
4723         assert!(nodes_0_read.is_empty());
4724
4725         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4726         nodes[0].node = &nodes_0_deserialized;
4727         check_added_monitors!(nodes[0], 1);
4728
4729         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4730
4731         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4732         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4733 }
4734
4735 #[test]
4736 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4737         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4738         let chanmon_cfgs = create_chanmon_cfgs(4);
4739         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4740         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4741         let logger: test_utils::TestLogger;
4742         let fee_estimator: test_utils::TestFeeEstimator;
4743         let persister: test_utils::TestPersister;
4744         let new_chain_monitor: test_utils::TestChainMonitor;
4745         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4746         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4747         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4748         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4749         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4750
4751         let mut node_0_stale_monitors_serialized = Vec::new();
4752         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4753                 let mut writer = test_utils::TestVecWriter(Vec::new());
4754                 monitor.1.write(&mut writer).unwrap();
4755                 node_0_stale_monitors_serialized.push(writer.0);
4756         }
4757
4758         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4759
4760         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4761         let nodes_0_serialized = nodes[0].node.encode();
4762
4763         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4764         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4765         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4766         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4767
4768         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4769         // nodes[3])
4770         let mut node_0_monitors_serialized = Vec::new();
4771         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4772                 let mut writer = test_utils::TestVecWriter(Vec::new());
4773                 monitor.1.write(&mut writer).unwrap();
4774                 node_0_monitors_serialized.push(writer.0);
4775         }
4776
4777         logger = test_utils::TestLogger::new();
4778         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4779         persister = test_utils::TestPersister::new();
4780         let keys_manager = &chanmon_cfgs[0].keys_manager;
4781         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4782         nodes[0].chain_monitor = &new_chain_monitor;
4783
4784
4785         let mut node_0_stale_monitors = Vec::new();
4786         for serialized in node_0_stale_monitors_serialized.iter() {
4787                 let mut read = &serialized[..];
4788                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4789                 assert!(read.is_empty());
4790                 node_0_stale_monitors.push(monitor);
4791         }
4792
4793         let mut node_0_monitors = Vec::new();
4794         for serialized in node_0_monitors_serialized.iter() {
4795                 let mut read = &serialized[..];
4796                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4797                 assert!(read.is_empty());
4798                 node_0_monitors.push(monitor);
4799         }
4800
4801         let mut nodes_0_read = &nodes_0_serialized[..];
4802         if let Err(msgs::DecodeError::InvalidValue) =
4803                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4804                 default_config: UserConfig::default(),
4805                 keys_manager,
4806                 fee_estimator: &fee_estimator,
4807                 chain_monitor: nodes[0].chain_monitor,
4808                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4809                 logger: &logger,
4810                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4811         }) { } else {
4812                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4813         };
4814
4815         let mut nodes_0_read = &nodes_0_serialized[..];
4816         let (_, nodes_0_deserialized_tmp) =
4817                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4818                 default_config: UserConfig::default(),
4819                 keys_manager,
4820                 fee_estimator: &fee_estimator,
4821                 chain_monitor: nodes[0].chain_monitor,
4822                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4823                 logger: &logger,
4824                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4825         }).unwrap();
4826         nodes_0_deserialized = nodes_0_deserialized_tmp;
4827         assert!(nodes_0_read.is_empty());
4828
4829         { // Channel close should result in a commitment tx
4830                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4831                 assert_eq!(txn.len(), 1);
4832                 check_spends!(txn[0], funding_tx);
4833                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4834         }
4835
4836         for monitor in node_0_monitors.drain(..) {
4837                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4838                 check_added_monitors!(nodes[0], 1);
4839         }
4840         nodes[0].node = &nodes_0_deserialized;
4841
4842         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4843         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4844         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4845         //... and we can even still claim the payment!
4846         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4847
4848         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4849         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4850         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4851         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4852         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4853         assert_eq!(msg_events.len(), 1);
4854         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4855                 match action {
4856                         &ErrorAction::SendErrorMessage { ref msg } => {
4857                                 assert_eq!(msg.channel_id, channel_id);
4858                         },
4859                         _ => panic!("Unexpected event!"),
4860                 }
4861         }
4862 }
4863
4864 macro_rules! check_spendable_outputs {
4865         ($node: expr, $keysinterface: expr) => {
4866                 {
4867                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4868                         let mut txn = Vec::new();
4869                         let mut all_outputs = Vec::new();
4870                         let secp_ctx = Secp256k1::new();
4871                         for event in events.drain(..) {
4872                                 match event {
4873                                         Event::SpendableOutputs { mut outputs } => {
4874                                                 for outp in outputs.drain(..) {
4875                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4876                                                         all_outputs.push(outp);
4877                                                 }
4878                                         },
4879                                         _ => panic!("Unexpected event"),
4880                                 };
4881                         }
4882                         if all_outputs.len() > 1 {
4883                                 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) {
4884                                         txn.push(tx);
4885                                 }
4886                         }
4887                         txn
4888                 }
4889         }
4890 }
4891
4892 #[test]
4893 fn test_claim_sizeable_push_msat() {
4894         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4895         let chanmon_cfgs = create_chanmon_cfgs(2);
4896         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4897         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4898         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4899
4900         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4901         nodes[1].node.force_close_channel(&chan.2).unwrap();
4902         check_closed_broadcast!(nodes[1], true);
4903         check_added_monitors!(nodes[1], 1);
4904         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4905         assert_eq!(node_txn.len(), 1);
4906         check_spends!(node_txn[0], chan.3);
4907         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
4908
4909         mine_transaction(&nodes[1], &node_txn[0]);
4910         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4911
4912         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4913         assert_eq!(spend_txn.len(), 1);
4914         assert_eq!(spend_txn[0].input.len(), 1);
4915         check_spends!(spend_txn[0], node_txn[0]);
4916         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4917 }
4918
4919 #[test]
4920 fn test_claim_on_remote_sizeable_push_msat() {
4921         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4922         // to_remote output is encumbered by a P2WPKH
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[0].node.force_close_channel(&chan.2).unwrap();
4930         check_closed_broadcast!(nodes[0], true);
4931         check_added_monitors!(nodes[0], 1);
4932
4933         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4934         assert_eq!(node_txn.len(), 1);
4935         check_spends!(node_txn[0], chan.3);
4936         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
4937
4938         mine_transaction(&nodes[1], &node_txn[0]);
4939         check_closed_broadcast!(nodes[1], true);
4940         check_added_monitors!(nodes[1], 1);
4941         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4942
4943         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4944         assert_eq!(spend_txn.len(), 1);
4945         check_spends!(spend_txn[0], node_txn[0]);
4946 }
4947
4948 #[test]
4949 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4950         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4951         // to_remote output is encumbered by a P2WPKH
4952
4953         let chanmon_cfgs = create_chanmon_cfgs(2);
4954         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4955         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4956         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4957
4958         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4959         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4960         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4961         assert_eq!(revoked_local_txn[0].input.len(), 1);
4962         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4963
4964         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4965         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4966         check_closed_broadcast!(nodes[1], true);
4967         check_added_monitors!(nodes[1], 1);
4968
4969         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4970         mine_transaction(&nodes[1], &node_txn[0]);
4971         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4972
4973         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4974         assert_eq!(spend_txn.len(), 3);
4975         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4976         check_spends!(spend_txn[1], node_txn[0]);
4977         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4978 }
4979
4980 #[test]
4981 fn test_static_spendable_outputs_preimage_tx() {
4982         let chanmon_cfgs = create_chanmon_cfgs(2);
4983         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4985         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4986
4987         // Create some initial channels
4988         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4989
4990         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4991
4992         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4993         assert_eq!(commitment_tx[0].input.len(), 1);
4994         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4995
4996         // Settle A's commitment tx on B's chain
4997         assert!(nodes[1].node.claim_funds(payment_preimage));
4998         check_added_monitors!(nodes[1], 1);
4999         mine_transaction(&nodes[1], &commitment_tx[0]);
5000         check_added_monitors!(nodes[1], 1);
5001         let events = nodes[1].node.get_and_clear_pending_msg_events();
5002         match events[0] {
5003                 MessageSendEvent::UpdateHTLCs { .. } => {},
5004                 _ => panic!("Unexpected event"),
5005         }
5006         match events[1] {
5007                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5008                 _ => panic!("Unexepected event"),
5009         }
5010
5011         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5012         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
5013         assert_eq!(node_txn.len(), 3);
5014         check_spends!(node_txn[0], commitment_tx[0]);
5015         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5016         check_spends!(node_txn[1], chan_1.3);
5017         check_spends!(node_txn[2], node_txn[1]);
5018
5019         mine_transaction(&nodes[1], &node_txn[0]);
5020         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5021
5022         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5023         assert_eq!(spend_txn.len(), 1);
5024         check_spends!(spend_txn[0], node_txn[0]);
5025 }
5026
5027 #[test]
5028 fn test_static_spendable_outputs_timeout_tx() {
5029         let chanmon_cfgs = create_chanmon_cfgs(2);
5030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5032         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5033
5034         // Create some initial channels
5035         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5036
5037         // Rebalance the network a bit by relaying one payment through all the channels ...
5038         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5039
5040         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5041
5042         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5043         assert_eq!(commitment_tx[0].input.len(), 1);
5044         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5045
5046         // Settle A's commitment tx on B' chain
5047         mine_transaction(&nodes[1], &commitment_tx[0]);
5048         check_added_monitors!(nodes[1], 1);
5049         let events = nodes[1].node.get_and_clear_pending_msg_events();
5050         match events[0] {
5051                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5052                 _ => panic!("Unexpected event"),
5053         }
5054         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5055
5056         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5057         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5058         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5059         check_spends!(node_txn[0], chan_1.3.clone());
5060         check_spends!(node_txn[1],  commitment_tx[0].clone());
5061         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5062
5063         mine_transaction(&nodes[1], &node_txn[1]);
5064         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5065         expect_payment_failed!(nodes[1], our_payment_hash, true);
5066
5067         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5068         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5069         check_spends!(spend_txn[0], commitment_tx[0]);
5070         check_spends!(spend_txn[1], node_txn[1]);
5071         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5072 }
5073
5074 #[test]
5075 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5076         let chanmon_cfgs = create_chanmon_cfgs(2);
5077         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5078         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5079         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5080
5081         // Create some initial channels
5082         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5083
5084         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5085         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5086         assert_eq!(revoked_local_txn[0].input.len(), 1);
5087         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5088
5089         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5090
5091         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5092         check_closed_broadcast!(nodes[1], true);
5093         check_added_monitors!(nodes[1], 1);
5094
5095         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5096         assert_eq!(node_txn.len(), 2);
5097         assert_eq!(node_txn[0].input.len(), 2);
5098         check_spends!(node_txn[0], revoked_local_txn[0]);
5099
5100         mine_transaction(&nodes[1], &node_txn[0]);
5101         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5102
5103         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5104         assert_eq!(spend_txn.len(), 1);
5105         check_spends!(spend_txn[0], node_txn[0]);
5106 }
5107
5108 #[test]
5109 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5110         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5111         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5112         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5113         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5114         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5115
5116         // Create some initial channels
5117         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5118
5119         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5120         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5121         assert_eq!(revoked_local_txn[0].input.len(), 1);
5122         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5123
5124         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5125
5126         // A will generate HTLC-Timeout from revoked commitment tx
5127         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5128         check_closed_broadcast!(nodes[0], true);
5129         check_added_monitors!(nodes[0], 1);
5130         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5131
5132         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5133         assert_eq!(revoked_htlc_txn.len(), 2);
5134         check_spends!(revoked_htlc_txn[0], chan_1.3);
5135         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5136         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5137         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5138         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5139
5140         // B will generate justice tx from A's revoked commitment/HTLC tx
5141         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5142         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5143         check_closed_broadcast!(nodes[1], true);
5144         check_added_monitors!(nodes[1], 1);
5145
5146         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5147         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5148         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5149         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5150         // transactions next...
5151         assert_eq!(node_txn[0].input.len(), 3);
5152         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5153
5154         assert_eq!(node_txn[1].input.len(), 2);
5155         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5156         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5157                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5158         } else {
5159                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5160                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5161         }
5162
5163         assert_eq!(node_txn[2].input.len(), 1);
5164         check_spends!(node_txn[2], chan_1.3);
5165
5166         mine_transaction(&nodes[1], &node_txn[1]);
5167         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5168
5169         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5170         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5171         assert_eq!(spend_txn.len(), 1);
5172         assert_eq!(spend_txn[0].input.len(), 1);
5173         check_spends!(spend_txn[0], node_txn[1]);
5174 }
5175
5176 #[test]
5177 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5178         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5179         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5180         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5181         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5182         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5183
5184         // Create some initial channels
5185         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5186
5187         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5188         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5189         assert_eq!(revoked_local_txn[0].input.len(), 1);
5190         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5191
5192         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5193         assert_eq!(revoked_local_txn[0].output.len(), 2);
5194
5195         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5196
5197         // B will generate HTLC-Success from revoked commitment tx
5198         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5199         check_closed_broadcast!(nodes[1], true);
5200         check_added_monitors!(nodes[1], 1);
5201         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5202
5203         assert_eq!(revoked_htlc_txn.len(), 2);
5204         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5205         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5206         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5207
5208         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5209         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5210         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5211
5212         // A will generate justice tx from B's revoked commitment/HTLC tx
5213         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5214         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5215         check_closed_broadcast!(nodes[0], true);
5216         check_added_monitors!(nodes[0], 1);
5217
5218         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5219         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5220
5221         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5222         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5223         // transactions next...
5224         assert_eq!(node_txn[0].input.len(), 2);
5225         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5226         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5227                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5228         } else {
5229                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5230                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5231         }
5232
5233         assert_eq!(node_txn[1].input.len(), 1);
5234         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5235
5236         check_spends!(node_txn[2], chan_1.3);
5237
5238         mine_transaction(&nodes[0], &node_txn[1]);
5239         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5240
5241         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5242         // didn't try to generate any new transactions.
5243
5244         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5245         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5246         assert_eq!(spend_txn.len(), 3);
5247         assert_eq!(spend_txn[0].input.len(), 1);
5248         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5249         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5250         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5251         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5252 }
5253
5254 #[test]
5255 fn test_onchain_to_onchain_claim() {
5256         // Test that in case of channel closure, we detect the state of output and claim HTLC
5257         // on downstream peer's remote commitment tx.
5258         // First, have C claim an HTLC against its own latest commitment transaction.
5259         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5260         // channel.
5261         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5262         // gets broadcast.
5263
5264         let chanmon_cfgs = create_chanmon_cfgs(3);
5265         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5266         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5267         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5268
5269         // Create some initial channels
5270         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5271         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5272
5273         // Ensure all nodes are at the same height
5274         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5275         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5276         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5277         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5278
5279         // Rebalance the network a bit by relaying one payment through all the channels ...
5280         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5281         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5282
5283         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5284         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5285         check_spends!(commitment_tx[0], chan_2.3);
5286         nodes[2].node.claim_funds(payment_preimage);
5287         check_added_monitors!(nodes[2], 1);
5288         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5289         assert!(updates.update_add_htlcs.is_empty());
5290         assert!(updates.update_fail_htlcs.is_empty());
5291         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5292         assert!(updates.update_fail_malformed_htlcs.is_empty());
5293
5294         mine_transaction(&nodes[2], &commitment_tx[0]);
5295         check_closed_broadcast!(nodes[2], true);
5296         check_added_monitors!(nodes[2], 1);
5297
5298         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5299         assert_eq!(c_txn.len(), 3);
5300         assert_eq!(c_txn[0], c_txn[2]);
5301         assert_eq!(commitment_tx[0], c_txn[1]);
5302         check_spends!(c_txn[1], chan_2.3);
5303         check_spends!(c_txn[2], c_txn[1]);
5304         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5305         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5306         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5307         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5308
5309         // 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
5310         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5311         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5312         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5313         {
5314                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5315                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5316                 assert_eq!(b_txn.len(), 2);
5317                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5318                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5319                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5320                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5321                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5322                 b_txn.clear();
5323         }
5324         check_added_monitors!(nodes[1], 1);
5325         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5326         assert_eq!(msg_events.len(), 3);
5327         check_added_monitors!(nodes[1], 1);
5328         match msg_events[0] {
5329                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5330                 _ => panic!("Unexpected event"),
5331         }
5332         match msg_events[1] {
5333                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5334                 _ => panic!("Unexpected event"),
5335         }
5336         match msg_events[2] {
5337                 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, .. } } => {
5338                         assert!(update_add_htlcs.is_empty());
5339                         assert!(update_fail_htlcs.is_empty());
5340                         assert_eq!(update_fulfill_htlcs.len(), 1);
5341                         assert!(update_fail_malformed_htlcs.is_empty());
5342                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5343                 },
5344                 _ => panic!("Unexpected event"),
5345         };
5346         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5347         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5348         mine_transaction(&nodes[1], &commitment_tx[0]);
5349         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5350         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5351         assert_eq!(b_txn.len(), 4);
5352         check_spends!(b_txn[2], chan_1.3);
5353         check_spends!(b_txn[3], b_txn[2]);
5354         let (htlc_success_claim, htlc_timeout_bumped) =
5355                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5356                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5357         check_spends!(htlc_success_claim, commitment_tx[0]);
5358         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5359         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5360         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5361         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5362         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5363
5364         check_closed_broadcast!(nodes[1], true);
5365         check_added_monitors!(nodes[1], 1);
5366 }
5367
5368 #[test]
5369 fn test_duplicate_payment_hash_one_failure_one_success() {
5370         // Topology : A --> B --> C --> D
5371         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5372         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5373         // we forward one of the payments onwards to D.
5374         let chanmon_cfgs = create_chanmon_cfgs(4);
5375         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5376         // When this test was written, the default base fee floated based on the HTLC count.
5377         // It is now fixed, so we simply set the fee to the expected value here.
5378         let mut config = test_default_channel_config();
5379         config.channel_options.forwarding_fee_base_msat = 196;
5380         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5381                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5382         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5383
5384         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5385         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5386         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5387
5388         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5389         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5390         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5391         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5392         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5393
5394         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5395
5396         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5397         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5398         // script push size limit so that the below script length checks match
5399         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5400         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5401                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5402         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5403
5404         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5405         assert_eq!(commitment_txn[0].input.len(), 1);
5406         check_spends!(commitment_txn[0], chan_2.3);
5407
5408         mine_transaction(&nodes[1], &commitment_txn[0]);
5409         check_closed_broadcast!(nodes[1], true);
5410         check_added_monitors!(nodes[1], 1);
5411         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5412
5413         let htlc_timeout_tx;
5414         { // Extract one of the two HTLC-Timeout transaction
5415                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5416                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5417                 assert_eq!(node_txn.len(), 4);
5418                 check_spends!(node_txn[0], chan_2.3);
5419
5420                 check_spends!(node_txn[1], commitment_txn[0]);
5421                 assert_eq!(node_txn[1].input.len(), 1);
5422                 check_spends!(node_txn[2], commitment_txn[0]);
5423                 assert_eq!(node_txn[2].input.len(), 1);
5424                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5425                 check_spends!(node_txn[3], commitment_txn[0]);
5426                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5427
5428                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5429                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5430                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5431                 htlc_timeout_tx = node_txn[1].clone();
5432         }
5433
5434         nodes[2].node.claim_funds(our_payment_preimage);
5435         mine_transaction(&nodes[2], &commitment_txn[0]);
5436         check_added_monitors!(nodes[2], 2);
5437         let events = nodes[2].node.get_and_clear_pending_msg_events();
5438         match events[0] {
5439                 MessageSendEvent::UpdateHTLCs { .. } => {},
5440                 _ => panic!("Unexpected event"),
5441         }
5442         match events[1] {
5443                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5444                 _ => panic!("Unexepected event"),
5445         }
5446         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5447         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)
5448         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5449         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5450         assert_eq!(htlc_success_txn[0].input.len(), 1);
5451         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5452         assert_eq!(htlc_success_txn[1].input.len(), 1);
5453         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5454         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5455         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5456         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5457         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5458         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5459
5460         mine_transaction(&nodes[1], &htlc_timeout_tx);
5461         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5462         expect_pending_htlcs_forwardable!(nodes[1]);
5463         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5464         assert!(htlc_updates.update_add_htlcs.is_empty());
5465         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5466         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5467         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5468         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5469         check_added_monitors!(nodes[1], 1);
5470
5471         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5472         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5473         {
5474                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5475                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5476         }
5477         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5478
5479         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5480         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5481         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5482         assert!(updates.update_add_htlcs.is_empty());
5483         assert!(updates.update_fail_htlcs.is_empty());
5484         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5485         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5486         assert!(updates.update_fail_malformed_htlcs.is_empty());
5487         check_added_monitors!(nodes[1], 1);
5488
5489         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5490         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5491
5492         let events = nodes[0].node.get_and_clear_pending_events();
5493         match events[0] {
5494                 Event::PaymentSent { ref payment_preimage } => {
5495                         assert_eq!(*payment_preimage, our_payment_preimage);
5496                 }
5497                 _ => panic!("Unexpected event"),
5498         }
5499 }
5500
5501 #[test]
5502 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5503         let chanmon_cfgs = create_chanmon_cfgs(2);
5504         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5505         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5506         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5507
5508         // Create some initial channels
5509         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5510
5511         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5512         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5513         assert_eq!(local_txn.len(), 1);
5514         assert_eq!(local_txn[0].input.len(), 1);
5515         check_spends!(local_txn[0], chan_1.3);
5516
5517         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5518         nodes[1].node.claim_funds(payment_preimage);
5519         check_added_monitors!(nodes[1], 1);
5520         mine_transaction(&nodes[1], &local_txn[0]);
5521         check_added_monitors!(nodes[1], 1);
5522         let events = nodes[1].node.get_and_clear_pending_msg_events();
5523         match events[0] {
5524                 MessageSendEvent::UpdateHTLCs { .. } => {},
5525                 _ => panic!("Unexpected event"),
5526         }
5527         match events[1] {
5528                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5529                 _ => panic!("Unexepected event"),
5530         }
5531         let node_tx = {
5532                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5533                 assert_eq!(node_txn.len(), 3);
5534                 assert_eq!(node_txn[0], node_txn[2]);
5535                 assert_eq!(node_txn[1], local_txn[0]);
5536                 assert_eq!(node_txn[0].input.len(), 1);
5537                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5538                 check_spends!(node_txn[0], local_txn[0]);
5539                 node_txn[0].clone()
5540         };
5541
5542         mine_transaction(&nodes[1], &node_tx);
5543         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5544
5545         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5546         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5547         assert_eq!(spend_txn.len(), 1);
5548         assert_eq!(spend_txn[0].input.len(), 1);
5549         check_spends!(spend_txn[0], node_tx);
5550         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5551 }
5552
5553 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5554         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5555         // unrevoked commitment transaction.
5556         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5557         // a remote RAA before they could be failed backwards (and combinations thereof).
5558         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5559         // use the same payment hashes.
5560         // Thus, we use a six-node network:
5561         //
5562         // A \         / E
5563         //    - C - D -
5564         // B /         \ F
5565         // And test where C fails back to A/B when D announces its latest commitment transaction
5566         let chanmon_cfgs = create_chanmon_cfgs(6);
5567         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5568         // When this test was written, the default base fee floated based on the HTLC count.
5569         // It is now fixed, so we simply set the fee to the expected value here.
5570         let mut config = test_default_channel_config();
5571         config.channel_options.forwarding_fee_base_msat = 196;
5572         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5573                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5574         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5575         let logger = test_utils::TestLogger::new();
5576
5577         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5578         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5579         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5580         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5581         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5582
5583         // Rebalance and check output sanity...
5584         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5585         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5586         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5587
5588         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5589         // 0th HTLC:
5590         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
5591         // 1st HTLC:
5592         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
5593         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5594         let our_node_id = &nodes[1].node.get_our_node_id();
5595         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();
5596         // 2nd HTLC:
5597         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
5598         // 3rd HTLC:
5599         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
5600         // 4th HTLC:
5601         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5602         // 5th HTLC:
5603         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5604         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();
5605         // 6th HTLC:
5606         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());
5607         // 7th HTLC:
5608         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());
5609
5610         // 8th HTLC:
5611         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5612         // 9th HTLC:
5613         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();
5614         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
5615
5616         // 10th HTLC:
5617         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
5618         // 11th HTLC:
5619         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();
5620         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());
5621
5622         // Double-check that six of the new HTLC were added
5623         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5624         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5625         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5626         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5627
5628         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5629         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5630         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5631         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5632         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5633         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5634         check_added_monitors!(nodes[4], 0);
5635         expect_pending_htlcs_forwardable!(nodes[4]);
5636         check_added_monitors!(nodes[4], 1);
5637
5638         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5639         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5640         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5641         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5642         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5643         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5644
5645         // Fail 3rd below-dust and 7th above-dust HTLCs
5646         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5647         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5648         check_added_monitors!(nodes[5], 0);
5649         expect_pending_htlcs_forwardable!(nodes[5]);
5650         check_added_monitors!(nodes[5], 1);
5651
5652         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5653         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5654         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5655         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5656
5657         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5658
5659         expect_pending_htlcs_forwardable!(nodes[3]);
5660         check_added_monitors!(nodes[3], 1);
5661         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5662         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5663         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5664         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5665         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5666         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5667         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5668         if deliver_last_raa {
5669                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5670         } else {
5671                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5672         }
5673
5674         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5675         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5676         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5677         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5678         //
5679         // We now broadcast the latest commitment transaction, which *should* result in failures for
5680         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5681         // the non-broadcast above-dust HTLCs.
5682         //
5683         // Alternatively, we may broadcast the previous commitment transaction, which should only
5684         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5685         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5686
5687         if announce_latest {
5688                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5689         } else {
5690                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5691         }
5692         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5693         check_closed_broadcast!(nodes[2], true);
5694         expect_pending_htlcs_forwardable!(nodes[2]);
5695         check_added_monitors!(nodes[2], 3);
5696
5697         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5698         assert_eq!(cs_msgs.len(), 2);
5699         let mut a_done = false;
5700         for msg in cs_msgs {
5701                 match msg {
5702                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5703                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5704                                 // should be failed-backwards here.
5705                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5706                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5707                                         for htlc in &updates.update_fail_htlcs {
5708                                                 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 });
5709                                         }
5710                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5711                                         assert!(!a_done);
5712                                         a_done = true;
5713                                         &nodes[0]
5714                                 } else {
5715                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5716                                         for htlc in &updates.update_fail_htlcs {
5717                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5718                                         }
5719                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5720                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5721                                         &nodes[1]
5722                                 };
5723                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5724                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5725                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5726                                 if announce_latest {
5727                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5728                                         if *node_id == nodes[0].node.get_our_node_id() {
5729                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5730                                         }
5731                                 }
5732                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5733                         },
5734                         _ => panic!("Unexpected event"),
5735                 }
5736         }
5737
5738         let as_events = nodes[0].node.get_and_clear_pending_events();
5739         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5740         let mut as_failds = HashSet::new();
5741         for event in as_events.iter() {
5742                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5743                         assert!(as_failds.insert(*payment_hash));
5744                         if *payment_hash != payment_hash_2 {
5745                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5746                         } else {
5747                                 assert!(!rejected_by_dest);
5748                         }
5749                 } else { panic!("Unexpected event"); }
5750         }
5751         assert!(as_failds.contains(&payment_hash_1));
5752         assert!(as_failds.contains(&payment_hash_2));
5753         if announce_latest {
5754                 assert!(as_failds.contains(&payment_hash_3));
5755                 assert!(as_failds.contains(&payment_hash_5));
5756         }
5757         assert!(as_failds.contains(&payment_hash_6));
5758
5759         let bs_events = nodes[1].node.get_and_clear_pending_events();
5760         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5761         let mut bs_failds = HashSet::new();
5762         for event in bs_events.iter() {
5763                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5764                         assert!(bs_failds.insert(*payment_hash));
5765                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5766                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5767                         } else {
5768                                 assert!(!rejected_by_dest);
5769                         }
5770                 } else { panic!("Unexpected event"); }
5771         }
5772         assert!(bs_failds.contains(&payment_hash_1));
5773         assert!(bs_failds.contains(&payment_hash_2));
5774         if announce_latest {
5775                 assert!(bs_failds.contains(&payment_hash_4));
5776         }
5777         assert!(bs_failds.contains(&payment_hash_5));
5778
5779         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5780         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5781         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5782         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5783         // PaymentFailureNetworkUpdates.
5784         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5785         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5786         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5787         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5788         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5789                 match event {
5790                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5791                         _ => panic!("Unexpected event"),
5792                 }
5793         }
5794 }
5795
5796 #[test]
5797 fn test_fail_backwards_latest_remote_announce_a() {
5798         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5799 }
5800
5801 #[test]
5802 fn test_fail_backwards_latest_remote_announce_b() {
5803         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5804 }
5805
5806 #[test]
5807 fn test_fail_backwards_previous_remote_announce() {
5808         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5809         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5810         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5811 }
5812
5813 #[test]
5814 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5815         let chanmon_cfgs = create_chanmon_cfgs(2);
5816         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5817         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5818         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5819
5820         // Create some initial channels
5821         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5822
5823         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5824         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5825         assert_eq!(local_txn[0].input.len(), 1);
5826         check_spends!(local_txn[0], chan_1.3);
5827
5828         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5829         mine_transaction(&nodes[0], &local_txn[0]);
5830         check_closed_broadcast!(nodes[0], true);
5831         check_added_monitors!(nodes[0], 1);
5832         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5833
5834         let htlc_timeout = {
5835                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5836                 assert_eq!(node_txn.len(), 2);
5837                 check_spends!(node_txn[0], chan_1.3);
5838                 assert_eq!(node_txn[1].input.len(), 1);
5839                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5840                 check_spends!(node_txn[1], local_txn[0]);
5841                 node_txn[1].clone()
5842         };
5843
5844         mine_transaction(&nodes[0], &htlc_timeout);
5845         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5846         expect_payment_failed!(nodes[0], our_payment_hash, true);
5847
5848         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5849         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5850         assert_eq!(spend_txn.len(), 3);
5851         check_spends!(spend_txn[0], local_txn[0]);
5852         assert_eq!(spend_txn[1].input.len(), 1);
5853         check_spends!(spend_txn[1], htlc_timeout);
5854         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5855         assert_eq!(spend_txn[2].input.len(), 2);
5856         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5857         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5858                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5859 }
5860
5861 #[test]
5862 fn test_key_derivation_params() {
5863         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5864         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5865         // let us re-derive the channel key set to then derive a delayed_payment_key.
5866
5867         let chanmon_cfgs = create_chanmon_cfgs(3);
5868
5869         // We manually create the node configuration to backup the seed.
5870         let seed = [42; 32];
5871         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5872         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);
5873         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 };
5874         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5875         node_cfgs.remove(0);
5876         node_cfgs.insert(0, node);
5877
5878         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5879         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5880
5881         // Create some initial channels
5882         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5883         // for node 0
5884         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5885         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5886         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5887
5888         // Ensure all nodes are at the same height
5889         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5890         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5891         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5892         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5893
5894         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5895         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5896         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5897         assert_eq!(local_txn_1[0].input.len(), 1);
5898         check_spends!(local_txn_1[0], chan_1.3);
5899
5900         // We check funding pubkey are unique
5901         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]));
5902         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]));
5903         if from_0_funding_key_0 == from_1_funding_key_0
5904             || from_0_funding_key_0 == from_1_funding_key_1
5905             || from_0_funding_key_1 == from_1_funding_key_0
5906             || from_0_funding_key_1 == from_1_funding_key_1 {
5907                 panic!("Funding pubkeys aren't unique");
5908         }
5909
5910         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5911         mine_transaction(&nodes[0], &local_txn_1[0]);
5912         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5913         check_closed_broadcast!(nodes[0], true);
5914         check_added_monitors!(nodes[0], 1);
5915
5916         let htlc_timeout = {
5917                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5918                 assert_eq!(node_txn[1].input.len(), 1);
5919                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5920                 check_spends!(node_txn[1], local_txn_1[0]);
5921                 node_txn[1].clone()
5922         };
5923
5924         mine_transaction(&nodes[0], &htlc_timeout);
5925         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5926         expect_payment_failed!(nodes[0], our_payment_hash, true);
5927
5928         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5929         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5930         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5931         assert_eq!(spend_txn.len(), 3);
5932         check_spends!(spend_txn[0], local_txn_1[0]);
5933         assert_eq!(spend_txn[1].input.len(), 1);
5934         check_spends!(spend_txn[1], htlc_timeout);
5935         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5936         assert_eq!(spend_txn[2].input.len(), 2);
5937         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5938         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5939                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5940 }
5941
5942 #[test]
5943 fn test_static_output_closing_tx() {
5944         let chanmon_cfgs = create_chanmon_cfgs(2);
5945         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5946         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5947         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5948
5949         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5950
5951         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5952         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5953
5954         mine_transaction(&nodes[0], &closing_tx);
5955         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5956
5957         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5958         assert_eq!(spend_txn.len(), 1);
5959         check_spends!(spend_txn[0], closing_tx);
5960
5961         mine_transaction(&nodes[1], &closing_tx);
5962         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5963
5964         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5965         assert_eq!(spend_txn.len(), 1);
5966         check_spends!(spend_txn[0], closing_tx);
5967 }
5968
5969 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5970         let chanmon_cfgs = create_chanmon_cfgs(2);
5971         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5972         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5973         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5974         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5975
5976         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5977
5978         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5979         // present in B's local commitment transaction, but none of A's commitment transactions.
5980         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5981         check_added_monitors!(nodes[1], 1);
5982
5983         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5984         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5985         let events = nodes[0].node.get_and_clear_pending_events();
5986         assert_eq!(events.len(), 1);
5987         match events[0] {
5988                 Event::PaymentSent { payment_preimage } => {
5989                         assert_eq!(payment_preimage, our_payment_preimage);
5990                 },
5991                 _ => panic!("Unexpected event"),
5992         }
5993
5994         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5995         check_added_monitors!(nodes[0], 1);
5996         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5997         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5998         check_added_monitors!(nodes[1], 1);
5999
6000         let starting_block = nodes[1].best_block_info();
6001         let mut block = Block {
6002                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6003                 txdata: vec![],
6004         };
6005         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
6006                 connect_block(&nodes[1], &block);
6007                 block.header.prev_blockhash = block.block_hash();
6008         }
6009         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
6010         check_closed_broadcast!(nodes[1], true);
6011         check_added_monitors!(nodes[1], 1);
6012 }
6013
6014 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
6015         let chanmon_cfgs = create_chanmon_cfgs(2);
6016         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6017         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6018         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6019         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6020         let logger = test_utils::TestLogger::new();
6021
6022         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6023         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6024         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();
6025         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6026         check_added_monitors!(nodes[0], 1);
6027
6028         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6029
6030         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6031         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6032         // to "time out" the HTLC.
6033
6034         let starting_block = nodes[1].best_block_info();
6035         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6036
6037         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6038                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6039                 header.prev_blockhash = header.block_hash();
6040         }
6041         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6042         check_closed_broadcast!(nodes[0], true);
6043         check_added_monitors!(nodes[0], 1);
6044 }
6045
6046 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6047         let chanmon_cfgs = create_chanmon_cfgs(3);
6048         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6049         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6050         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6051         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6052
6053         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6054         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6055         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6056         // actually revoked.
6057         let htlc_value = if use_dust { 50000 } else { 3000000 };
6058         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6059         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6060         expect_pending_htlcs_forwardable!(nodes[1]);
6061         check_added_monitors!(nodes[1], 1);
6062
6063         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6064         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6065         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6066         check_added_monitors!(nodes[0], 1);
6067         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6068         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6069         check_added_monitors!(nodes[1], 1);
6070         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6071         check_added_monitors!(nodes[1], 1);
6072         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6073
6074         if check_revoke_no_close {
6075                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6076                 check_added_monitors!(nodes[0], 1);
6077         }
6078
6079         let starting_block = nodes[1].best_block_info();
6080         let mut block = Block {
6081                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6082                 txdata: vec![],
6083         };
6084         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6085                 connect_block(&nodes[0], &block);
6086                 block.header.prev_blockhash = block.block_hash();
6087         }
6088         if !check_revoke_no_close {
6089                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6090                 check_closed_broadcast!(nodes[0], true);
6091                 check_added_monitors!(nodes[0], 1);
6092         } else {
6093                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6094         }
6095 }
6096
6097 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6098 // There are only a few cases to test here:
6099 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6100 //    broadcastable commitment transactions result in channel closure,
6101 //  * its included in an unrevoked-but-previous remote commitment transaction,
6102 //  * its included in the latest remote or local commitment transactions.
6103 // We test each of the three possible commitment transactions individually and use both dust and
6104 // non-dust HTLCs.
6105 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6106 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6107 // tested for at least one of the cases in other tests.
6108 #[test]
6109 fn htlc_claim_single_commitment_only_a() {
6110         do_htlc_claim_local_commitment_only(true);
6111         do_htlc_claim_local_commitment_only(false);
6112
6113         do_htlc_claim_current_remote_commitment_only(true);
6114         do_htlc_claim_current_remote_commitment_only(false);
6115 }
6116
6117 #[test]
6118 fn htlc_claim_single_commitment_only_b() {
6119         do_htlc_claim_previous_remote_commitment_only(true, false);
6120         do_htlc_claim_previous_remote_commitment_only(false, false);
6121         do_htlc_claim_previous_remote_commitment_only(true, true);
6122         do_htlc_claim_previous_remote_commitment_only(false, true);
6123 }
6124
6125 #[test]
6126 #[should_panic]
6127 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6128         let chanmon_cfgs = create_chanmon_cfgs(2);
6129         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6131         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6132         //Force duplicate channel ids
6133         for node in nodes.iter() {
6134                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6135         }
6136
6137         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6138         let channel_value_satoshis=10000;
6139         let push_msat=10001;
6140         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6141         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6142         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6143
6144         //Create a second channel with a channel_id collision
6145         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6146 }
6147
6148 #[test]
6149 fn bolt2_open_channel_sending_node_checks_part2() {
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
6155         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6156         let channel_value_satoshis=2^24;
6157         let push_msat=10001;
6158         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6159
6160         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6161         let channel_value_satoshis=10000;
6162         // Test when push_msat is equal to 1000 * funding_satoshis.
6163         let push_msat=1000*channel_value_satoshis+1;
6164         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6165
6166         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6167         let channel_value_satoshis=10000;
6168         let push_msat=10001;
6169         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
6170         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6171         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6172
6173         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6174         // 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
6175         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6176
6177         // 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.
6178         assert!(BREAKDOWN_TIMEOUT>0);
6179         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6180
6181         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6182         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6183         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6184
6185         // 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.
6186         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6187         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6188         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6189         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6190         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6191 }
6192
6193 #[test]
6194 fn bolt2_open_channel_sane_dust_limit() {
6195         let chanmon_cfgs = create_chanmon_cfgs(2);
6196         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6197         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6198         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6199
6200         let channel_value_satoshis=1000000;
6201         let push_msat=10001;
6202         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6203         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6204         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6205         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6206
6207         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6208         let events = nodes[1].node.get_and_clear_pending_msg_events();
6209         let err_msg = match events[0] {
6210                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6211                         msg.clone()
6212                 },
6213                 _ => panic!("Unexpected event"),
6214         };
6215         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6216 }
6217
6218 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6219 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6220 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6221 // is no longer affordable once it's freed.
6222 #[test]
6223 fn test_fail_holding_cell_htlc_upon_free() {
6224         let chanmon_cfgs = create_chanmon_cfgs(2);
6225         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6227         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6228         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6229         let logger = test_utils::TestLogger::new();
6230
6231         // First nodes[0] generates an update_fee, setting the channel's
6232         // pending_update_fee.
6233         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6234         check_added_monitors!(nodes[0], 1);
6235
6236         let events = nodes[0].node.get_and_clear_pending_msg_events();
6237         assert_eq!(events.len(), 1);
6238         let (update_msg, commitment_signed) = match events[0] {
6239                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6240                         (update_fee.as_ref(), commitment_signed)
6241                 },
6242                 _ => panic!("Unexpected event"),
6243         };
6244
6245         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6246
6247         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6248         let channel_reserve = chan_stat.channel_reserve_msat;
6249         let feerate = get_feerate!(nodes[0], chan.2);
6250
6251         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6252         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6253         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6254         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6255         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6256
6257         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6258         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6259         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6260         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6261
6262         // Flush the pending fee update.
6263         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6264         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6265         check_added_monitors!(nodes[1], 1);
6266         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6267         check_added_monitors!(nodes[0], 1);
6268
6269         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6270         // HTLC, but now that the fee has been raised the payment will now fail, causing
6271         // us to surface its failure to the user.
6272         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6273         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6274         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);
6275         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 {}",
6276                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6277         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6278
6279         // Check that the payment failed to be sent out.
6280         let events = nodes[0].node.get_and_clear_pending_events();
6281         assert_eq!(events.len(), 1);
6282         match &events[0] {
6283                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6284                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6285                         assert_eq!(*rejected_by_dest, false);
6286                         assert_eq!(*error_code, None);
6287                         assert_eq!(*error_data, None);
6288                 },
6289                 _ => panic!("Unexpected event"),
6290         }
6291 }
6292
6293 // Test that if multiple HTLCs are released from the holding cell and one is
6294 // valid but the other is no longer valid upon release, the valid HTLC can be
6295 // successfully completed while the other one fails as expected.
6296 #[test]
6297 fn test_free_and_fail_holding_cell_htlcs() {
6298         let chanmon_cfgs = create_chanmon_cfgs(2);
6299         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6300         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6301         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6302         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6303         let logger = test_utils::TestLogger::new();
6304
6305         // First nodes[0] generates an update_fee, setting the channel's
6306         // pending_update_fee.
6307         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6308         check_added_monitors!(nodes[0], 1);
6309
6310         let events = nodes[0].node.get_and_clear_pending_msg_events();
6311         assert_eq!(events.len(), 1);
6312         let (update_msg, commitment_signed) = match events[0] {
6313                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6314                         (update_fee.as_ref(), commitment_signed)
6315                 },
6316                 _ => panic!("Unexpected event"),
6317         };
6318
6319         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6320
6321         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6322         let channel_reserve = chan_stat.channel_reserve_msat;
6323         let feerate = get_feerate!(nodes[0], chan.2);
6324
6325         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6326         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6327         let amt_1 = 20000;
6328         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6329         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6330         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6331         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();
6332         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();
6333
6334         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6335         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6336         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6337         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6338         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6339         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6340         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6341
6342         // Flush the pending fee update.
6343         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6344         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6345         check_added_monitors!(nodes[1], 1);
6346         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6347         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6348         check_added_monitors!(nodes[0], 2);
6349
6350         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6351         // but now that the fee has been raised the second payment will now fail, causing us
6352         // to surface its failure to the user. The first payment should succeed.
6353         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6354         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6355         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);
6356         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 {}",
6357                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6358         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6359
6360         // Check that the second payment failed to be sent out.
6361         let events = nodes[0].node.get_and_clear_pending_events();
6362         assert_eq!(events.len(), 1);
6363         match &events[0] {
6364                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6365                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6366                         assert_eq!(*rejected_by_dest, false);
6367                         assert_eq!(*error_code, None);
6368                         assert_eq!(*error_data, None);
6369                 },
6370                 _ => panic!("Unexpected event"),
6371         }
6372
6373         // Complete the first payment and the RAA from the fee update.
6374         let (payment_event, send_raa_event) = {
6375                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6376                 assert_eq!(msgs.len(), 2);
6377                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6378         };
6379         let raa = match send_raa_event {
6380                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6381                 _ => panic!("Unexpected event"),
6382         };
6383         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6384         check_added_monitors!(nodes[1], 1);
6385         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6386         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6387         let events = nodes[1].node.get_and_clear_pending_events();
6388         assert_eq!(events.len(), 1);
6389         match events[0] {
6390                 Event::PendingHTLCsForwardable { .. } => {},
6391                 _ => panic!("Unexpected event"),
6392         }
6393         nodes[1].node.process_pending_htlc_forwards();
6394         let events = nodes[1].node.get_and_clear_pending_events();
6395         assert_eq!(events.len(), 1);
6396         match events[0] {
6397                 Event::PaymentReceived { .. } => {},
6398                 _ => panic!("Unexpected event"),
6399         }
6400         nodes[1].node.claim_funds(payment_preimage_1);
6401         check_added_monitors!(nodes[1], 1);
6402         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6403         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6404         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6405         let events = nodes[0].node.get_and_clear_pending_events();
6406         assert_eq!(events.len(), 1);
6407         match events[0] {
6408                 Event::PaymentSent { ref payment_preimage } => {
6409                         assert_eq!(*payment_preimage, payment_preimage_1);
6410                 }
6411                 _ => panic!("Unexpected event"),
6412         }
6413 }
6414
6415 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6416 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6417 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6418 // once it's freed.
6419 #[test]
6420 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6421         let chanmon_cfgs = create_chanmon_cfgs(3);
6422         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6423         // When this test was written, the default base fee floated based on the HTLC count.
6424         // It is now fixed, so we simply set the fee to the expected value here.
6425         let mut config = test_default_channel_config();
6426         config.channel_options.forwarding_fee_base_msat = 196;
6427         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6428         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6429         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6430         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6431         let logger = test_utils::TestLogger::new();
6432
6433         // First nodes[1] generates an update_fee, setting the channel's
6434         // pending_update_fee.
6435         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6436         check_added_monitors!(nodes[1], 1);
6437
6438         let events = nodes[1].node.get_and_clear_pending_msg_events();
6439         assert_eq!(events.len(), 1);
6440         let (update_msg, commitment_signed) = match events[0] {
6441                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6442                         (update_fee.as_ref(), commitment_signed)
6443                 },
6444                 _ => panic!("Unexpected event"),
6445         };
6446
6447         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6448
6449         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6450         let channel_reserve = chan_stat.channel_reserve_msat;
6451         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6452
6453         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6454         let feemsat = 239;
6455         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6456         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6457         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6458         let payment_event = {
6459                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6460                 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();
6461                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6462                 check_added_monitors!(nodes[0], 1);
6463
6464                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6465                 assert_eq!(events.len(), 1);
6466
6467                 SendEvent::from_event(events.remove(0))
6468         };
6469         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6470         check_added_monitors!(nodes[1], 0);
6471         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6472         expect_pending_htlcs_forwardable!(nodes[1]);
6473
6474         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6475         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6476
6477         // Flush the pending fee update.
6478         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6479         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6480         check_added_monitors!(nodes[2], 1);
6481         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6482         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6483         check_added_monitors!(nodes[1], 2);
6484
6485         // A final RAA message is generated to finalize the fee update.
6486         let events = nodes[1].node.get_and_clear_pending_msg_events();
6487         assert_eq!(events.len(), 1);
6488
6489         let raa_msg = match &events[0] {
6490                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6491                         msg.clone()
6492                 },
6493                 _ => panic!("Unexpected event"),
6494         };
6495
6496         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6497         check_added_monitors!(nodes[2], 1);
6498         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6499
6500         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6501         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6502         assert_eq!(process_htlc_forwards_event.len(), 1);
6503         match &process_htlc_forwards_event[0] {
6504                 &Event::PendingHTLCsForwardable { .. } => {},
6505                 _ => panic!("Unexpected event"),
6506         }
6507
6508         // In response, we call ChannelManager's process_pending_htlc_forwards
6509         nodes[1].node.process_pending_htlc_forwards();
6510         check_added_monitors!(nodes[1], 1);
6511
6512         // This causes the HTLC to be failed backwards.
6513         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6514         assert_eq!(fail_event.len(), 1);
6515         let (fail_msg, commitment_signed) = match &fail_event[0] {
6516                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6517                         assert_eq!(updates.update_add_htlcs.len(), 0);
6518                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6519                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6520                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6521                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6522                 },
6523                 _ => panic!("Unexpected event"),
6524         };
6525
6526         // Pass the failure messages back to nodes[0].
6527         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6528         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6529
6530         // Complete the HTLC failure+removal process.
6531         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6532         check_added_monitors!(nodes[0], 1);
6533         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6534         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6535         check_added_monitors!(nodes[1], 2);
6536         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6537         assert_eq!(final_raa_event.len(), 1);
6538         let raa = match &final_raa_event[0] {
6539                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6540                 _ => panic!("Unexpected event"),
6541         };
6542         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6543         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6544         expect_payment_failed!(nodes[0], our_payment_hash, false);
6545         check_added_monitors!(nodes[0], 1);
6546 }
6547
6548 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6549 // 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.
6550 //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.
6551
6552 #[test]
6553 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6554         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6555         let chanmon_cfgs = create_chanmon_cfgs(2);
6556         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6557         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6558         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6559         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6560
6561         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6562         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6563         let logger = test_utils::TestLogger::new();
6564         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();
6565         route.paths[0][0].fee_msat = 100;
6566
6567         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6568                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6569         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6570         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6571 }
6572
6573 #[test]
6574 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6575         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6576         let chanmon_cfgs = create_chanmon_cfgs(2);
6577         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6578         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6579         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6580         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6581         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6582
6583         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6584         let logger = test_utils::TestLogger::new();
6585         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();
6586         route.paths[0][0].fee_msat = 0;
6587         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6588                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6589
6590         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6591         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6592 }
6593
6594 #[test]
6595 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6596         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6597         let chanmon_cfgs = create_chanmon_cfgs(2);
6598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6600         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6601         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6602
6603         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6604         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6605         let logger = test_utils::TestLogger::new();
6606         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();
6607         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6608         check_added_monitors!(nodes[0], 1);
6609         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6610         updates.update_add_htlcs[0].amount_msat = 0;
6611
6612         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6613         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6614         check_closed_broadcast!(nodes[1], true).unwrap();
6615         check_added_monitors!(nodes[1], 1);
6616 }
6617
6618 #[test]
6619 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6620         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6621         //It is enforced when constructing a route.
6622         let chanmon_cfgs = create_chanmon_cfgs(2);
6623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6626         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6627         let logger = test_utils::TestLogger::new();
6628
6629         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6630
6631         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6632         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6633         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6634                 assert_eq!(err, &"Channel CLTV overflowed?"));
6635 }
6636
6637 #[test]
6638 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6639         //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.
6640         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6641         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6642         let chanmon_cfgs = create_chanmon_cfgs(2);
6643         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6644         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6645         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6646         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6647         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6648
6649         let logger = test_utils::TestLogger::new();
6650         for i in 0..max_accepted_htlcs {
6651                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6652                 let payment_event = {
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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6655                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6656                         check_added_monitors!(nodes[0], 1);
6657
6658                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6659                         assert_eq!(events.len(), 1);
6660                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6661                                 assert_eq!(htlcs[0].htlc_id, i);
6662                         } else {
6663                                 assert!(false);
6664                         }
6665                         SendEvent::from_event(events.remove(0))
6666                 };
6667                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6668                 check_added_monitors!(nodes[1], 0);
6669                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6670
6671                 expect_pending_htlcs_forwardable!(nodes[1]);
6672                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6673         }
6674         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
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         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6678                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6679
6680         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6681         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6682 }
6683
6684 #[test]
6685 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6686         //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.
6687         let chanmon_cfgs = create_chanmon_cfgs(2);
6688         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6690         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6691         let channel_value = 100000;
6692         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6693         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6694
6695         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6696
6697         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6698         // Manually create a route over our max in flight (which our router normally automatically
6699         // limits us to.
6700         let route = Route { paths: vec![vec![RouteHop {
6701            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6702            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6703            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6704         }]] };
6705         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6706                 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)));
6707
6708         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6709         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);
6710
6711         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6712 }
6713
6714 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6715 #[test]
6716 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6717         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6718         let chanmon_cfgs = create_chanmon_cfgs(2);
6719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6721         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6722         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6723         let htlc_minimum_msat: u64;
6724         {
6725                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6726                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6727                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6728         }
6729
6730         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6731         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6732         let logger = test_utils::TestLogger::new();
6733         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();
6734         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6735         check_added_monitors!(nodes[0], 1);
6736         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6737         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6738         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6739         assert!(nodes[1].node.list_channels().is_empty());
6740         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6741         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()));
6742         check_added_monitors!(nodes[1], 1);
6743 }
6744
6745 #[test]
6746 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6747         //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
6748         let chanmon_cfgs = create_chanmon_cfgs(2);
6749         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6750         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6751         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6752         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6753         let logger = test_utils::TestLogger::new();
6754
6755         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6756         let channel_reserve = chan_stat.channel_reserve_msat;
6757         let feerate = get_feerate!(nodes[0], chan.2);
6758         // The 2* and +1 are for the fee spike reserve.
6759         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6760
6761         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6762         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6763         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6764         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();
6765         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6766         check_added_monitors!(nodes[0], 1);
6767         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6768
6769         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6770         // at this time channel-initiatee receivers are not required to enforce that senders
6771         // respect the fee_spike_reserve.
6772         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6773         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6774
6775         assert!(nodes[1].node.list_channels().is_empty());
6776         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6777         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6778         check_added_monitors!(nodes[1], 1);
6779 }
6780
6781 #[test]
6782 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6783         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6784         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6785         let chanmon_cfgs = create_chanmon_cfgs(2);
6786         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6788         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6789         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6790         let logger = test_utils::TestLogger::new();
6791
6792         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6793         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6794
6795         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6796         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();
6797
6798         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6799         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6800         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6801         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6802
6803         let mut msg = msgs::UpdateAddHTLC {
6804                 channel_id: chan.2,
6805                 htlc_id: 0,
6806                 amount_msat: 1000,
6807                 payment_hash: our_payment_hash,
6808                 cltv_expiry: htlc_cltv,
6809                 onion_routing_packet: onion_packet.clone(),
6810         };
6811
6812         for i in 0..super::channel::OUR_MAX_HTLCS {
6813                 msg.htlc_id = i as u64;
6814                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6815         }
6816         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6817         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6818
6819         assert!(nodes[1].node.list_channels().is_empty());
6820         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6821         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6822         check_added_monitors!(nodes[1], 1);
6823 }
6824
6825 #[test]
6826 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6827         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6828         let chanmon_cfgs = create_chanmon_cfgs(2);
6829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6831         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6832         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6833         let logger = test_utils::TestLogger::new();
6834
6835         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6836         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6837         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();
6838         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6839         check_added_monitors!(nodes[0], 1);
6840         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6841         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6842         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6843
6844         assert!(nodes[1].node.list_channels().is_empty());
6845         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6846         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6847         check_added_monitors!(nodes[1], 1);
6848 }
6849
6850 #[test]
6851 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6852         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6853         let chanmon_cfgs = create_chanmon_cfgs(2);
6854         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6855         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6856         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6857         let logger = test_utils::TestLogger::new();
6858
6859         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6860         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6861         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6862         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();
6863         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6864         check_added_monitors!(nodes[0], 1);
6865         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6866         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6867         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6868
6869         assert!(nodes[1].node.list_channels().is_empty());
6870         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6871         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6872         check_added_monitors!(nodes[1], 1);
6873 }
6874
6875 #[test]
6876 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6877         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6878         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6879         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6880         let chanmon_cfgs = create_chanmon_cfgs(2);
6881         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6882         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6883         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6884         let logger = test_utils::TestLogger::new();
6885
6886         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6887         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6888         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6889         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();
6890         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6891         check_added_monitors!(nodes[0], 1);
6892         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6893         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6894
6895         //Disconnect and Reconnect
6896         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6897         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6898         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6899         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6900         assert_eq!(reestablish_1.len(), 1);
6901         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6902         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6903         assert_eq!(reestablish_2.len(), 1);
6904         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6905         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6906         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6907         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6908
6909         //Resend HTLC
6910         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6911         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6912         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6913         check_added_monitors!(nodes[1], 1);
6914         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6915
6916         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6917
6918         assert!(nodes[1].node.list_channels().is_empty());
6919         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6920         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6921         check_added_monitors!(nodes[1], 1);
6922 }
6923
6924 #[test]
6925 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6926         //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.
6927
6928         let chanmon_cfgs = create_chanmon_cfgs(2);
6929         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6930         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6931         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6932         let logger = test_utils::TestLogger::new();
6933         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6934         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6935         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6936         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();
6937         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6938
6939         check_added_monitors!(nodes[0], 1);
6940         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6941         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6942
6943         let update_msg = msgs::UpdateFulfillHTLC{
6944                 channel_id: chan.2,
6945                 htlc_id: 0,
6946                 payment_preimage: our_payment_preimage,
6947         };
6948
6949         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6950
6951         assert!(nodes[0].node.list_channels().is_empty());
6952         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6953         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()));
6954         check_added_monitors!(nodes[0], 1);
6955 }
6956
6957 #[test]
6958 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6959         //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.
6960
6961         let chanmon_cfgs = create_chanmon_cfgs(2);
6962         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6963         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6964         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6965         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6966         let logger = test_utils::TestLogger::new();
6967
6968         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6969         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6970         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();
6971         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6972         check_added_monitors!(nodes[0], 1);
6973         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6974         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6975
6976         let update_msg = msgs::UpdateFailHTLC{
6977                 channel_id: chan.2,
6978                 htlc_id: 0,
6979                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6980         };
6981
6982         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6983
6984         assert!(nodes[0].node.list_channels().is_empty());
6985         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6986         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()));
6987         check_added_monitors!(nodes[0], 1);
6988 }
6989
6990 #[test]
6991 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6992         //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.
6993
6994         let chanmon_cfgs = create_chanmon_cfgs(2);
6995         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6996         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6997         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6998         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6999         let logger = test_utils::TestLogger::new();
7000
7001         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7002         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7003         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();
7004         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7005         check_added_monitors!(nodes[0], 1);
7006         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7007         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7008         let update_msg = msgs::UpdateFailMalformedHTLC{
7009                 channel_id: chan.2,
7010                 htlc_id: 0,
7011                 sha256_of_onion: [1; 32],
7012                 failure_code: 0x8000,
7013         };
7014
7015         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7016
7017         assert!(nodes[0].node.list_channels().is_empty());
7018         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7019         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()));
7020         check_added_monitors!(nodes[0], 1);
7021 }
7022
7023 #[test]
7024 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7025         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7026
7027         let chanmon_cfgs = create_chanmon_cfgs(2);
7028         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7029         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7030         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7031         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7032
7033         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7034
7035         nodes[1].node.claim_funds(our_payment_preimage);
7036         check_added_monitors!(nodes[1], 1);
7037
7038         let events = nodes[1].node.get_and_clear_pending_msg_events();
7039         assert_eq!(events.len(), 1);
7040         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7041                 match events[0] {
7042                         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, .. } } => {
7043                                 assert!(update_add_htlcs.is_empty());
7044                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7045                                 assert!(update_fail_htlcs.is_empty());
7046                                 assert!(update_fail_malformed_htlcs.is_empty());
7047                                 assert!(update_fee.is_none());
7048                                 update_fulfill_htlcs[0].clone()
7049                         },
7050                         _ => panic!("Unexpected event"),
7051                 }
7052         };
7053
7054         update_fulfill_msg.htlc_id = 1;
7055
7056         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7057
7058         assert!(nodes[0].node.list_channels().is_empty());
7059         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7060         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7061         check_added_monitors!(nodes[0], 1);
7062 }
7063
7064 #[test]
7065 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7066         //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.
7067
7068         let chanmon_cfgs = create_chanmon_cfgs(2);
7069         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7070         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7071         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7072         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7073
7074         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7075
7076         nodes[1].node.claim_funds(our_payment_preimage);
7077         check_added_monitors!(nodes[1], 1);
7078
7079         let events = nodes[1].node.get_and_clear_pending_msg_events();
7080         assert_eq!(events.len(), 1);
7081         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7082                 match events[0] {
7083                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
7084                                 assert!(update_add_htlcs.is_empty());
7085                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7086                                 assert!(update_fail_htlcs.is_empty());
7087                                 assert!(update_fail_malformed_htlcs.is_empty());
7088                                 assert!(update_fee.is_none());
7089                                 update_fulfill_htlcs[0].clone()
7090                         },
7091                         _ => panic!("Unexpected event"),
7092                 }
7093         };
7094
7095         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7096
7097         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7098
7099         assert!(nodes[0].node.list_channels().is_empty());
7100         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7101         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7102         check_added_monitors!(nodes[0], 1);
7103 }
7104
7105 #[test]
7106 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7107         //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.
7108
7109         let chanmon_cfgs = create_chanmon_cfgs(2);
7110         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7111         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7112         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7113         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7114         let logger = test_utils::TestLogger::new();
7115
7116         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7117         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7118         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();
7119         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7120         check_added_monitors!(nodes[0], 1);
7121
7122         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7123         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7124
7125         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7126         check_added_monitors!(nodes[1], 0);
7127         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7128
7129         let events = nodes[1].node.get_and_clear_pending_msg_events();
7130
7131         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7132                 match events[0] {
7133                         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, .. } } => {
7134                                 assert!(update_add_htlcs.is_empty());
7135                                 assert!(update_fulfill_htlcs.is_empty());
7136                                 assert!(update_fail_htlcs.is_empty());
7137                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7138                                 assert!(update_fee.is_none());
7139                                 update_fail_malformed_htlcs[0].clone()
7140                         },
7141                         _ => panic!("Unexpected event"),
7142                 }
7143         };
7144         update_msg.failure_code &= !0x8000;
7145         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7146
7147         assert!(nodes[0].node.list_channels().is_empty());
7148         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7149         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7150         check_added_monitors!(nodes[0], 1);
7151 }
7152
7153 #[test]
7154 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7155         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7156         //    * 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.
7157
7158         let chanmon_cfgs = create_chanmon_cfgs(3);
7159         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7160         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7161         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7162         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7163         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7164         let logger = test_utils::TestLogger::new();
7165
7166         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7167
7168         //First hop
7169         let mut payment_event = {
7170                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7171                 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();
7172                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7173                 check_added_monitors!(nodes[0], 1);
7174                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7175                 assert_eq!(events.len(), 1);
7176                 SendEvent::from_event(events.remove(0))
7177         };
7178         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7179         check_added_monitors!(nodes[1], 0);
7180         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7181         expect_pending_htlcs_forwardable!(nodes[1]);
7182         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7183         assert_eq!(events_2.len(), 1);
7184         check_added_monitors!(nodes[1], 1);
7185         payment_event = SendEvent::from_event(events_2.remove(0));
7186         assert_eq!(payment_event.msgs.len(), 1);
7187
7188         //Second Hop
7189         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7190         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7191         check_added_monitors!(nodes[2], 0);
7192         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7193
7194         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7195         assert_eq!(events_3.len(), 1);
7196         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7197                 match events_3[0] {
7198                         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 } } => {
7199                                 assert!(update_add_htlcs.is_empty());
7200                                 assert!(update_fulfill_htlcs.is_empty());
7201                                 assert!(update_fail_htlcs.is_empty());
7202                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7203                                 assert!(update_fee.is_none());
7204                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7205                         },
7206                         _ => panic!("Unexpected event"),
7207                 }
7208         };
7209
7210         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7211
7212         check_added_monitors!(nodes[1], 0);
7213         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7214         expect_pending_htlcs_forwardable!(nodes[1]);
7215         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7216         assert_eq!(events_4.len(), 1);
7217
7218         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7219         match events_4[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, .. } } => {
7221                         assert!(update_add_htlcs.is_empty());
7222                         assert!(update_fulfill_htlcs.is_empty());
7223                         assert_eq!(update_fail_htlcs.len(), 1);
7224                         assert!(update_fail_malformed_htlcs.is_empty());
7225                         assert!(update_fee.is_none());
7226                 },
7227                 _ => panic!("Unexpected event"),
7228         };
7229
7230         check_added_monitors!(nodes[1], 1);
7231 }
7232
7233 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7234         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7235         // 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
7236         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7237
7238         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7239         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7240         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7241         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7242         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7243         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7244
7245         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7246
7247         // We route 2 dust-HTLCs between A and B
7248         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7249         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7250         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7251
7252         // Cache one local commitment tx as previous
7253         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7254
7255         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7256         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7257         check_added_monitors!(nodes[1], 0);
7258         expect_pending_htlcs_forwardable!(nodes[1]);
7259         check_added_monitors!(nodes[1], 1);
7260
7261         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7262         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7263         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7264         check_added_monitors!(nodes[0], 1);
7265
7266         // Cache one local commitment tx as lastest
7267         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7268
7269         let events = nodes[0].node.get_and_clear_pending_msg_events();
7270         match events[0] {
7271                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7272                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7273                 },
7274                 _ => panic!("Unexpected event"),
7275         }
7276         match events[1] {
7277                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7278                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7279                 },
7280                 _ => panic!("Unexpected event"),
7281         }
7282
7283         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7284         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7285         if announce_latest {
7286                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7287         } else {
7288                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7289         }
7290
7291         check_closed_broadcast!(nodes[0], true);
7292         check_added_monitors!(nodes[0], 1);
7293
7294         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7295         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7296         let events = nodes[0].node.get_and_clear_pending_events();
7297         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7298         assert_eq!(events.len(), 2);
7299         let mut first_failed = false;
7300         for event in events {
7301                 match event {
7302                         Event::PaymentFailed { payment_hash, .. } => {
7303                                 if payment_hash == payment_hash_1 {
7304                                         assert!(!first_failed);
7305                                         first_failed = true;
7306                                 } else {
7307                                         assert_eq!(payment_hash, payment_hash_2);
7308                                 }
7309                         }
7310                         _ => panic!("Unexpected event"),
7311                 }
7312         }
7313 }
7314
7315 #[test]
7316 fn test_failure_delay_dust_htlc_local_commitment() {
7317         do_test_failure_delay_dust_htlc_local_commitment(true);
7318         do_test_failure_delay_dust_htlc_local_commitment(false);
7319 }
7320
7321 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7322         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7323         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7324         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7325         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7326         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7327         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7328
7329         let chanmon_cfgs = create_chanmon_cfgs(3);
7330         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7331         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7332         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7333         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7334
7335         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7336
7337         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7338         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7339
7340         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7341         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7342
7343         // We revoked bs_commitment_tx
7344         if revoked {
7345                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7346                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7347         }
7348
7349         let mut timeout_tx = Vec::new();
7350         if local {
7351                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7352                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7353                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7354                 expect_payment_failed!(nodes[0], dust_hash, true);
7355
7356                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7357                 check_closed_broadcast!(nodes[0], true);
7358                 check_added_monitors!(nodes[0], 1);
7359                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7360                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7361                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7362                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7363                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7364                 mine_transaction(&nodes[0], &timeout_tx[0]);
7365                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7366                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7367         } else {
7368                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7369                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7370                 check_closed_broadcast!(nodes[0], true);
7371                 check_added_monitors!(nodes[0], 1);
7372                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7373                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7374                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7375                 if !revoked {
7376                         expect_payment_failed!(nodes[0], dust_hash, true);
7377                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7378                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7379                         mine_transaction(&nodes[0], &timeout_tx[0]);
7380                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7381                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7382                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7383                 } else {
7384                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7385                         // commitment tx
7386                         let events = nodes[0].node.get_and_clear_pending_events();
7387                         assert_eq!(events.len(), 2);
7388                         let first;
7389                         match events[0] {
7390                                 Event::PaymentFailed { payment_hash, .. } => {
7391                                         if payment_hash == dust_hash { first = true; }
7392                                         else { first = false; }
7393                                 },
7394                                 _ => panic!("Unexpected event"),
7395                         }
7396                         match events[1] {
7397                                 Event::PaymentFailed { payment_hash, .. } => {
7398                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7399                                         else { assert_eq!(payment_hash, dust_hash); }
7400                                 },
7401                                 _ => panic!("Unexpected event"),
7402                         }
7403                 }
7404         }
7405 }
7406
7407 #[test]
7408 fn test_sweep_outbound_htlc_failure_update() {
7409         do_test_sweep_outbound_htlc_failure_update(false, true);
7410         do_test_sweep_outbound_htlc_failure_update(false, false);
7411         do_test_sweep_outbound_htlc_failure_update(true, false);
7412 }
7413
7414 #[test]
7415 fn test_upfront_shutdown_script() {
7416         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7417         // enforce it at shutdown message
7418
7419         let mut config = UserConfig::default();
7420         config.channel_options.announced_channel = true;
7421         config.peer_channel_config_limits.force_announced_channel_preference = false;
7422         config.channel_options.commit_upfront_shutdown_pubkey = false;
7423         let user_cfgs = [None, Some(config), None];
7424         let chanmon_cfgs = create_chanmon_cfgs(3);
7425         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7426         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7427         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7428
7429         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7430         let flags = InitFeatures::known();
7431         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7432         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7433         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7434         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7435         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7436         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7437     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()));
7438         check_added_monitors!(nodes[2], 1);
7439
7440         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7441         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7442         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7443         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7444         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7445         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7446         let events = nodes[2].node.get_and_clear_pending_msg_events();
7447         assert_eq!(events.len(), 1);
7448         match events[0] {
7449                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7450                 _ => panic!("Unexpected event"),
7451         }
7452
7453         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7454         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7455         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7456         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7457         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7458         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7459         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7460         let events = nodes[1].node.get_and_clear_pending_msg_events();
7461         assert_eq!(events.len(), 1);
7462         match events[0] {
7463                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7464                 _ => panic!("Unexpected event"),
7465         }
7466
7467         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7468         // channel smoothly, opt-out is from channel initiator here
7469         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7470         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7471         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7472         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7473         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7474         let events = nodes[0].node.get_and_clear_pending_msg_events();
7475         assert_eq!(events.len(), 1);
7476         match events[0] {
7477                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7478                 _ => panic!("Unexpected event"),
7479         }
7480
7481         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7482         //// channel smoothly
7483         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7484         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7485         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7486         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7487         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7488         let events = nodes[0].node.get_and_clear_pending_msg_events();
7489         assert_eq!(events.len(), 2);
7490         match events[0] {
7491                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7492                 _ => panic!("Unexpected event"),
7493         }
7494         match events[1] {
7495                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7496                 _ => panic!("Unexpected event"),
7497         }
7498 }
7499
7500 #[test]
7501 fn test_upfront_shutdown_script_unsupport_segwit() {
7502         // We test that channel is closed early
7503         // if a segwit program is passed as upfront shutdown script,
7504         // but the peer does not support segwit.
7505         let chanmon_cfgs = create_chanmon_cfgs(2);
7506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7508         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7509
7510         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7511
7512         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7513         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7514                 .push_slice(&[0, 0])
7515                 .into_script());
7516
7517         let features = InitFeatures::known().clear_shutdown_anysegwit();
7518         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7519
7520         let events = nodes[0].node.get_and_clear_pending_msg_events();
7521         assert_eq!(events.len(), 1);
7522         match events[0] {
7523                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7524                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7525                         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));
7526                 },
7527                 _ => panic!("Unexpected event"),
7528         }
7529 }
7530
7531 #[test]
7532 fn test_shutdown_script_any_segwit_allowed() {
7533         let mut config = UserConfig::default();
7534         config.channel_options.announced_channel = true;
7535         config.peer_channel_config_limits.force_announced_channel_preference = false;
7536         config.channel_options.commit_upfront_shutdown_pubkey = false;
7537         let user_cfgs = [None, Some(config), None];
7538         let chanmon_cfgs = create_chanmon_cfgs(3);
7539         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7540         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7541         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7542
7543         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7544         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7545         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7546         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7547         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7548                 .push_slice(&[0, 0])
7549                 .into_script();
7550         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7551         let events = nodes[0].node.get_and_clear_pending_msg_events();
7552         assert_eq!(events.len(), 2);
7553         match events[0] {
7554                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7555                 _ => panic!("Unexpected event"),
7556         }
7557         match events[1] {
7558                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7559                 _ => panic!("Unexpected event"),
7560         }
7561 }
7562
7563 #[test]
7564 fn test_shutdown_script_any_segwit_not_allowed() {
7565         let mut config = UserConfig::default();
7566         config.channel_options.announced_channel = true;
7567         config.peer_channel_config_limits.force_announced_channel_preference = false;
7568         config.channel_options.commit_upfront_shutdown_pubkey = false;
7569         let user_cfgs = [None, Some(config), None];
7570         let chanmon_cfgs = create_chanmon_cfgs(3);
7571         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7572         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7573         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7574
7575         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7576         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7577         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7578         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7579         // Make an any segwit version script
7580         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7581                 .push_slice(&[0, 0])
7582                 .into_script();
7583         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7584         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7585         let events = nodes[0].node.get_and_clear_pending_msg_events();
7586         assert_eq!(events.len(), 2);
7587         match events[1] {
7588                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7589                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7590                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7591                 },
7592                 _ => panic!("Unexpected event"),
7593         }
7594         check_added_monitors!(nodes[0], 1);
7595 }
7596
7597 #[test]
7598 fn test_shutdown_script_segwit_but_not_anysegwit() {
7599         let mut config = UserConfig::default();
7600         config.channel_options.announced_channel = true;
7601         config.peer_channel_config_limits.force_announced_channel_preference = false;
7602         config.channel_options.commit_upfront_shutdown_pubkey = false;
7603         let user_cfgs = [None, Some(config), None];
7604         let chanmon_cfgs = create_chanmon_cfgs(3);
7605         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7606         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7607         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7608
7609         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7610         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7611         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7612         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7613         // Make a segwit script that is not a valid as any segwit
7614         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7615                 .push_slice(&[0, 0])
7616                 .into_script();
7617         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7618         let events = nodes[0].node.get_and_clear_pending_msg_events();
7619         assert_eq!(events.len(), 2);
7620         match events[1] {
7621                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7622                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7623                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7624                 },
7625                 _ => panic!("Unexpected event"),
7626         }
7627         check_added_monitors!(nodes[0], 1);
7628 }
7629
7630 #[test]
7631 fn test_user_configurable_csv_delay() {
7632         // We test our channel constructors yield errors when we pass them absurd csv delay
7633
7634         let mut low_our_to_self_config = UserConfig::default();
7635         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7636         let mut high_their_to_self_config = UserConfig::default();
7637         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7638         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7639         let chanmon_cfgs = create_chanmon_cfgs(2);
7640         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7641         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7642         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7643
7644         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7645         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) {
7646                 match error {
7647                         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())); },
7648                         _ => panic!("Unexpected event"),
7649                 }
7650         } else { assert!(false) }
7651
7652         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7653         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7654         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7655         open_channel.to_self_delay = 200;
7656         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) {
7657                 match error {
7658                         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()));  },
7659                         _ => panic!("Unexpected event"),
7660                 }
7661         } else { assert!(false); }
7662
7663         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7664         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7665         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()));
7666         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7667         accept_channel.to_self_delay = 200;
7668         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7669         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7670                 match action {
7671                         &ErrorAction::SendErrorMessage { ref msg } => {
7672                                 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()));
7673                         },
7674                         _ => { assert!(false); }
7675                 }
7676         } else { assert!(false); }
7677
7678         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7679         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7680         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7681         open_channel.to_self_delay = 200;
7682         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) {
7683                 match error {
7684                         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())); },
7685                         _ => panic!("Unexpected event"),
7686                 }
7687         } else { assert!(false); }
7688 }
7689
7690 #[test]
7691 fn test_data_loss_protect() {
7692         // We want to be sure that :
7693         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7694         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7695         // * we close channel in case of detecting other being fallen behind
7696         // * we are able to claim our own outputs thanks to to_remote being static
7697         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7698         let persister;
7699         let logger;
7700         let fee_estimator;
7701         let tx_broadcaster;
7702         let chain_source;
7703         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7704         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7705         // during signing due to revoked tx
7706         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7707         let keys_manager = &chanmon_cfgs[0].keys_manager;
7708         let monitor;
7709         let node_state_0;
7710         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7711         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7712         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7713
7714         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7715
7716         // Cache node A state before any channel update
7717         let previous_node_state = nodes[0].node.encode();
7718         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7719         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7720
7721         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7722         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7723
7724         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7725         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7726
7727         // Restore node A from previous state
7728         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7729         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7730         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7731         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7732         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7733         persister = test_utils::TestPersister::new();
7734         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7735         node_state_0 = {
7736                 let mut channel_monitors = HashMap::new();
7737                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7738                 <(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 {
7739                         keys_manager: keys_manager,
7740                         fee_estimator: &fee_estimator,
7741                         chain_monitor: &monitor,
7742                         logger: &logger,
7743                         tx_broadcaster: &tx_broadcaster,
7744                         default_config: UserConfig::default(),
7745                         channel_monitors,
7746                 }).unwrap().1
7747         };
7748         nodes[0].node = &node_state_0;
7749         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7750         nodes[0].chain_monitor = &monitor;
7751         nodes[0].chain_source = &chain_source;
7752
7753         check_added_monitors!(nodes[0], 1);
7754
7755         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7756         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7757
7758         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7759
7760         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7761         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7762         check_added_monitors!(nodes[0], 1);
7763
7764         {
7765                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7766                 assert_eq!(node_txn.len(), 0);
7767         }
7768
7769         let mut reestablish_1 = Vec::with_capacity(1);
7770         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7771                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7772                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7773                         reestablish_1.push(msg.clone());
7774                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7775                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7776                         match action {
7777                                 &ErrorAction::SendErrorMessage { ref msg } => {
7778                                         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");
7779                                 },
7780                                 _ => panic!("Unexpected event!"),
7781                         }
7782                 } else {
7783                         panic!("Unexpected event")
7784                 }
7785         }
7786
7787         // Check we close channel detecting A is fallen-behind
7788         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7789         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7790         check_added_monitors!(nodes[1], 1);
7791
7792
7793         // Check A is able to claim to_remote output
7794         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7795         assert_eq!(node_txn.len(), 1);
7796         check_spends!(node_txn[0], chan.3);
7797         assert_eq!(node_txn[0].output.len(), 2);
7798         mine_transaction(&nodes[0], &node_txn[0]);
7799         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7800         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7801         assert_eq!(spend_txn.len(), 1);
7802         check_spends!(spend_txn[0], node_txn[0]);
7803 }
7804
7805 #[test]
7806 fn test_check_htlc_underpaying() {
7807         // Send payment through A -> B but A is maliciously
7808         // sending a probe payment (i.e less than expected value0
7809         // to B, B should refuse payment.
7810
7811         let chanmon_cfgs = create_chanmon_cfgs(2);
7812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7814         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7815
7816         // Create some initial channels
7817         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7818
7819         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();
7820         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7821         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7822         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7823         check_added_monitors!(nodes[0], 1);
7824
7825         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7826         assert_eq!(events.len(), 1);
7827         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7828         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7829         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7830
7831         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7832         // and then will wait a second random delay before failing the HTLC back:
7833         expect_pending_htlcs_forwardable!(nodes[1]);
7834         expect_pending_htlcs_forwardable!(nodes[1]);
7835
7836         // Node 3 is expecting payment of 100_000 but received 10_000,
7837         // it should fail htlc like we didn't know the preimage.
7838         nodes[1].node.process_pending_htlc_forwards();
7839
7840         let events = nodes[1].node.get_and_clear_pending_msg_events();
7841         assert_eq!(events.len(), 1);
7842         let (update_fail_htlc, commitment_signed) = match events[0] {
7843                 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 } } => {
7844                         assert!(update_add_htlcs.is_empty());
7845                         assert!(update_fulfill_htlcs.is_empty());
7846                         assert_eq!(update_fail_htlcs.len(), 1);
7847                         assert!(update_fail_malformed_htlcs.is_empty());
7848                         assert!(update_fee.is_none());
7849                         (update_fail_htlcs[0].clone(), commitment_signed)
7850                 },
7851                 _ => panic!("Unexpected event"),
7852         };
7853         check_added_monitors!(nodes[1], 1);
7854
7855         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7856         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7857
7858         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7859         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7860         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7861         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7862 }
7863
7864 #[test]
7865 fn test_announce_disable_channels() {
7866         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7867         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7868
7869         let chanmon_cfgs = create_chanmon_cfgs(2);
7870         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7871         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7872         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7873
7874         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7875         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7876         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7877
7878         // Disconnect peers
7879         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7880         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7881
7882         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7883         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7884         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7885         assert_eq!(msg_events.len(), 3);
7886         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7887         for e in msg_events {
7888                 match e {
7889                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7890                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7891                                 // Check that each channel gets updated exactly once
7892                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7893                                         panic!("Generated ChannelUpdate for wrong chan!");
7894                                 }
7895                         },
7896                         _ => panic!("Unexpected event"),
7897                 }
7898         }
7899         // Reconnect peers
7900         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7901         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7902         assert_eq!(reestablish_1.len(), 3);
7903         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7904         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7905         assert_eq!(reestablish_2.len(), 3);
7906
7907         // Reestablish chan_1
7908         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7909         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7910         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7911         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7912         // Reestablish chan_2
7913         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7914         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7915         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7916         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7917         // Reestablish chan_3
7918         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7919         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7920         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7921         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7922
7923         nodes[0].node.timer_tick_occurred();
7924         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7925         nodes[0].node.timer_tick_occurred();
7926         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7927         assert_eq!(msg_events.len(), 3);
7928         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7929         for e in msg_events {
7930                 match e {
7931                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7932                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7933                                 // Check that each channel gets updated exactly once
7934                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7935                                         panic!("Generated ChannelUpdate for wrong chan!");
7936                                 }
7937                         },
7938                         _ => panic!("Unexpected event"),
7939                 }
7940         }
7941 }
7942
7943 #[test]
7944 fn test_priv_forwarding_rejection() {
7945         // If we have a private channel with outbound liquidity, and
7946         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7947         // to forward through that channel.
7948         let chanmon_cfgs = create_chanmon_cfgs(3);
7949         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7950         let mut no_announce_cfg = test_default_channel_config();
7951         no_announce_cfg.channel_options.announced_channel = false;
7952         no_announce_cfg.accept_forwards_to_priv_channels = false;
7953         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7954         let persister: test_utils::TestPersister;
7955         let new_chain_monitor: test_utils::TestChainMonitor;
7956         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7957         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7958
7959         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7960
7961         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7962         // not send for private channels.
7963         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7964         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7965         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7966         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7967         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7968
7969         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7970         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7971         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()));
7972         check_added_monitors!(nodes[2], 1);
7973
7974         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()));
7975         check_added_monitors!(nodes[1], 1);
7976
7977         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7978         confirm_transaction_at(&nodes[1], &tx, conf_height);
7979         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7980         confirm_transaction_at(&nodes[2], &tx, conf_height);
7981         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7982         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7983         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()));
7984         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7985         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7986         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7987
7988         assert!(nodes[0].node.list_usable_channels()[0].is_public);
7989         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7990         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7991
7992         // We should always be able to forward through nodes[1] as long as its out through a public
7993         // channel:
7994         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7995
7996         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7997         // to nodes[2], which should be rejected:
7998         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7999         let route = get_route(&nodes[0].node.get_our_node_id(),
8000                 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8001                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
8002                 &[&RouteHint(vec![RouteHintHop {
8003                         src_node_id: nodes[1].node.get_our_node_id(),
8004                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
8005                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
8006                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
8007                         htlc_minimum_msat: None,
8008                         htlc_maximum_msat: None,
8009                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
8010
8011         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8012         check_added_monitors!(nodes[0], 1);
8013         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
8014         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8015         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
8016
8017         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8018         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
8019         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
8020         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
8021         assert!(htlc_fail_updates.update_fee.is_none());
8022
8023         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
8024         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
8025         expect_payment_failed!(nodes[0], our_payment_hash, false);
8026         expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
8027
8028         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
8029         // to true. Sadly there is currently no way to change it at runtime.
8030
8031         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8032         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8033
8034         let nodes_1_serialized = nodes[1].node.encode();
8035         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
8036         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
8037         {
8038                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
8039                 let mut mon_iter = mons.iter();
8040                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
8041                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
8042         }
8043
8044         persister = test_utils::TestPersister::new();
8045         let keys_manager = &chanmon_cfgs[1].keys_manager;
8046         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);
8047         nodes[1].chain_monitor = &new_chain_monitor;
8048
8049         let mut monitor_a_read = &monitor_a_serialized.0[..];
8050         let mut monitor_b_read = &monitor_b_serialized.0[..];
8051         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
8052         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
8053         assert!(monitor_a_read.is_empty());
8054         assert!(monitor_b_read.is_empty());
8055
8056         no_announce_cfg.accept_forwards_to_priv_channels = true;
8057
8058         let mut nodes_1_read = &nodes_1_serialized[..];
8059         let (_, nodes_1_deserialized_tmp) = {
8060                 let mut channel_monitors = HashMap::new();
8061                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
8062                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
8063                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
8064                         default_config: no_announce_cfg,
8065                         keys_manager,
8066                         fee_estimator: node_cfgs[1].fee_estimator,
8067                         chain_monitor: nodes[1].chain_monitor,
8068                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
8069                         logger: nodes[1].logger,
8070                         channel_monitors,
8071                 }).unwrap()
8072         };
8073         assert!(nodes_1_read.is_empty());
8074         nodes_1_deserialized = nodes_1_deserialized_tmp;
8075
8076         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
8077         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
8078         check_added_monitors!(nodes[1], 2);
8079         nodes[1].node = &nodes_1_deserialized;
8080
8081         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8082         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8083         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8084         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8085         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
8086         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8087         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8088         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
8089
8090         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8091         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8092         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
8093         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8094         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8095         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
8096         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8097         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8098
8099         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8100         check_added_monitors!(nodes[0], 1);
8101         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
8102         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
8103 }
8104
8105 #[test]
8106 fn test_bump_penalty_txn_on_revoked_commitment() {
8107         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8108         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8109
8110         let chanmon_cfgs = create_chanmon_cfgs(2);
8111         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8112         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8113         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8114
8115         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8116         let logger = test_utils::TestLogger::new();
8117
8118         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8119         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8120         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();
8121         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8122
8123         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8124         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8125         assert_eq!(revoked_txn[0].output.len(), 4);
8126         assert_eq!(revoked_txn[0].input.len(), 1);
8127         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8128         let revoked_txid = revoked_txn[0].txid();
8129
8130         let mut penalty_sum = 0;
8131         for outp in revoked_txn[0].output.iter() {
8132                 if outp.script_pubkey.is_v0_p2wsh() {
8133                         penalty_sum += outp.value;
8134                 }
8135         }
8136
8137         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8138         let header_114 = connect_blocks(&nodes[1], 14);
8139
8140         // Actually revoke tx by claiming a HTLC
8141         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8142         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8143         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
8144         check_added_monitors!(nodes[1], 1);
8145
8146         // One or more justice tx should have been broadcast, check it
8147         let penalty_1;
8148         let feerate_1;
8149         {
8150                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8151                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
8152                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8153                 assert_eq!(node_txn[0].output.len(), 1);
8154                 check_spends!(node_txn[0], revoked_txn[0]);
8155                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8156                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8157                 penalty_1 = node_txn[0].txid();
8158                 node_txn.clear();
8159         };
8160
8161         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8162         connect_blocks(&nodes[1], 15);
8163         let mut penalty_2 = penalty_1;
8164         let mut feerate_2 = 0;
8165         {
8166                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8167                 assert_eq!(node_txn.len(), 1);
8168                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8169                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8170                         assert_eq!(node_txn[0].output.len(), 1);
8171                         check_spends!(node_txn[0], revoked_txn[0]);
8172                         penalty_2 = node_txn[0].txid();
8173                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8174                         assert_ne!(penalty_2, penalty_1);
8175                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8176                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8177                         // Verify 25% bump heuristic
8178                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8179                         node_txn.clear();
8180                 }
8181         }
8182         assert_ne!(feerate_2, 0);
8183
8184         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8185         connect_blocks(&nodes[1], 1);
8186         let penalty_3;
8187         let mut feerate_3 = 0;
8188         {
8189                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8190                 assert_eq!(node_txn.len(), 1);
8191                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8192                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8193                         assert_eq!(node_txn[0].output.len(), 1);
8194                         check_spends!(node_txn[0], revoked_txn[0]);
8195                         penalty_3 = node_txn[0].txid();
8196                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8197                         assert_ne!(penalty_3, penalty_2);
8198                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8199                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8200                         // Verify 25% bump heuristic
8201                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8202                         node_txn.clear();
8203                 }
8204         }
8205         assert_ne!(feerate_3, 0);
8206
8207         nodes[1].node.get_and_clear_pending_events();
8208         nodes[1].node.get_and_clear_pending_msg_events();
8209 }
8210
8211 #[test]
8212 fn test_bump_penalty_txn_on_revoked_htlcs() {
8213         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8214         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8215
8216         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8217         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8218         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8219         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8220         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8221
8222         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8223         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8224         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8225                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8226         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8227         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8228                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8229         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8230
8231         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8232         assert_eq!(revoked_local_txn[0].input.len(), 1);
8233         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8234
8235         // Revoke local commitment tx
8236         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8237
8238         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8239         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8240         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8241         check_closed_broadcast!(nodes[1], true);
8242         check_added_monitors!(nodes[1], 1);
8243         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8244
8245         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8246         assert_eq!(revoked_htlc_txn.len(), 3);
8247         check_spends!(revoked_htlc_txn[1], chan.3);
8248
8249         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8250         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8251         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8252
8253         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8254         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8255         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8256         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8257
8258         // Broadcast set of revoked txn on A
8259         let hash_128 = connect_blocks(&nodes[0], 40);
8260         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8261         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8262         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8263         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8264         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8265         let first;
8266         let feerate_1;
8267         let penalty_txn;
8268         {
8269                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8270                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8271                 // Verify claim tx are spending revoked HTLC txn
8272
8273                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8274                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8275                 // which are included in the same block (they are broadcasted because we scan the
8276                 // transactions linearly and generate claims as we go, they likely should be removed in the
8277                 // future).
8278                 assert_eq!(node_txn[0].input.len(), 1);
8279                 check_spends!(node_txn[0], revoked_local_txn[0]);
8280                 assert_eq!(node_txn[1].input.len(), 1);
8281                 check_spends!(node_txn[1], revoked_local_txn[0]);
8282                 assert_eq!(node_txn[2].input.len(), 1);
8283                 check_spends!(node_txn[2], revoked_local_txn[0]);
8284
8285                 // Each of the three justice transactions claim a separate (single) output of the three
8286                 // available, which we check here:
8287                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8288                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8289                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8290
8291                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8292                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8293
8294                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8295                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8296                 // a remote commitment tx has already been confirmed).
8297                 check_spends!(node_txn[3], chan.3);
8298
8299                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8300                 // output, checked above).
8301                 assert_eq!(node_txn[4].input.len(), 2);
8302                 assert_eq!(node_txn[4].output.len(), 1);
8303                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8304
8305                 first = node_txn[4].txid();
8306                 // Store both feerates for later comparison
8307                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8308                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8309                 penalty_txn = vec![node_txn[2].clone()];
8310                 node_txn.clear();
8311         }
8312
8313         // Connect one more block to see if bumped penalty are issued for HTLC txn
8314         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8315         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8316         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8317         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8318         {
8319                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8320                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8321
8322                 check_spends!(node_txn[0], revoked_local_txn[0]);
8323                 check_spends!(node_txn[1], revoked_local_txn[0]);
8324                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8325                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8326                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8327                 } else {
8328                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8329                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8330                 }
8331
8332                 node_txn.clear();
8333         };
8334
8335         // Few more blocks to confirm penalty txn
8336         connect_blocks(&nodes[0], 4);
8337         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8338         let header_144 = connect_blocks(&nodes[0], 9);
8339         let node_txn = {
8340                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8341                 assert_eq!(node_txn.len(), 1);
8342
8343                 assert_eq!(node_txn[0].input.len(), 2);
8344                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8345                 // Verify bumped tx is different and 25% bump heuristic
8346                 assert_ne!(first, node_txn[0].txid());
8347                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8348                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8349                 assert!(feerate_2 * 100 > feerate_1 * 125);
8350                 let txn = vec![node_txn[0].clone()];
8351                 node_txn.clear();
8352                 txn
8353         };
8354         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8355         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8356         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8357         connect_blocks(&nodes[0], 20);
8358         {
8359                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8360                 // We verify than no new transaction has been broadcast because previously
8361                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8362                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8363                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8364                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8365                 // up bumped justice generation.
8366                 assert_eq!(node_txn.len(), 0);
8367                 node_txn.clear();
8368         }
8369         check_closed_broadcast!(nodes[0], true);
8370         check_added_monitors!(nodes[0], 1);
8371 }
8372
8373 #[test]
8374 fn test_bump_penalty_txn_on_remote_commitment() {
8375         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8376         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8377
8378         // Create 2 HTLCs
8379         // Provide preimage for one
8380         // Check aggregation
8381
8382         let chanmon_cfgs = create_chanmon_cfgs(2);
8383         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8384         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8385         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8386
8387         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8388         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8389         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8390
8391         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8392         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8393         assert_eq!(remote_txn[0].output.len(), 4);
8394         assert_eq!(remote_txn[0].input.len(), 1);
8395         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8396
8397         // Claim a HTLC without revocation (provide B monitor with preimage)
8398         nodes[1].node.claim_funds(payment_preimage);
8399         mine_transaction(&nodes[1], &remote_txn[0]);
8400         check_added_monitors!(nodes[1], 2);
8401         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8402
8403         // One or more claim tx should have been broadcast, check it
8404         let timeout;
8405         let preimage;
8406         let preimage_bump;
8407         let feerate_timeout;
8408         let feerate_preimage;
8409         {
8410                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8411                 // 9 transactions including:
8412                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8413                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8414                 // 2 * HTLC-Success (one RBF bump we'll check later)
8415                 // 1 * HTLC-Timeout
8416                 assert_eq!(node_txn.len(), 8);
8417                 assert_eq!(node_txn[0].input.len(), 1);
8418                 assert_eq!(node_txn[6].input.len(), 1);
8419                 check_spends!(node_txn[0], remote_txn[0]);
8420                 check_spends!(node_txn[6], remote_txn[0]);
8421                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8422                 preimage_bump = node_txn[3].clone();
8423
8424                 check_spends!(node_txn[1], chan.3);
8425                 check_spends!(node_txn[2], node_txn[1]);
8426                 assert_eq!(node_txn[1], node_txn[4]);
8427                 assert_eq!(node_txn[2], node_txn[5]);
8428
8429                 timeout = node_txn[6].txid();
8430                 let index = node_txn[6].input[0].previous_output.vout;
8431                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8432                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8433
8434                 preimage = node_txn[0].txid();
8435                 let index = node_txn[0].input[0].previous_output.vout;
8436                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8437                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8438
8439                 node_txn.clear();
8440         };
8441         assert_ne!(feerate_timeout, 0);
8442         assert_ne!(feerate_preimage, 0);
8443
8444         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8445         connect_blocks(&nodes[1], 15);
8446         {
8447                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8448                 assert_eq!(node_txn.len(), 1);
8449                 assert_eq!(node_txn[0].input.len(), 1);
8450                 assert_eq!(preimage_bump.input.len(), 1);
8451                 check_spends!(node_txn[0], remote_txn[0]);
8452                 check_spends!(preimage_bump, remote_txn[0]);
8453
8454                 let index = preimage_bump.input[0].previous_output.vout;
8455                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8456                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8457                 assert!(new_feerate * 100 > feerate_timeout * 125);
8458                 assert_ne!(timeout, preimage_bump.txid());
8459
8460                 let index = node_txn[0].input[0].previous_output.vout;
8461                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8462                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8463                 assert!(new_feerate * 100 > feerate_preimage * 125);
8464                 assert_ne!(preimage, node_txn[0].txid());
8465
8466                 node_txn.clear();
8467         }
8468
8469         nodes[1].node.get_and_clear_pending_events();
8470         nodes[1].node.get_and_clear_pending_msg_events();
8471 }
8472
8473 #[test]
8474 fn test_counterparty_raa_skip_no_crash() {
8475         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8476         // commitment transaction, we would have happily carried on and provided them the next
8477         // commitment transaction based on one RAA forward. This would probably eventually have led to
8478         // channel closure, but it would not have resulted in funds loss. Still, our
8479         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8480         // check simply that the channel is closed in response to such an RAA, but don't check whether
8481         // we decide to punish our counterparty for revoking their funds (as we don't currently
8482         // implement that).
8483         let chanmon_cfgs = create_chanmon_cfgs(2);
8484         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8485         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8486         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8487         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8488
8489         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8490         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8491         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8492         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8493         // Must revoke without gaps
8494         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8495         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8496                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8497
8498         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8499                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8500         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8501         check_added_monitors!(nodes[1], 1);
8502 }
8503
8504 #[test]
8505 fn test_bump_txn_sanitize_tracking_maps() {
8506         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8507         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8508
8509         let chanmon_cfgs = create_chanmon_cfgs(2);
8510         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8511         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8512         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8513
8514         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8515         // Lock HTLC in both directions
8516         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8517         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8518
8519         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8520         assert_eq!(revoked_local_txn[0].input.len(), 1);
8521         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8522
8523         // Revoke local commitment tx
8524         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8525
8526         // Broadcast set of revoked txn on A
8527         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8528         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8529         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8530
8531         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8532         check_closed_broadcast!(nodes[0], true);
8533         check_added_monitors!(nodes[0], 1);
8534         let penalty_txn = {
8535                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8536                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8537                 check_spends!(node_txn[0], revoked_local_txn[0]);
8538                 check_spends!(node_txn[1], revoked_local_txn[0]);
8539                 check_spends!(node_txn[2], revoked_local_txn[0]);
8540                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8541                 node_txn.clear();
8542                 penalty_txn
8543         };
8544         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8545         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8546         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8547         {
8548                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8549                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8550                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8551                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8552                 }
8553         }
8554 }
8555
8556 #[test]
8557 fn test_override_channel_config() {
8558         let chanmon_cfgs = create_chanmon_cfgs(2);
8559         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8560         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8561         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8562
8563         // Node0 initiates a channel to node1 using the override config.
8564         let mut override_config = UserConfig::default();
8565         override_config.own_channel_config.our_to_self_delay = 200;
8566
8567         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8568
8569         // Assert the channel created by node0 is using the override config.
8570         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8571         assert_eq!(res.channel_flags, 0);
8572         assert_eq!(res.to_self_delay, 200);
8573 }
8574
8575 #[test]
8576 fn test_override_0msat_htlc_minimum() {
8577         let mut zero_config = UserConfig::default();
8578         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8579         let chanmon_cfgs = create_chanmon_cfgs(2);
8580         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8581         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8582         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8583
8584         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8585         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8586         assert_eq!(res.htlc_minimum_msat, 1);
8587
8588         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8589         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8590         assert_eq!(res.htlc_minimum_msat, 1);
8591 }
8592
8593 #[test]
8594 fn test_simple_mpp() {
8595         // Simple test of sending a multi-path payment.
8596         let chanmon_cfgs = create_chanmon_cfgs(4);
8597         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8598         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8599         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8600
8601         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8602         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8603         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8604         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8605         let logger = test_utils::TestLogger::new();
8606
8607         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8608         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8609         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();
8610         let path = route.paths[0].clone();
8611         route.paths.push(path);
8612         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8613         route.paths[0][0].short_channel_id = chan_1_id;
8614         route.paths[0][1].short_channel_id = chan_3_id;
8615         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8616         route.paths[1][0].short_channel_id = chan_2_id;
8617         route.paths[1][1].short_channel_id = chan_4_id;
8618         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8619         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8620 }
8621
8622 #[test]
8623 fn test_preimage_storage() {
8624         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8625         let chanmon_cfgs = create_chanmon_cfgs(2);
8626         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8627         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8628         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8629
8630         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8631
8632         {
8633                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8634
8635                 let logger = test_utils::TestLogger::new();
8636                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8637                 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();
8638                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8639                 check_added_monitors!(nodes[0], 1);
8640                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8641                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8642                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8643                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8644         }
8645         // Note that after leaving the above scope we have no knowledge of any arguments or return
8646         // values from previous calls.
8647         expect_pending_htlcs_forwardable!(nodes[1]);
8648         let events = nodes[1].node.get_and_clear_pending_events();
8649         assert_eq!(events.len(), 1);
8650         match events[0] {
8651                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8652                         assert_eq!(user_payment_id, 42);
8653                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8654                 },
8655                 _ => panic!("Unexpected event"),
8656         }
8657 }
8658
8659 #[test]
8660 fn test_secret_timeout() {
8661         // Simple test of payment secret storage time outs
8662         let chanmon_cfgs = create_chanmon_cfgs(2);
8663         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8664         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8665         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8666
8667         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8668
8669         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8670
8671         // We should fail to register the same payment hash twice, at least until we've connected a
8672         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8673         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8674                 assert_eq!(err, "Duplicate payment hash");
8675         } else { panic!(); }
8676         let mut block = {
8677                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8678                 Block {
8679                         header: BlockHeader {
8680                                 version: 0x2000000,
8681                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8682                                 merkle_root: Default::default(),
8683                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8684                         txdata: vec![],
8685                 }
8686         };
8687         connect_block(&nodes[1], &block);
8688         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8689                 assert_eq!(err, "Duplicate payment hash");
8690         } else { panic!(); }
8691
8692         // If we then connect the second block, we should be able to register the same payment hash
8693         // again with a different user_payment_id (this time getting a new payment secret).
8694         block.header.prev_blockhash = block.header.block_hash();
8695         block.header.time += 1;
8696         connect_block(&nodes[1], &block);
8697         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8698         assert_ne!(payment_secret_1, our_payment_secret);
8699
8700         {
8701                 let logger = test_utils::TestLogger::new();
8702                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8703                 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();
8704                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8705                 check_added_monitors!(nodes[0], 1);
8706                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8707                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8708                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8709                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8710         }
8711         // Note that after leaving the above scope we have no knowledge of any arguments or return
8712         // values from previous calls.
8713         expect_pending_htlcs_forwardable!(nodes[1]);
8714         let events = nodes[1].node.get_and_clear_pending_events();
8715         assert_eq!(events.len(), 1);
8716         match events[0] {
8717                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8718                         assert!(payment_preimage.is_none());
8719                         assert_eq!(user_payment_id, 42);
8720                         assert_eq!(payment_secret, our_payment_secret);
8721                         // We don't actually have the payment preimage with which to claim this payment!
8722                 },
8723                 _ => panic!("Unexpected event"),
8724         }
8725 }
8726
8727 #[test]
8728 fn test_bad_secret_hash() {
8729         // Simple test of unregistered payment hash/invalid payment secret handling
8730         let chanmon_cfgs = create_chanmon_cfgs(2);
8731         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8732         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8733         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8734
8735         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8736
8737         let random_payment_hash = PaymentHash([42; 32]);
8738         let random_payment_secret = PaymentSecret([43; 32]);
8739         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8740
8741         let logger = test_utils::TestLogger::new();
8742         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8743         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();
8744
8745         // All the below cases should end up being handled exactly identically, so we macro the
8746         // resulting events.
8747         macro_rules! handle_unknown_invalid_payment_data {
8748                 () => {
8749                         check_added_monitors!(nodes[0], 1);
8750                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8751                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8752                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8753                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8754
8755                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8756                         // again to process the pending backwards-failure of the HTLC
8757                         expect_pending_htlcs_forwardable!(nodes[1]);
8758                         expect_pending_htlcs_forwardable!(nodes[1]);
8759                         check_added_monitors!(nodes[1], 1);
8760
8761                         // We should fail the payment back
8762                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8763                         match events.pop().unwrap() {
8764                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8765                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8766                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8767                                 },
8768                                 _ => panic!("Unexpected event"),
8769                         }
8770                 }
8771         }
8772
8773         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8774         // Error data is the HTLC value (100,000) and current block height
8775         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8776
8777         // Send a payment with the right payment hash but the wrong payment secret
8778         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8779         handle_unknown_invalid_payment_data!();
8780         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8781
8782         // Send a payment with a random payment hash, but the right payment secret
8783         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8784         handle_unknown_invalid_payment_data!();
8785         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8786
8787         // Send a payment with a random payment hash and random payment secret
8788         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8789         handle_unknown_invalid_payment_data!();
8790         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8791 }
8792
8793 #[test]
8794 fn test_update_err_monitor_lockdown() {
8795         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8796         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8797         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8798         //
8799         // This scenario may happen in a watchtower setup, where watchtower process a block height
8800         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8801         // commitment at same time.
8802
8803         let chanmon_cfgs = create_chanmon_cfgs(2);
8804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8806         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8807
8808         // Create some initial channel
8809         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8810         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8811
8812         // Rebalance the network to generate htlc in the two directions
8813         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8814
8815         // Route a HTLC from node 0 to node 1 (but don't settle)
8816         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8817
8818         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8819         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8820         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8821         let persister = test_utils::TestPersister::new();
8822         let watchtower = {
8823                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8824                 let monitor = monitors.get(&outpoint).unwrap();
8825                 let mut w = test_utils::TestVecWriter(Vec::new());
8826                 monitor.write(&mut w).unwrap();
8827                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8828                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8829                 assert!(new_monitor == *monitor);
8830                 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);
8831                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8832                 watchtower
8833         };
8834         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8835         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8836         // transaction lock time requirements here.
8837         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8838         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8839
8840         // Try to update ChannelMonitor
8841         assert!(nodes[1].node.claim_funds(preimage));
8842         check_added_monitors!(nodes[1], 1);
8843         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8844         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8845         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8846         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8847                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8848                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8849                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8850                 } else { assert!(false); }
8851         } else { assert!(false); };
8852         // Our local monitor is in-sync and hasn't processed yet timeout
8853         check_added_monitors!(nodes[0], 1);
8854         let events = nodes[0].node.get_and_clear_pending_events();
8855         assert_eq!(events.len(), 1);
8856 }
8857
8858 #[test]
8859 fn test_concurrent_monitor_claim() {
8860         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8861         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8862         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8863         // state N+1 confirms. Alice claims output from state N+1.
8864
8865         let chanmon_cfgs = create_chanmon_cfgs(2);
8866         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8867         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8868         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8869
8870         // Create some initial channel
8871         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8872         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8873
8874         // Rebalance the network to generate htlc in the two directions
8875         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8876
8877         // Route a HTLC from node 0 to node 1 (but don't settle)
8878         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8879
8880         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8881         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8882         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8883         let persister = test_utils::TestPersister::new();
8884         let watchtower_alice = {
8885                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8886                 let monitor = monitors.get(&outpoint).unwrap();
8887                 let mut w = test_utils::TestVecWriter(Vec::new());
8888                 monitor.write(&mut w).unwrap();
8889                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8890                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8891                 assert!(new_monitor == *monitor);
8892                 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);
8893                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8894                 watchtower
8895         };
8896         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8897         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8898         // transaction lock time requirements here.
8899         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8900         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8901
8902         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8903         {
8904                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8905                 assert_eq!(txn.len(), 2);
8906                 txn.clear();
8907         }
8908
8909         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8910         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8911         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8912         let persister = test_utils::TestPersister::new();
8913         let watchtower_bob = {
8914                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8915                 let monitor = monitors.get(&outpoint).unwrap();
8916                 let mut w = test_utils::TestVecWriter(Vec::new());
8917                 monitor.write(&mut w).unwrap();
8918                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8919                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8920                 assert!(new_monitor == *monitor);
8921                 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);
8922                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8923                 watchtower
8924         };
8925         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8926         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8927
8928         // Route another payment to generate another update with still previous HTLC pending
8929         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8930         {
8931                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8932                 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();
8933                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8934         }
8935         check_added_monitors!(nodes[1], 1);
8936
8937         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8938         assert_eq!(updates.update_add_htlcs.len(), 1);
8939         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8940         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8941                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8942                         // Watchtower Alice should already have seen the block and reject the update
8943                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8944                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8945                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8946                 } else { assert!(false); }
8947         } else { assert!(false); };
8948         // Our local monitor is in-sync and hasn't processed yet timeout
8949         check_added_monitors!(nodes[0], 1);
8950
8951         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
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 + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8954
8955         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8956         let bob_state_y;
8957         {
8958                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8959                 assert_eq!(txn.len(), 2);
8960                 bob_state_y = txn[0].clone();
8961                 txn.clear();
8962         };
8963
8964         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8965         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8966         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);
8967         {
8968                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8969                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8970                 // the onchain detection of the HTLC output
8971                 assert_eq!(htlc_txn.len(), 2);
8972                 check_spends!(htlc_txn[0], bob_state_y);
8973                 check_spends!(htlc_txn[1], bob_state_y);
8974         }
8975 }
8976
8977 #[test]
8978 fn test_pre_lockin_no_chan_closed_update() {
8979         // Test that if a peer closes a channel in response to a funding_created message we don't
8980         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8981         // message).
8982         //
8983         // Doing so would imply a channel monitor update before the initial channel monitor
8984         // registration, violating our API guarantees.
8985         //
8986         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8987         // then opening a second channel with the same funding output as the first (which is not
8988         // rejected because the first channel does not exist in the ChannelManager) and closing it
8989         // before receiving funding_signed.
8990         let chanmon_cfgs = create_chanmon_cfgs(2);
8991         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8992         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8993         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8994
8995         // Create an initial channel
8996         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8997         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8998         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8999         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9000         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
9001
9002         // Move the first channel through the funding flow...
9003         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
9004
9005         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9006         check_added_monitors!(nodes[0], 0);
9007
9008         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9009         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
9010         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
9011         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
9012 }
9013
9014 #[test]
9015 fn test_htlc_no_detection() {
9016         // This test is a mutation to underscore the detection logic bug we had
9017         // before #653. HTLC value routed is above the remaining balance, thus
9018         // inverting HTLC and `to_remote` output. HTLC will come second and
9019         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
9020         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
9021         // outputs order detection for correct spending children filtring.
9022
9023         let chanmon_cfgs = create_chanmon_cfgs(2);
9024         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9026         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9027
9028         // Create some initial channels
9029         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9030
9031         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
9032         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
9033         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
9034         assert_eq!(local_txn[0].input.len(), 1);
9035         assert_eq!(local_txn[0].output.len(), 3);
9036         check_spends!(local_txn[0], chan_1.3);
9037
9038         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9039         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9040         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
9041         // We deliberately connect the local tx twice as this should provoke a failure calling
9042         // this test before #653 fix.
9043         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);
9044         check_closed_broadcast!(nodes[0], true);
9045         check_added_monitors!(nodes[0], 1);
9046         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
9047
9048         let htlc_timeout = {
9049                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9050                 assert_eq!(node_txn[1].input.len(), 1);
9051                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9052                 check_spends!(node_txn[1], local_txn[0]);
9053                 node_txn[1].clone()
9054         };
9055
9056         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9057         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
9058         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
9059         expect_payment_failed!(nodes[0], our_payment_hash, true);
9060 }
9061
9062 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
9063         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
9064         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
9065         // Carol, Alice would be the upstream node, and Carol the downstream.)
9066         //
9067         // Steps of the test:
9068         // 1) Alice sends a HTLC to Carol through Bob.
9069         // 2) Carol doesn't settle the HTLC.
9070         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
9071         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
9072         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
9073         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
9074         // 5) Carol release the preimage to Bob off-chain.
9075         // 6) Bob claims the offered output on the broadcasted commitment.
9076         let chanmon_cfgs = create_chanmon_cfgs(3);
9077         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9078         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9079         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9080
9081         // Create some initial channels
9082         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9083         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9084
9085         // Steps (1) and (2):
9086         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
9087         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
9088
9089         // Check that Alice's commitment transaction now contains an output for this HTLC.
9090         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
9091         check_spends!(alice_txn[0], chan_ab.3);
9092         assert_eq!(alice_txn[0].output.len(), 2);
9093         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
9094         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9095         assert_eq!(alice_txn.len(), 2);
9096
9097         // Steps (3) and (4):
9098         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
9099         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
9100         let mut force_closing_node = 0; // Alice force-closes
9101         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
9102         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
9103         check_closed_broadcast!(nodes[force_closing_node], true);
9104         check_added_monitors!(nodes[force_closing_node], 1);
9105         if go_onchain_before_fulfill {
9106                 let txn_to_broadcast = match broadcast_alice {
9107                         true => alice_txn.clone(),
9108                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
9109                 };
9110                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9111                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9112                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9113                 if broadcast_alice {
9114                         check_closed_broadcast!(nodes[1], true);
9115                         check_added_monitors!(nodes[1], 1);
9116                 }
9117                 assert_eq!(bob_txn.len(), 1);
9118                 check_spends!(bob_txn[0], chan_ab.3);
9119         }
9120
9121         // Step (5):
9122         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
9123         // process of removing the HTLC from their commitment transactions.
9124         assert!(nodes[2].node.claim_funds(payment_preimage));
9125         check_added_monitors!(nodes[2], 1);
9126         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
9127         assert!(carol_updates.update_add_htlcs.is_empty());
9128         assert!(carol_updates.update_fail_htlcs.is_empty());
9129         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
9130         assert!(carol_updates.update_fee.is_none());
9131         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
9132
9133         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
9134         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
9135         if !go_onchain_before_fulfill && broadcast_alice {
9136                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9137                 assert_eq!(events.len(), 1);
9138                 match events[0] {
9139                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
9140                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9141                         },
9142                         _ => panic!("Unexpected event"),
9143                 };
9144         }
9145         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
9146         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
9147         // Carol<->Bob's updated commitment transaction info.
9148         check_added_monitors!(nodes[1], 2);
9149
9150         let events = nodes[1].node.get_and_clear_pending_msg_events();
9151         assert_eq!(events.len(), 2);
9152         let bob_revocation = match events[0] {
9153                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9154                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9155                         (*msg).clone()
9156                 },
9157                 _ => panic!("Unexpected event"),
9158         };
9159         let bob_updates = match events[1] {
9160                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
9161                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9162                         (*updates).clone()
9163                 },
9164                 _ => panic!("Unexpected event"),
9165         };
9166
9167         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
9168         check_added_monitors!(nodes[2], 1);
9169         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
9170         check_added_monitors!(nodes[2], 1);
9171
9172         let events = nodes[2].node.get_and_clear_pending_msg_events();
9173         assert_eq!(events.len(), 1);
9174         let carol_revocation = match events[0] {
9175                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9176                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9177                         (*msg).clone()
9178                 },
9179                 _ => panic!("Unexpected event"),
9180         };
9181         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9182         check_added_monitors!(nodes[1], 1);
9183
9184         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9185         // here's where we put said channel's commitment tx on-chain.
9186         let mut txn_to_broadcast = alice_txn.clone();
9187         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9188         if !go_onchain_before_fulfill {
9189                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9190                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9191                 // If Bob was the one to force-close, he will have already passed these checks earlier.
9192                 if broadcast_alice {
9193                         check_closed_broadcast!(nodes[1], true);
9194                         check_added_monitors!(nodes[1], 1);
9195                 }
9196                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9197                 if broadcast_alice {
9198                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9199                         // new block being connected. The ChannelManager being notified triggers a monitor update,
9200                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9201                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9202                         // broadcasted.
9203                         assert_eq!(bob_txn.len(), 3);
9204                         check_spends!(bob_txn[1], chan_ab.3);
9205                 } else {
9206                         assert_eq!(bob_txn.len(), 2);
9207                         check_spends!(bob_txn[0], chan_ab.3);
9208                 }
9209         }
9210
9211         // Step (6):
9212         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9213         // broadcasted commitment transaction.
9214         {
9215                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9216                 if go_onchain_before_fulfill {
9217                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9218                         assert_eq!(bob_txn.len(), 2);
9219                 }
9220                 let script_weight = match broadcast_alice {
9221                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9222                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9223                 };
9224                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9225                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9226                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9227                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9228                 if broadcast_alice && !go_onchain_before_fulfill {
9229                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9230                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9231                 } else {
9232                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9233                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9234                 }
9235         }
9236 }
9237
9238 #[test]
9239 fn test_onchain_htlc_settlement_after_close() {
9240         do_test_onchain_htlc_settlement_after_close(true, true);
9241         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9242         do_test_onchain_htlc_settlement_after_close(true, false);
9243         do_test_onchain_htlc_settlement_after_close(false, false);
9244 }
9245
9246 #[test]
9247 fn test_duplicate_chan_id() {
9248         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9249         // already open we reject it and keep the old channel.
9250         //
9251         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9252         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9253         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9254         // updating logic for the existing channel.
9255         let chanmon_cfgs = create_chanmon_cfgs(2);
9256         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9257         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9258         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9259
9260         // Create an initial channel
9261         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9262         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9263         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9264         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()));
9265
9266         // Try to create a second channel with the same temporary_channel_id as the first and check
9267         // that it is rejected.
9268         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9269         {
9270                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9271                 assert_eq!(events.len(), 1);
9272                 match events[0] {
9273                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9274                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9275                                 // first (valid) and second (invalid) channels are closed, given they both have
9276                                 // the same non-temporary channel_id. However, currently we do not, so we just
9277                                 // move forward with it.
9278                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9279                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9280                         },
9281                         _ => panic!("Unexpected event"),
9282                 }
9283         }
9284
9285         // Move the first channel through the funding flow...
9286         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9287
9288         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9289         check_added_monitors!(nodes[0], 0);
9290
9291         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9292         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9293         {
9294                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9295                 assert_eq!(added_monitors.len(), 1);
9296                 assert_eq!(added_monitors[0].0, funding_output);
9297                 added_monitors.clear();
9298         }
9299         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9300
9301         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9302         let channel_id = funding_outpoint.to_channel_id();
9303
9304         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9305         // temporary one).
9306
9307         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9308         // Technically this is allowed by the spec, but we don't support it and there's little reason
9309         // to. Still, it shouldn't cause any other issues.
9310         open_chan_msg.temporary_channel_id = channel_id;
9311         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9312         {
9313                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9314                 assert_eq!(events.len(), 1);
9315                 match events[0] {
9316                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9317                                 // Technically, at this point, nodes[1] would be justified in thinking both
9318                                 // channels are closed, but currently we do not, so we just move forward with it.
9319                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9320                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9321                         },
9322                         _ => panic!("Unexpected event"),
9323                 }
9324         }
9325
9326         // Now try to create a second channel which has a duplicate funding output.
9327         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9328         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9329         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9330         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()));
9331         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9332
9333         let funding_created = {
9334                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9335                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9336                 let logger = test_utils::TestLogger::new();
9337                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9338         };
9339         check_added_monitors!(nodes[0], 0);
9340         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9341         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9342         // still needs to be cleared here.
9343         check_added_monitors!(nodes[1], 1);
9344
9345         // ...still, nodes[1] will reject the duplicate channel.
9346         {
9347                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9348                 assert_eq!(events.len(), 1);
9349                 match events[0] {
9350                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9351                                 // Technically, at this point, nodes[1] would be justified in thinking both
9352                                 // channels are closed, but currently we do not, so we just move forward with it.
9353                                 assert_eq!(msg.channel_id, channel_id);
9354                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9355                         },
9356                         _ => panic!("Unexpected event"),
9357                 }
9358         }
9359
9360         // finally, finish creating the original channel and send a payment over it to make sure
9361         // everything is functional.
9362         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9363         {
9364                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9365                 assert_eq!(added_monitors.len(), 1);
9366                 assert_eq!(added_monitors[0].0, funding_output);
9367                 added_monitors.clear();
9368         }
9369
9370         let events_4 = nodes[0].node.get_and_clear_pending_events();
9371         assert_eq!(events_4.len(), 0);
9372         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9373         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9374
9375         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9376         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9377         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9378         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9379 }
9380
9381 #[test]
9382 fn test_error_chans_closed() {
9383         // Test that we properly handle error messages, closing appropriate channels.
9384         //
9385         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9386         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9387         // we can test various edge cases around it to ensure we don't regress.
9388         let chanmon_cfgs = create_chanmon_cfgs(3);
9389         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9390         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9391         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9392
9393         // Create some initial channels
9394         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9395         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9396         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9397
9398         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9399         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9400         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9401
9402         // Closing a channel from a different peer has no effect
9403         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9404         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9405
9406         // Closing one channel doesn't impact others
9407         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9408         check_added_monitors!(nodes[0], 1);
9409         check_closed_broadcast!(nodes[0], false);
9410         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9411         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9412         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);
9413         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);
9414
9415         // A null channel ID should close all channels
9416         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9417         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9418         check_added_monitors!(nodes[0], 2);
9419         let events = nodes[0].node.get_and_clear_pending_msg_events();
9420         assert_eq!(events.len(), 2);
9421         match events[0] {
9422                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9423                         assert_eq!(msg.contents.flags & 2, 2);
9424                 },
9425                 _ => panic!("Unexpected event"),
9426         }
9427         match events[1] {
9428                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9429                         assert_eq!(msg.contents.flags & 2, 2);
9430                 },
9431                 _ => panic!("Unexpected event"),
9432         }
9433         // Note that at this point users of a standard PeerHandler will end up calling
9434         // peer_disconnected with no_connection_possible set to false, duplicating the
9435         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9436         // users with their own peer handling logic. We duplicate the call here, however.
9437         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9438         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9439
9440         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9441         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9442         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9443 }
9444
9445 #[test]
9446 fn test_invalid_funding_tx() {
9447         // Test that we properly handle invalid funding transactions sent to us from a peer.
9448         //
9449         // Previously, all other major lightning implementations had failed to properly sanitize
9450         // funding transactions from their counterparties, leading to a multi-implementation critical
9451         // security vulnerability (though we always sanitized properly, we've previously had
9452         // un-released crashes in the sanitization process).
9453         let chanmon_cfgs = create_chanmon_cfgs(2);
9454         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9455         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9456         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9457
9458         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9459         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()));
9460         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()));
9461
9462         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9463         for output in tx.output.iter_mut() {
9464                 // Make the confirmed funding transaction have a bogus script_pubkey
9465                 output.script_pubkey = bitcoin::Script::new();
9466         }
9467
9468         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9469         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()));
9470         check_added_monitors!(nodes[1], 1);
9471
9472         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()));
9473         check_added_monitors!(nodes[0], 1);
9474
9475         let events_1 = nodes[0].node.get_and_clear_pending_events();
9476         assert_eq!(events_1.len(), 0);
9477
9478         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9479         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9480         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9481
9482         confirm_transaction_at(&nodes[1], &tx, 1);
9483         check_added_monitors!(nodes[1], 1);
9484         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9485         assert_eq!(events_2.len(), 1);
9486         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9487                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9488                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9489                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9490                 } else { panic!(); }
9491         } else { panic!(); }
9492         assert_eq!(nodes[1].node.list_channels().len(), 0);
9493 }
9494
9495 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9496         // In the first version of the chain::Confirm interface, after a refactor was made to not
9497         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9498         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9499         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9500         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9501         // spending transaction until height N+1 (or greater). This was due to the way
9502         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9503         // spending transaction at the height the input transaction was confirmed at, not whether we
9504         // should broadcast a spending transaction at the current height.
9505         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9506         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9507         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9508         // until we learned about an additional block.
9509         //
9510         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9511         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9512         let chanmon_cfgs = create_chanmon_cfgs(3);
9513         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9514         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9515         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9516         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9517
9518         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9519         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9520         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9521         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9522         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9523
9524         nodes[1].node.force_close_channel(&channel_id).unwrap();
9525         check_closed_broadcast!(nodes[1], true);
9526         check_added_monitors!(nodes[1], 1);
9527         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9528         assert_eq!(node_txn.len(), 1);
9529
9530         let conf_height = nodes[1].best_block_info().1;
9531         if !test_height_before_timelock {
9532                 connect_blocks(&nodes[1], 24 * 6);
9533         }
9534         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9535                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9536         if test_height_before_timelock {
9537                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9538                 // generate any events or broadcast any transactions
9539                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9540                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9541         } else {
9542                 // We should broadcast an HTLC transaction spending our funding transaction first
9543                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9544                 assert_eq!(spending_txn.len(), 2);
9545                 assert_eq!(spending_txn[0], node_txn[0]);
9546                 check_spends!(spending_txn[1], node_txn[0]);
9547                 // We should also generate a SpendableOutputs event with the to_self output (as its
9548                 // timelock is up).
9549                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9550                 assert_eq!(descriptor_spend_txn.len(), 1);
9551
9552                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9553                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9554                 // additional block built on top of the current chain.
9555                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9556                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9557                 expect_pending_htlcs_forwardable!(nodes[1]);
9558                 check_added_monitors!(nodes[1], 1);
9559
9560                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9561                 assert!(updates.update_add_htlcs.is_empty());
9562                 assert!(updates.update_fulfill_htlcs.is_empty());
9563                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9564                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9565                 assert!(updates.update_fee.is_none());
9566                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9567                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9568                 expect_payment_failed!(nodes[0], payment_hash, false);
9569                 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9570         }
9571 }
9572 #[test]
9573 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9574         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9575         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9576 }