_ 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::Watch;
  15 use chain::channelmonitor;
  16 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  17 use chain::transaction::OutPoint;
  18 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
  19 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  20 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  21 use ln::channel::{Channel, ChannelError};
  22 use ln::{chan_utils, onion_utils};
  23 use routing::router::{Route, RouteHop, get_route};
  24 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  25 use ln::msgs;
  26 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  27 use util::enforcing_trait_impls::EnforcingChannelKeys;
  28 use util::{byte_utils, test_utils};
  29 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  30 use util::errors::APIError;
  31 use util::ser::{Writeable, ReadableArgs};
  32 use util::config::UserConfig;
  33
  34 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  35 use bitcoin::hash_types::{Txid, BlockHash};
  36 use bitcoin::util::bip143;
  37 use bitcoin::util::address::Address;
  38 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  39 use bitcoin::blockdata::block::{Block, BlockHeader};
  40 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
  41 use bitcoin::blockdata::script::{Builder, Script};
  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 std::collections::{BTreeSet, HashMap, HashSet};
  55 use std::default::Default;
  56 use std::sync::{Arc, Mutex};
  57 use std::sync::atomic::Ordering;
  58 use std::mem;
  59
  60 use ln::functional_test_utils::*;
  61 use ln::chan_utils::CommitmentTransaction;
  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::<EnforcingChannelKeys>::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, 8_000_000);
 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) = 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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).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, 8_000_000);
 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) = 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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).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 #[test]
 401 fn test_1_conf_open() {
 402         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 403         // tests that we properly send one in that case.
 404         let mut alice_config = UserConfig::default();
 405         alice_config.own_channel_config.minimum_depth = 1;
 406         alice_config.channel_options.announced_channel = true;
 407         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 408         let mut bob_config = UserConfig::default();
 409         bob_config.own_channel_config.minimum_depth = 1;
 410         bob_config.channel_options.announced_channel = true;
 411         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 412         let chanmon_cfgs = create_chanmon_cfgs(2);
 413         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 414         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 415         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 416
 417         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 418         let block = Block {
 419                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 420                 txdata: vec![tx],
 421         };
 422         connect_block(&nodes[1], &block, 1);
 423         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()));
 424
 425         connect_block(&nodes[0], &block, 1);
 426         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 427         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 428
 429         for node in nodes {
 430                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 431                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 432                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 433         }
 434 }
 435
 436 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 437         // Previously, we had issues deserializing channels when we hadn't connected the first block
 438         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 439         // serialization round-trips and simply do steps towards opening a channel and then drop the
 440         // Node objects.
 441
 442         let chanmon_cfgs = create_chanmon_cfgs(2);
 443         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 444         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 445         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 446
 447         if steps & 0b1000_0000 != 0{
 448                 let block = Block {
 449                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 450                         txdata: vec![],
 451                 };
 452                 connect_block(&nodes[0], &block, 1);
 453                 connect_block(&nodes[1], &block, 1);
 454         }
 455
 456         if steps & 0x0f == 0 { return; }
 457         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 458         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 1 { return; }
 461         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 462         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 463
 464         if steps & 0x0f == 2 { return; }
 465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 466
 467         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 468
 469         if steps & 0x0f == 3 { return; }
 470         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 471         check_added_monitors!(nodes[0], 0);
 472         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 473
 474         if steps & 0x0f == 4 { return; }
 475         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 476         {
 477                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 483
 484         if steps & 0x0f == 5 { return; }
 485         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 486         {
 487                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 488                 assert_eq!(added_monitors.len(), 1);
 489                 assert_eq!(added_monitors[0].0, funding_output);
 490                 added_monitors.clear();
 491         }
 492
 493         let events_4 = nodes[0].node.get_and_clear_pending_events();
 494         assert_eq!(events_4.len(), 1);
 495         match events_4[0] {
 496                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 497                         assert_eq!(user_channel_id, 42);
 498                         assert_eq!(*funding_txo, funding_output);
 499                 },
 500                 _ => panic!("Unexpected event"),
 501         };
 502
 503         if steps & 0x0f == 6 { return; }
 504         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 505
 506         if steps & 0x0f == 7 { return; }
 507         confirm_transaction(&nodes[0], &tx);
 508         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 509 }
 510
 511 #[test]
 512 fn test_sanity_on_in_flight_opens() {
 513         do_test_sanity_on_in_flight_opens(0);
 514         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(1);
 516         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(2);
 518         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(3);
 520         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(4);
 522         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(5);
 524         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(6);
 526         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 527         do_test_sanity_on_in_flight_opens(7);
 528         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 529         do_test_sanity_on_in_flight_opens(8);
 530         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 531 }
 532
 533 #[test]
 534 fn test_update_fee_vanilla() {
 535         let chanmon_cfgs = create_chanmon_cfgs(2);
 536         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 537         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 538         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 539         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 540         let channel_id = chan.2;
 541
 542         let feerate = get_feerate!(nodes[0], channel_id);
 543         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 544         check_added_monitors!(nodes[0], 1);
 545
 546         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 547         assert_eq!(events_0.len(), 1);
 548         let (update_msg, commitment_signed) = match events_0[0] {
 549                         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 } } => {
 550                         (update_fee.as_ref(), commitment_signed)
 551                 },
 552                 _ => panic!("Unexpected event"),
 553         };
 554         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 555
 556         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 557         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 558         check_added_monitors!(nodes[1], 1);
 559
 560         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 561         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 562         check_added_monitors!(nodes[0], 1);
 563
 564         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 565         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 566         // No commitment_signed so get_event_msg's assert(len == 1) passes
 567         check_added_monitors!(nodes[0], 1);
 568
 569         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 570         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 571         check_added_monitors!(nodes[1], 1);
 572 }
 573
 574 #[test]
 575 fn test_update_fee_that_funder_cannot_afford() {
 576         let chanmon_cfgs = create_chanmon_cfgs(2);
 577         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 578         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 579         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 580         let channel_value = 1888;
 581         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 582         let channel_id = chan.2;
 583
 584         let feerate = 260;
 585         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 586         check_added_monitors!(nodes[0], 1);
 587         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 588
 589         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 590
 591         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 592
 593         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 594         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 595         {
 596                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 597
 598                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 599                 let num_htlcs = commitment_tx.output.len() - 2;
 600                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 601                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 602                 actual_fee = channel_value - actual_fee;
 603                 assert_eq!(total_fee, actual_fee);
 604         }
 605
 606         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 607         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 608         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 609         check_added_monitors!(nodes[0], 1);
 610
 611         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 612
 613         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 614
 615         //While producing the commitment_signed response after handling a received update_fee request the
 616         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 617         //Should produce and error.
 618         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 619         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 620         check_added_monitors!(nodes[1], 1);
 621         check_closed_broadcast!(nodes[1], true);
 622 }
 623
 624 #[test]
 625 fn test_update_fee_with_fundee_update_add_htlc() {
 626         let chanmon_cfgs = create_chanmon_cfgs(2);
 627         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 628         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 629         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 630         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 631         let channel_id = chan.2;
 632         let logger = test_utils::TestLogger::new();
 633
 634         // balancing
 635         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 636
 637         let feerate = get_feerate!(nodes[0], channel_id);
 638         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 639         check_added_monitors!(nodes[0], 1);
 640
 641         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 642         assert_eq!(events_0.len(), 1);
 643         let (update_msg, commitment_signed) = match events_0[0] {
 644                         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 } } => {
 645                         (update_fee.as_ref(), commitment_signed)
 646                 },
 647                 _ => panic!("Unexpected event"),
 648         };
 649         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 650         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 651         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 652         check_added_monitors!(nodes[1], 1);
 653
 654         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 655         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 656         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(), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 657
 658         // nothing happens since node[1] is in AwaitingRemoteRevoke
 659         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 660         {
 661                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 662                 assert_eq!(added_monitors.len(), 0);
 663                 added_monitors.clear();
 664         }
 665         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         // node[1] has nothing to do
 668
 669         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 670         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 671         check_added_monitors!(nodes[0], 1);
 672
 673         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 674         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 675         // No commitment_signed so get_event_msg's assert(len == 1) passes
 676         check_added_monitors!(nodes[0], 1);
 677         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 678         check_added_monitors!(nodes[1], 1);
 679         // AwaitingRemoteRevoke ends here
 680
 681         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 682         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 683         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 684         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 685         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 686         assert_eq!(commitment_update.update_fee.is_none(), true);
 687
 688         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 689         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 690         check_added_monitors!(nodes[0], 1);
 691         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 692
 693         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 694         check_added_monitors!(nodes[1], 1);
 695         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 696
 697         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 698         check_added_monitors!(nodes[1], 1);
 699         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 700         // No commitment_signed so get_event_msg's assert(len == 1) passes
 701
 702         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 703         check_added_monitors!(nodes[0], 1);
 704         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 705
 706         expect_pending_htlcs_forwardable!(nodes[0]);
 707
 708         let events = nodes[0].node.get_and_clear_pending_events();
 709         assert_eq!(events.len(), 1);
 710         match events[0] {
 711                 Event::PaymentReceived { .. } => { },
 712                 _ => panic!("Unexpected event"),
 713         };
 714
 715         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 716
 717         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 718         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 719         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 720 }
 721
 722 #[test]
 723 fn test_update_fee() {
 724         let chanmon_cfgs = create_chanmon_cfgs(2);
 725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 727         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 728         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 729         let channel_id = chan.2;
 730
 731         // A                                        B
 732         // (1) update_fee/commitment_signed      ->
 733         //                                       <- (2) revoke_and_ack
 734         //                                       .- send (3) commitment_signed
 735         // (4) update_fee/commitment_signed      ->
 736         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 737         //                                       <- (3) commitment_signed delivered
 738         // send (6) revoke_and_ack               -.
 739         //                                       <- (5) deliver revoke_and_ack
 740         // (6) deliver revoke_and_ack            ->
 741         //                                       .- send (7) commitment_signed in response to (4)
 742         //                                       <- (7) deliver commitment_signed
 743         // revoke_and_ack                        ->
 744
 745         // Create and deliver (1)...
 746         let feerate = get_feerate!(nodes[0], channel_id);
 747         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 748         check_added_monitors!(nodes[0], 1);
 749
 750         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 751         assert_eq!(events_0.len(), 1);
 752         let (update_msg, commitment_signed) = match events_0[0] {
 753                         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 } } => {
 754                         (update_fee.as_ref(), commitment_signed)
 755                 },
 756                 _ => panic!("Unexpected event"),
 757         };
 758         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 759
 760         // Generate (2) and (3):
 761         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 762         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 763         check_added_monitors!(nodes[1], 1);
 764
 765         // Deliver (2):
 766         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 767         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 768         check_added_monitors!(nodes[0], 1);
 769
 770         // Create and deliver (4)...
 771         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 772         check_added_monitors!(nodes[0], 1);
 773         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 774         assert_eq!(events_0.len(), 1);
 775         let (update_msg, commitment_signed) = match events_0[0] {
 776                         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 } } => {
 777                         (update_fee.as_ref(), commitment_signed)
 778                 },
 779                 _ => panic!("Unexpected event"),
 780         };
 781
 782         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 783         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 784         check_added_monitors!(nodes[1], 1);
 785         // ... creating (5)
 786         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 787         // No commitment_signed so get_event_msg's assert(len == 1) passes
 788
 789         // Handle (3), creating (6):
 790         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 791         check_added_monitors!(nodes[0], 1);
 792         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 793         // No commitment_signed so get_event_msg's assert(len == 1) passes
 794
 795         // Deliver (5):
 796         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 797         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 798         check_added_monitors!(nodes[0], 1);
 799
 800         // Deliver (6), creating (7):
 801         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 802         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 803         assert!(commitment_update.update_add_htlcs.is_empty());
 804         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 805         assert!(commitment_update.update_fail_htlcs.is_empty());
 806         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 807         assert!(commitment_update.update_fee.is_none());
 808         check_added_monitors!(nodes[1], 1);
 809
 810         // Deliver (7)
 811         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 812         check_added_monitors!(nodes[0], 1);
 813         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 814         // No commitment_signed so get_event_msg's assert(len == 1) passes
 815
 816         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 817         check_added_monitors!(nodes[1], 1);
 818         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 819
 820         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 821         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 822         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 823 }
 824
 825 #[test]
 826 fn pre_funding_lock_shutdown_test() {
 827         // Test sending a shutdown prior to funding_locked after funding generation
 828         let chanmon_cfgs = create_chanmon_cfgs(2);
 829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 831         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 832         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 833         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 834         connect_block(&nodes[0], &Block { header, txdata: vec![tx.clone()]}, 1);
 835         connect_block(&nodes[1], &Block { header, txdata: vec![tx.clone()]}, 1);
 836
 837         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 838         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 840         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 842
 843         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 844         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 845         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 846         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 847         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 848         assert!(node_0_none.is_none());
 849
 850         assert!(nodes[0].node.list_channels().is_empty());
 851         assert!(nodes[1].node.list_channels().is_empty());
 852 }
 853
 854 #[test]
 855 fn updates_shutdown_wait() {
 856         // Test sending a shutdown with outstanding updates pending
 857         let chanmon_cfgs = create_chanmon_cfgs(3);
 858         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 859         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 860         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 861         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 862         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 863         let logger = test_utils::TestLogger::new();
 864
 865         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 866
 867         nodes[0].node.close_channel(&chan_1.2).unwrap();
 868         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 869         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 870         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 871         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 872
 873         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 874         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 875
 876         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 877
 878         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 879         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 880         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 881         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 882         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 883         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 884
 885         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 886         check_added_monitors!(nodes[2], 1);
 887         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 888         assert!(updates.update_add_htlcs.is_empty());
 889         assert!(updates.update_fail_htlcs.is_empty());
 890         assert!(updates.update_fail_malformed_htlcs.is_empty());
 891         assert!(updates.update_fee.is_none());
 892         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 893         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 894         check_added_monitors!(nodes[1], 1);
 895         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 896         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 897
 898         assert!(updates_2.update_add_htlcs.is_empty());
 899         assert!(updates_2.update_fail_htlcs.is_empty());
 900         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 901         assert!(updates_2.update_fee.is_none());
 902         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 903         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 904         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 905
 906         let events = nodes[0].node.get_and_clear_pending_events();
 907         assert_eq!(events.len(), 1);
 908         match events[0] {
 909                 Event::PaymentSent { ref payment_preimage } => {
 910                         assert_eq!(our_payment_preimage, *payment_preimage);
 911                 },
 912                 _ => panic!("Unexpected event"),
 913         }
 914
 915         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 916         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 917         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 918         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 919         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 920         assert!(node_0_none.is_none());
 921
 922         assert!(nodes[0].node.list_channels().is_empty());
 923
 924         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 925         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 926         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 927         assert!(nodes[1].node.list_channels().is_empty());
 928         assert!(nodes[2].node.list_channels().is_empty());
 929 }
 930
 931 #[test]
 932 fn htlc_fail_async_shutdown() {
 933         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 934         let chanmon_cfgs = create_chanmon_cfgs(3);
 935         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 936         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 937         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 938         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 939         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 940         let logger = test_utils::TestLogger::new();
 941
 942         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 943         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 944         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 945         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 946         check_added_monitors!(nodes[0], 1);
 947         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 948         assert_eq!(updates.update_add_htlcs.len(), 1);
 949         assert!(updates.update_fulfill_htlcs.is_empty());
 950         assert!(updates.update_fail_htlcs.is_empty());
 951         assert!(updates.update_fail_malformed_htlcs.is_empty());
 952         assert!(updates.update_fee.is_none());
 953
 954         nodes[1].node.close_channel(&chan_1.2).unwrap();
 955         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 956         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 957         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 958
 959         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 960         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 961         check_added_monitors!(nodes[1], 1);
 962         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 963         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 964
 965         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 966         assert!(updates_2.update_add_htlcs.is_empty());
 967         assert!(updates_2.update_fulfill_htlcs.is_empty());
 968         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 969         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 970         assert!(updates_2.update_fee.is_none());
 971
 972         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 973         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 974
 975         expect_payment_failed!(nodes[0], our_payment_hash, false);
 976
 977         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 978         assert_eq!(msg_events.len(), 2);
 979         let node_0_closing_signed = match msg_events[0] {
 980                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 981                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 982                         (*msg).clone()
 983                 },
 984                 _ => panic!("Unexpected event"),
 985         };
 986         match msg_events[1] {
 987                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 988                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 989                 },
 990                 _ => panic!("Unexpected event"),
 991         }
 992
 993         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 994         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 995         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 996         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 997         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 998         assert!(node_0_none.is_none());
 999
1000         assert!(nodes[0].node.list_channels().is_empty());
1001
1002         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1003         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1004         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1005         assert!(nodes[1].node.list_channels().is_empty());
1006         assert!(nodes[2].node.list_channels().is_empty());
1007 }
1008
1009 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1010         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1011         // messages delivered prior to disconnect
1012         let chanmon_cfgs = create_chanmon_cfgs(3);
1013         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1014         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1015         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1016         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1017         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1018
1019         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1020
1021         nodes[1].node.close_channel(&chan_1.2).unwrap();
1022         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1023         if recv_count > 0 {
1024                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1025                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1026                 if recv_count > 1 {
1027                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1028                 }
1029         }
1030
1031         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1032         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1033
1034         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1035         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1036         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1037         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1038
1039         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1040         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1041         assert!(node_1_shutdown == node_1_2nd_shutdown);
1042
1043         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1044         let node_0_2nd_shutdown = if recv_count > 0 {
1045                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1047                 node_0_2nd_shutdown
1048         } else {
1049                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1051                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1052         };
1053         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1054
1055         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1056         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1057
1058         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1059         check_added_monitors!(nodes[2], 1);
1060         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061         assert!(updates.update_add_htlcs.is_empty());
1062         assert!(updates.update_fail_htlcs.is_empty());
1063         assert!(updates.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates.update_fee.is_none());
1065         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1066         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1067         check_added_monitors!(nodes[1], 1);
1068         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1069         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1070
1071         assert!(updates_2.update_add_htlcs.is_empty());
1072         assert!(updates_2.update_fail_htlcs.is_empty());
1073         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1074         assert!(updates_2.update_fee.is_none());
1075         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1076         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1077         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1078
1079         let events = nodes[0].node.get_and_clear_pending_events();
1080         assert_eq!(events.len(), 1);
1081         match events[0] {
1082                 Event::PaymentSent { ref payment_preimage } => {
1083                         assert_eq!(our_payment_preimage, *payment_preimage);
1084                 },
1085                 _ => panic!("Unexpected event"),
1086         }
1087
1088         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1089         if recv_count > 0 {
1090                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1091                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1092                 assert!(node_1_closing_signed.is_some());
1093         }
1094
1095         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1096         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1097
1098         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1099         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1100         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1101         if recv_count == 0 {
1102                 // If all closing_signeds weren't delivered we can just resume where we left off...
1103                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1104
1105                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1106                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1107                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1108
1109                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1110                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1111                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1112
1113                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1114                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115
1116                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1117                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1118                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1119
1120                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1121                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1122                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1123                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1124                 assert!(node_0_none.is_none());
1125         } else {
1126                 // If one node, however, received + responded with an identical closing_signed we end
1127                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1128                 // There isn't really anything better we can do simply, but in the future we might
1129                 // explore storing a set of recently-closed channels that got disconnected during
1130                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1131                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1132                 // transaction.
1133                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1134
1135                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1136                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1137                 assert_eq!(msg_events.len(), 1);
1138                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1139                         match action {
1140                                 &ErrorAction::SendErrorMessage { ref msg } => {
1141                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1142                                         assert_eq!(msg.channel_id, chan_1.2);
1143                                 },
1144                                 _ => panic!("Unexpected event!"),
1145                         }
1146                 } else { panic!("Needed SendErrorMessage close"); }
1147
1148                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1149                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1150                 // closing_signed so we do it ourselves
1151                 check_closed_broadcast!(nodes[0], false);
1152                 check_added_monitors!(nodes[0], 1);
1153         }
1154
1155         assert!(nodes[0].node.list_channels().is_empty());
1156
1157         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1158         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1159         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1160         assert!(nodes[1].node.list_channels().is_empty());
1161         assert!(nodes[2].node.list_channels().is_empty());
1162 }
1163
1164 #[test]
1165 fn test_shutdown_rebroadcast() {
1166         do_test_shutdown_rebroadcast(0);
1167         do_test_shutdown_rebroadcast(1);
1168         do_test_shutdown_rebroadcast(2);
1169 }
1170
1171 #[test]
1172 fn fake_network_test() {
1173         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1174         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1175         let chanmon_cfgs = create_chanmon_cfgs(4);
1176         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1177         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1178         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1179
1180         // Create some initial channels
1181         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1182         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1183         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1184
1185         // Rebalance the network a bit by relaying one payment through all the channels...
1186         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1187         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1188         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1189         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1190
1191         // Send some more payments
1192         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1193         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1195
1196         // Test failure packets
1197         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1198         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1199
1200         // Add a new channel that skips 3
1201         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1202
1203         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1204         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1206         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1207         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1208         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1209         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1210
1211         // Do some rebalance loop payments, simultaneously
1212         let mut hops = Vec::with_capacity(3);
1213         hops.push(RouteHop {
1214                 pubkey: nodes[2].node.get_our_node_id(),
1215                 node_features: NodeFeatures::empty(),
1216                 short_channel_id: chan_2.0.contents.short_channel_id,
1217                 channel_features: ChannelFeatures::empty(),
1218                 fee_msat: 0,
1219                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1220         });
1221         hops.push(RouteHop {
1222                 pubkey: nodes[3].node.get_our_node_id(),
1223                 node_features: NodeFeatures::empty(),
1224                 short_channel_id: chan_3.0.contents.short_channel_id,
1225                 channel_features: ChannelFeatures::empty(),
1226                 fee_msat: 0,
1227                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1228         });
1229         hops.push(RouteHop {
1230                 pubkey: nodes[1].node.get_our_node_id(),
1231                 node_features: NodeFeatures::empty(),
1232                 short_channel_id: chan_4.0.contents.short_channel_id,
1233                 channel_features: ChannelFeatures::empty(),
1234                 fee_msat: 1000000,
1235                 cltv_expiry_delta: TEST_FINAL_CLTV,
1236         });
1237         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;
1238         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;
1239         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1240
1241         let mut hops = Vec::with_capacity(3);
1242         hops.push(RouteHop {
1243                 pubkey: nodes[3].node.get_our_node_id(),
1244                 node_features: NodeFeatures::empty(),
1245                 short_channel_id: chan_4.0.contents.short_channel_id,
1246                 channel_features: ChannelFeatures::empty(),
1247                 fee_msat: 0,
1248                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1249         });
1250         hops.push(RouteHop {
1251                 pubkey: nodes[2].node.get_our_node_id(),
1252                 node_features: NodeFeatures::empty(),
1253                 short_channel_id: chan_3.0.contents.short_channel_id,
1254                 channel_features: ChannelFeatures::empty(),
1255                 fee_msat: 0,
1256                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1257         });
1258         hops.push(RouteHop {
1259                 pubkey: nodes[1].node.get_our_node_id(),
1260                 node_features: NodeFeatures::empty(),
1261                 short_channel_id: chan_2.0.contents.short_channel_id,
1262                 channel_features: ChannelFeatures::empty(),
1263                 fee_msat: 1000000,
1264                 cltv_expiry_delta: TEST_FINAL_CLTV,
1265         });
1266         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;
1267         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;
1268         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1269
1270         // Claim the rebalances...
1271         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1272         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1273
1274         // Add a duplicate new channel from 2 to 4
1275         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1276
1277         // Send some payments across both channels
1278         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1279         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1280         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1281
1282
1283         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1284         let events = nodes[0].node.get_and_clear_pending_msg_events();
1285         assert_eq!(events.len(), 0);
1286         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);
1287
1288         //TODO: Test that routes work again here as we've been notified that the channel is full
1289
1290         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1291         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1292         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1293
1294         // Close down the channels...
1295         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1296         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1297         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1298         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1299         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1300 }
1301
1302 #[test]
1303 fn holding_cell_htlc_counting() {
1304         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1305         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1306         // commitment dance rounds.
1307         let chanmon_cfgs = create_chanmon_cfgs(3);
1308         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1309         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1310         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1311         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1312         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1313         let logger = test_utils::TestLogger::new();
1314
1315         let mut payments = Vec::new();
1316         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1317                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1318                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1319                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1320                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1321                 payments.push((payment_preimage, payment_hash));
1322         }
1323         check_added_monitors!(nodes[1], 1);
1324
1325         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1326         assert_eq!(events.len(), 1);
1327         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1328         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1329
1330         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1331         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1332         // another HTLC.
1333         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1334         {
1335                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1336                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1337                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1338                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1339                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1340                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1341         }
1342
1343         // This should also be true if we try to forward a payment.
1344         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1345         {
1346                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1347                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1348                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1349                 check_added_monitors!(nodes[0], 1);
1350         }
1351
1352         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1353         assert_eq!(events.len(), 1);
1354         let payment_event = SendEvent::from_event(events.pop().unwrap());
1355         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1356
1357         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1358         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1359         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1360         // fails), the second will process the resulting failure and fail the HTLC backward.
1361         expect_pending_htlcs_forwardable!(nodes[1]);
1362         expect_pending_htlcs_forwardable!(nodes[1]);
1363         check_added_monitors!(nodes[1], 1);
1364
1365         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1366         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1367         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1368
1369         let events = nodes[0].node.get_and_clear_pending_msg_events();
1370         assert_eq!(events.len(), 1);
1371         match events[0] {
1372                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1373                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1374                 },
1375                 _ => panic!("Unexpected event"),
1376         }
1377
1378         expect_payment_failed!(nodes[0], payment_hash_2, false);
1379
1380         // Now forward all the pending HTLCs and claim them back
1381         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1382         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1383         check_added_monitors!(nodes[2], 1);
1384
1385         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1386         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1387         check_added_monitors!(nodes[1], 1);
1388         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1389
1390         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1391         check_added_monitors!(nodes[1], 1);
1392         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1393
1394         for ref update in as_updates.update_add_htlcs.iter() {
1395                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1396         }
1397         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1398         check_added_monitors!(nodes[2], 1);
1399         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1400         check_added_monitors!(nodes[2], 1);
1401         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1402
1403         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1404         check_added_monitors!(nodes[1], 1);
1405         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1406         check_added_monitors!(nodes[1], 1);
1407         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1408
1409         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1410         check_added_monitors!(nodes[2], 1);
1411
1412         expect_pending_htlcs_forwardable!(nodes[2]);
1413
1414         let events = nodes[2].node.get_and_clear_pending_events();
1415         assert_eq!(events.len(), payments.len());
1416         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1417                 match event {
1418                         &Event::PaymentReceived { ref payment_hash, .. } => {
1419                                 assert_eq!(*payment_hash, *hash);
1420                         },
1421                         _ => panic!("Unexpected event"),
1422                 };
1423         }
1424
1425         for (preimage, _) in payments.drain(..) {
1426                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1427         }
1428
1429         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1430 }
1431
1432 #[test]
1433 fn duplicate_htlc_test() {
1434         // Test that we accept duplicate payment_hash HTLCs across the network and that
1435         // claiming/failing them are all separate and don't affect each other
1436         let chanmon_cfgs = create_chanmon_cfgs(6);
1437         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1438         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1439         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1440
1441         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1442         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1443         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1444         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1445         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1446         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1447
1448         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1449
1450         *nodes[0].network_payment_count.borrow_mut() -= 1;
1451         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1452
1453         *nodes[0].network_payment_count.borrow_mut() -= 1;
1454         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1455
1456         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1457         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1458         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1459 }
1460
1461 #[test]
1462 fn test_duplicate_htlc_different_direction_onchain() {
1463         // Test that ChannelMonitor doesn't generate 2 preimage txn
1464         // when we have 2 HTLCs with same preimage that go across a node
1465         // in opposite directions.
1466         let chanmon_cfgs = create_chanmon_cfgs(2);
1467         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1468         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1469         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1470
1471         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1472         let logger = test_utils::TestLogger::new();
1473
1474         // balancing
1475         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1476
1477         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1478
1479         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1480         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(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1481         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1482
1483         // Provide preimage to node 0 by claiming payment
1484         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1485         check_added_monitors!(nodes[0], 1);
1486
1487         // Broadcast node 1 commitment txn
1488         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1489
1490         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1491         let mut has_both_htlcs = 0; // check htlcs match ones committed
1492         for outp in remote_txn[0].output.iter() {
1493                 if outp.value == 800_000 / 1000 {
1494                         has_both_htlcs += 1;
1495                 } else if outp.value == 900_000 / 1000 {
1496                         has_both_htlcs += 1;
1497                 }
1498         }
1499         assert_eq!(has_both_htlcs, 2);
1500
1501         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1502         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1503         check_added_monitors!(nodes[0], 1);
1504
1505         // Check we only broadcast 1 timeout tx
1506         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1507         let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1508         assert_eq!(claim_txn.len(), 5);
1509         check_spends!(claim_txn[2], chan_1.3);
1510         check_spends!(claim_txn[3], claim_txn[2]);
1511         assert_eq!(htlc_pair.0.input.len(), 1);
1512         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1513         check_spends!(htlc_pair.0, remote_txn[0]);
1514         assert_eq!(htlc_pair.1.input.len(), 1);
1515         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1516         check_spends!(htlc_pair.1, remote_txn[0]);
1517
1518         let events = nodes[0].node.get_and_clear_pending_msg_events();
1519         assert_eq!(events.len(), 2);
1520         for e in events {
1521                 match e {
1522                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1523                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1524                                 assert!(update_add_htlcs.is_empty());
1525                                 assert!(update_fail_htlcs.is_empty());
1526                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1527                                 assert!(update_fail_malformed_htlcs.is_empty());
1528                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1529                         },
1530                         _ => panic!("Unexpected event"),
1531                 }
1532         }
1533 }
1534
1535 #[test]
1536 fn test_basic_channel_reserve() {
1537         let chanmon_cfgs = create_chanmon_cfgs(2);
1538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1540         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1541         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1542         let logger = test_utils::TestLogger::new();
1543
1544         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1545         let channel_reserve = chan_stat.channel_reserve_msat;
1546
1547         // The 2* and +1 are for the fee spike reserve.
1548         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1549         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1550         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1551         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1553         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1554         match err {
1555                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1556                         match &fails[0] {
1557                                 &APIError::ChannelUnavailable{ref err} =>
1558                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1559                                 _ => panic!("Unexpected error variant"),
1560                         }
1561                 },
1562                 _ => panic!("Unexpected error variant"),
1563         }
1564         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1565         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1566
1567         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1568 }
1569
1570 #[test]
1571 fn test_fee_spike_violation_fails_htlc() {
1572         let chanmon_cfgs = create_chanmon_cfgs(2);
1573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1577         let logger = test_utils::TestLogger::new();
1578
1579         macro_rules! get_route_and_payment_hash {
1580                 ($recv_value: expr) => {{
1581                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1582                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1583                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1584                         (route, payment_hash, payment_preimage)
1585                 }}
1586         };
1587
1588         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1589         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1590         let secp_ctx = Secp256k1::new();
1591         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1592
1593         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1594
1595         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1596         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1597         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1598         let msg = msgs::UpdateAddHTLC {
1599                 channel_id: chan.2,
1600                 htlc_id: 0,
1601                 amount_msat: htlc_msat,
1602                 payment_hash: payment_hash,
1603                 cltv_expiry: htlc_cltv,
1604                 onion_routing_packet: onion_packet,
1605         };
1606
1607         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1608
1609         // Now manually create the commitment_signed message corresponding to the update_add
1610         // nodes[0] just sent. In the code for construction of this message, "local" refers
1611         // to the sender of the message, and "remote" refers to the receiver.
1612
1613         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1614
1615         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1616
1617         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1618         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1619         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, local_secret2) = {
1620                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1621                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622                 let chan_keys = local_chan.get_keys();
1623                 let pubkeys = chan_keys.pubkeys();
1624                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1625                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1626         };
1627         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_secret1) = {
1628                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1629                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1630                 let chan_keys = remote_chan.get_keys();
1631                 let pubkeys = chan_keys.pubkeys();
1632                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1633                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1634         };
1635
1636         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1637         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1638         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1639         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1640                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1641
1642         // Build the remote commitment transaction so we can sign it, and then later use the
1643         // signature for the commitment_signed message.
1644         let local_chan_balance = 1313;
1645
1646         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1647                 offered: false,
1648                 amount_msat: 3460001,
1649                 cltv_expiry: htlc_cltv,
1650                 payment_hash,
1651                 transaction_output_index: Some(1),
1652         };
1653
1654         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1655
1656         let res = {
1657                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1658                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1659                 let local_chan_keys = local_chan.get_keys();
1660                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1661                         commitment_number,
1662                         95000,
1663                         local_chan_balance,
1664                         commit_tx_keys.clone(),
1665                         feerate_per_kw,
1666                         &mut vec![(accepted_htlc_info, ())],
1667                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1668                 );
1669                 local_chan_keys.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1670         };
1671
1672         let commit_signed_msg = msgs::CommitmentSigned {
1673                 channel_id: chan.2,
1674                 signature: res.0,
1675                 htlc_signatures: res.1
1676         };
1677
1678         // Send the commitment_signed message to the nodes[1].
1679         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1680         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1681
1682         // Send the RAA to nodes[1].
1683         let per_commitment_secret = local_secret;
1684         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1685         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1686         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1687         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1688
1689         let events = nodes[1].node.get_and_clear_pending_msg_events();
1690         assert_eq!(events.len(), 1);
1691         // Make sure the HTLC failed in the way we expect.
1692         match events[0] {
1693                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1694                         assert_eq!(update_fail_htlcs.len(), 1);
1695                         update_fail_htlcs[0].clone()
1696                 },
1697                 _ => panic!("Unexpected event"),
1698         };
1699         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1700
1701         check_added_monitors!(nodes[1], 2);
1702 }
1703
1704 #[test]
1705 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1706         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1707         // Set the fee rate for the channel very high, to the point where the fundee
1708         // sending any amount would result in a channel reserve violation. In this test
1709         // we check that we would be prevented from sending an HTLC in this situation.
1710         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1711         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1712         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1713         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1714         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1715         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1716         let logger = test_utils::TestLogger::new();
1717
1718         macro_rules! get_route_and_payment_hash {
1719                 ($recv_value: expr) => {{
1720                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1721                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1722                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1723                         (route, payment_hash, payment_preimage)
1724                 }}
1725         };
1726
1727         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1728         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1729                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1730         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1731         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);
1732 }
1733
1734 #[test]
1735 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1736         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1737         // Set the fee rate for the channel very high, to the point where the funder
1738         // receiving 1 update_add_htlc would result in them closing the channel due
1739         // to channel reserve violation. This close could also happen if the fee went
1740         // up a more realistic amount, but many HTLCs were outstanding at the time of
1741         // the update_add_htlc.
1742         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1743         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1744         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1745         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1746         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1747         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1748         let logger = test_utils::TestLogger::new();
1749
1750         macro_rules! get_route_and_payment_hash {
1751                 ($recv_value: expr) => {{
1752                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1753                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1754                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1755                         (route, payment_hash, payment_preimage)
1756                 }}
1757         };
1758
1759         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1760         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1761         let secp_ctx = Secp256k1::new();
1762         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1763         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1764         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1765         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1766         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1767         let msg = msgs::UpdateAddHTLC {
1768                 channel_id: chan.2,
1769                 htlc_id: 1,
1770                 amount_msat: htlc_msat + 1,
1771                 payment_hash: payment_hash,
1772                 cltv_expiry: htlc_cltv,
1773                 onion_routing_packet: onion_packet,
1774         };
1775
1776         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1777         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1778         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);
1779         assert_eq!(nodes[0].node.list_channels().len(), 0);
1780         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1781         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1782         check_added_monitors!(nodes[0], 1);
1783 }
1784
1785 #[test]
1786 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1787         let chanmon_cfgs = create_chanmon_cfgs(3);
1788         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1789         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1790         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1791         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1792         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1793         let logger = test_utils::TestLogger::new();
1794
1795         macro_rules! get_route_and_payment_hash {
1796                 ($recv_value: expr) => {{
1797                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1798                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1799                         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(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1800                         (route, payment_hash, payment_preimage)
1801                 }}
1802         };
1803
1804         let feemsat = 239;
1805         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1806         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1807         let feerate = get_feerate!(nodes[0], chan.2);
1808
1809         // Add a 2* and +1 for the fee spike reserve.
1810         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1811         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;
1812         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1813
1814         // Add a pending HTLC.
1815         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1816         let payment_event_1 = {
1817                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1818                 check_added_monitors!(nodes[0], 1);
1819
1820                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1821                 assert_eq!(events.len(), 1);
1822                 SendEvent::from_event(events.remove(0))
1823         };
1824         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1825
1826         // Attempt to trigger a channel reserve violation --> payment failure.
1827         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1828         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;
1829         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1830         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1831
1832         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1833         let secp_ctx = Secp256k1::new();
1834         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1835         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1836         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1837         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1838         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1839         let msg = msgs::UpdateAddHTLC {
1840                 channel_id: chan.2,
1841                 htlc_id: 1,
1842                 amount_msat: htlc_msat + 1,
1843                 payment_hash: our_payment_hash_1,
1844                 cltv_expiry: htlc_cltv,
1845                 onion_routing_packet: onion_packet,
1846         };
1847
1848         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1849         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1850         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1851         assert_eq!(nodes[1].node.list_channels().len(), 1);
1852         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1853         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1854         check_added_monitors!(nodes[1], 1);
1855 }
1856
1857 #[test]
1858 fn test_inbound_outbound_capacity_is_not_zero() {
1859         let chanmon_cfgs = create_chanmon_cfgs(2);
1860         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1861         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1862         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1863         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1864         let channels0 = node_chanmgrs[0].list_channels();
1865         let channels1 = node_chanmgrs[1].list_channels();
1866         assert_eq!(channels0.len(), 1);
1867         assert_eq!(channels1.len(), 1);
1868
1869         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1870         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1871
1872         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1873         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1874 }
1875
1876 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1877         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1878 }
1879
1880 #[test]
1881 fn test_channel_reserve_holding_cell_htlcs() {
1882         let chanmon_cfgs = create_chanmon_cfgs(3);
1883         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1884         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1885         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1886         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1887         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1888         let logger = test_utils::TestLogger::new();
1889
1890         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1891         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1892
1893         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1894         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1895
1896         macro_rules! get_route_and_payment_hash {
1897                 ($recv_value: expr) => {{
1898                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1899                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1900                         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(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1901                         (route, payment_hash, payment_preimage)
1902                 }}
1903         };
1904
1905         macro_rules! expect_forward {
1906                 ($node: expr) => {{
1907                         let mut events = $node.node.get_and_clear_pending_msg_events();
1908                         assert_eq!(events.len(), 1);
1909                         check_added_monitors!($node, 1);
1910                         let payment_event = SendEvent::from_event(events.remove(0));
1911                         payment_event
1912                 }}
1913         }
1914
1915         let feemsat = 239; // somehow we know?
1916         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1917         let feerate = get_feerate!(nodes[0], chan_1.2);
1918
1919         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1920
1921         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1922         {
1923                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1924                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1925                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1926                         assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
1927                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1928                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1929         }
1930
1931         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1932         // nodes[0]'s wealth
1933         loop {
1934                 let amt_msat = recv_value_0 + total_fee_msat;
1935                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1936                 // Also, ensure that each payment has enough to be over the dust limit to
1937                 // ensure it'll be included in each commit tx fee calculation.
1938                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1939                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1940                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1941                         break;
1942                 }
1943                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1944
1945                 let (stat01_, stat11_, stat12_, stat22_) = (
1946                         get_channel_value_stat!(nodes[0], chan_1.2),
1947                         get_channel_value_stat!(nodes[1], chan_1.2),
1948                         get_channel_value_stat!(nodes[1], chan_2.2),
1949                         get_channel_value_stat!(nodes[2], chan_2.2),
1950                 );
1951
1952                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1953                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1954                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1955                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1956                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1957         }
1958
1959         // adding pending output.
1960         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1961         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1962         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1963         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1964         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1965         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1966         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1967         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1968         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1969         // policy.
1970         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1971         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1972         let amt_msat_1 = recv_value_1 + total_fee_msat;
1973
1974         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1975         let payment_event_1 = {
1976                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1977                 check_added_monitors!(nodes[0], 1);
1978
1979                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1980                 assert_eq!(events.len(), 1);
1981                 SendEvent::from_event(events.remove(0))
1982         };
1983         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1984
1985         // channel reserve test with htlc pending output > 0
1986         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1987         {
1988                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1989                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1990                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1991                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1992         }
1993
1994         // split the rest to test holding cell
1995         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1996         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1997         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1998         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1999         {
2000                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2001                 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
2002         }
2003
2004         // now see if they go through on both sides
2005         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2006         // but this will stuck in the holding cell
2007         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2008         check_added_monitors!(nodes[0], 0);
2009         let events = nodes[0].node.get_and_clear_pending_events();
2010         assert_eq!(events.len(), 0);
2011
2012         // test with outbound holding cell amount > 0
2013         {
2014                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2015                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2016                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2017                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2018                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
2019         }
2020
2021         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2022         // this will also stuck in the holding cell
2023         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2024         check_added_monitors!(nodes[0], 0);
2025         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2026         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2027
2028         // flush the pending htlc
2029         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2030         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2031         check_added_monitors!(nodes[1], 1);
2032
2033         // the pending htlc should be promoted to committed
2034         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2035         check_added_monitors!(nodes[0], 1);
2036         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2037
2038         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2039         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2040         // No commitment_signed so get_event_msg's assert(len == 1) passes
2041         check_added_monitors!(nodes[0], 1);
2042
2043         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2044         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2045         check_added_monitors!(nodes[1], 1);
2046
2047         expect_pending_htlcs_forwardable!(nodes[1]);
2048
2049         let ref payment_event_11 = expect_forward!(nodes[1]);
2050         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2051         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2052
2053         expect_pending_htlcs_forwardable!(nodes[2]);
2054         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2055
2056         // flush the htlcs in the holding cell
2057         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2058         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2059         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2060         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2061         expect_pending_htlcs_forwardable!(nodes[1]);
2062
2063         let ref payment_event_3 = expect_forward!(nodes[1]);
2064         assert_eq!(payment_event_3.msgs.len(), 2);
2065         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2066         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2067
2068         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2069         expect_pending_htlcs_forwardable!(nodes[2]);
2070
2071         let events = nodes[2].node.get_and_clear_pending_events();
2072         assert_eq!(events.len(), 2);
2073         match events[0] {
2074                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2075                         assert_eq!(our_payment_hash_21, *payment_hash);
2076                         assert_eq!(*payment_secret, None);
2077                         assert_eq!(recv_value_21, amt);
2078                 },
2079                 _ => panic!("Unexpected event"),
2080         }
2081         match events[1] {
2082                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2083                         assert_eq!(our_payment_hash_22, *payment_hash);
2084                         assert_eq!(None, *payment_secret);
2085                         assert_eq!(recv_value_22, amt);
2086                 },
2087                 _ => panic!("Unexpected event"),
2088         }
2089
2090         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2091         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2092         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2093
2094         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2095         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2096         {
2097                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2098                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2099                 match err {
2100                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2101                                 match &fails[0] {
2102                                         &APIError::ChannelUnavailable{ref err} =>
2103                                                 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
2104                                         _ => panic!("Unexpected error variant"),
2105                                 }
2106                         },
2107                         _ => panic!("Unexpected error variant"),
2108                 }
2109                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2110                 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(), 3);
2111         }
2112
2113         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2114
2115         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2116         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);
2117         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2118         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2119         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2120
2121         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2122         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2123 }
2124
2125 #[test]
2126 fn channel_reserve_in_flight_removes() {
2127         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2128         // can send to its counterparty, but due to update ordering, the other side may not yet have
2129         // considered those HTLCs fully removed.
2130         // This tests that we don't count HTLCs which will not be included in the next remote
2131         // commitment transaction towards the reserve value (as it implies no commitment transaction
2132         // will be generated which violates the remote reserve value).
2133         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2134         // To test this we:
2135         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2136         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2137         //    you only consider the value of the first HTLC, it may not),
2138         //  * start routing a third HTLC from A to B,
2139         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2140         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2141         //  * deliver the first fulfill from B
2142         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2143         //    claim,
2144         //  * deliver A's response CS and RAA.
2145         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2146         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2147         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2148         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2149         let chanmon_cfgs = create_chanmon_cfgs(2);
2150         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2151         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2152         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2153         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2154         let logger = test_utils::TestLogger::new();
2155
2156         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2157         // Route the first two HTLCs.
2158         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2159         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2160
2161         // Start routing the third HTLC (this is just used to get everyone in the right state).
2162         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2163         let send_1 = {
2164                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2165                 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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2166                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2167                 check_added_monitors!(nodes[0], 1);
2168                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2169                 assert_eq!(events.len(), 1);
2170                 SendEvent::from_event(events.remove(0))
2171         };
2172
2173         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2174         // initial fulfill/CS.
2175         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2176         check_added_monitors!(nodes[1], 1);
2177         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2178
2179         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2180         // remove the second HTLC when we send the HTLC back from B to A.
2181         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2182         check_added_monitors!(nodes[1], 1);
2183         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2184
2185         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2186         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2187         check_added_monitors!(nodes[0], 1);
2188         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2189         expect_payment_sent!(nodes[0], payment_preimage_1);
2190
2191         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2192         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2193         check_added_monitors!(nodes[1], 1);
2194         // B is already AwaitingRAA, so cant generate a CS here
2195         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2196
2197         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2198         check_added_monitors!(nodes[1], 1);
2199         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2200
2201         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2202         check_added_monitors!(nodes[0], 1);
2203         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2204
2205         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2206         check_added_monitors!(nodes[1], 1);
2207         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2208
2209         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2210         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2211         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2212         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2213         // on-chain as necessary).
2214         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2215         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2216         check_added_monitors!(nodes[0], 1);
2217         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2218         expect_payment_sent!(nodes[0], payment_preimage_2);
2219
2220         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2221         check_added_monitors!(nodes[1], 1);
2222         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2223
2224         expect_pending_htlcs_forwardable!(nodes[1]);
2225         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2226
2227         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2228         // resolve the second HTLC from A's point of view.
2229         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2230         check_added_monitors!(nodes[0], 1);
2231         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2232
2233         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2234         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2235         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2236         let send_2 = {
2237                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2238                 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(), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2239                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2240                 check_added_monitors!(nodes[1], 1);
2241                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2242                 assert_eq!(events.len(), 1);
2243                 SendEvent::from_event(events.remove(0))
2244         };
2245
2246         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2247         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2248         check_added_monitors!(nodes[0], 1);
2249         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2250
2251         // Now just resolve all the outstanding messages/HTLCs for completeness...
2252
2253         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2254         check_added_monitors!(nodes[1], 1);
2255         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2256
2257         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2258         check_added_monitors!(nodes[1], 1);
2259
2260         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2261         check_added_monitors!(nodes[0], 1);
2262         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2263
2264         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2265         check_added_monitors!(nodes[1], 1);
2266         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2267
2268         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2269         check_added_monitors!(nodes[0], 1);
2270
2271         expect_pending_htlcs_forwardable!(nodes[0]);
2272         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2273
2274         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2275         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2276 }
2277
2278 #[test]
2279 fn channel_monitor_network_test() {
2280         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2281         // tests that ChannelMonitor is able to recover from various states.
2282         let chanmon_cfgs = create_chanmon_cfgs(5);
2283         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2284         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2285         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2286
2287         // Create some initial channels
2288         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2289         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2290         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2291         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2292
2293         // Rebalance the network a bit by relaying one payment through all the channels...
2294         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2295         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2296         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2297         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2298
2299         // Simple case with no pending HTLCs:
2300         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2301         check_added_monitors!(nodes[1], 1);
2302         {
2303                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2304                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2305                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2306                 check_added_monitors!(nodes[0], 1);
2307                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2308         }
2309         get_announce_close_broadcast_events(&nodes, 0, 1);
2310         assert_eq!(nodes[0].node.list_channels().len(), 0);
2311         assert_eq!(nodes[1].node.list_channels().len(), 1);
2312
2313         // One pending HTLC is discarded by the force-close:
2314         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2315
2316         // Simple case of one pending HTLC to HTLC-Timeout
2317         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2318         check_added_monitors!(nodes[1], 1);
2319         {
2320                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2321                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2322                 connect_block(&nodes[2], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2323                 check_added_monitors!(nodes[2], 1);
2324                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2325         }
2326         get_announce_close_broadcast_events(&nodes, 1, 2);
2327         assert_eq!(nodes[1].node.list_channels().len(), 0);
2328         assert_eq!(nodes[2].node.list_channels().len(), 1);
2329
2330         macro_rules! claim_funds {
2331                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2332                         {
2333                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2334                                 check_added_monitors!($node, 1);
2335
2336                                 let events = $node.node.get_and_clear_pending_msg_events();
2337                                 assert_eq!(events.len(), 1);
2338                                 match events[0] {
2339                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2340                                                 assert!(update_add_htlcs.is_empty());
2341                                                 assert!(update_fail_htlcs.is_empty());
2342                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2343                                         },
2344                                         _ => panic!("Unexpected event"),
2345                                 };
2346                         }
2347                 }
2348         }
2349
2350         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2351         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2352         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2353         check_added_monitors!(nodes[2], 1);
2354         let node2_commitment_txid;
2355         {
2356                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2357                 node2_commitment_txid = node_txn[0].txid();
2358
2359                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2360                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2361
2362                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2363                 connect_block(&nodes[3], &Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2364                 check_added_monitors!(nodes[3], 1);
2365
2366                 check_preimage_claim(&nodes[3], &node_txn);
2367         }
2368         get_announce_close_broadcast_events(&nodes, 2, 3);
2369         assert_eq!(nodes[2].node.list_channels().len(), 0);
2370         assert_eq!(nodes[3].node.list_channels().len(), 1);
2371
2372         { // Cheat and reset nodes[4]'s height to 1
2373                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2374                 connect_block(&nodes[4], &Block { header, txdata: vec![] }, 1);
2375         }
2376
2377         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2378         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2379         // One pending HTLC to time out:
2380         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2381         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2382         // buffer space).
2383
2384         let (close_chan_update_1, close_chan_update_2) = {
2385                 let mut block = Block {
2386                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2387                         txdata: vec![],
2388                 };
2389                 connect_block(&nodes[3], &block, 2);
2390                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2391                         block = Block {
2392                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2393                                 txdata: vec![],
2394                         };
2395                         connect_block(&nodes[3], &block, i);
2396                 }
2397                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2398                 assert_eq!(events.len(), 1);
2399                 let close_chan_update_1 = match events[0] {
2400                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2401                                 msg.clone()
2402                         },
2403                         _ => panic!("Unexpected event"),
2404                 };
2405                 check_added_monitors!(nodes[3], 1);
2406
2407                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2408                 {
2409                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2410                         node_txn.retain(|tx| {
2411                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2412                                         false
2413                                 } else { true }
2414                         });
2415                 }
2416
2417                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2418
2419                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2420                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2421
2422                 block = Block {
2423                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2424                         txdata: vec![],
2425                 };
2426
2427                 connect_block(&nodes[4], &block, 2);
2428                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2429                         block = Block {
2430                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2431                                 txdata: vec![],
2432                         };
2433                         connect_block(&nodes[4], &block, i);
2434                 }
2435                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2436                 assert_eq!(events.len(), 1);
2437                 let close_chan_update_2 = match events[0] {
2438                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2439                                 msg.clone()
2440                         },
2441                         _ => panic!("Unexpected event"),
2442                 };
2443                 check_added_monitors!(nodes[4], 1);
2444                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2445
2446                 block = Block {
2447                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2448                         txdata: vec![node_txn[0].clone()],
2449                 };
2450                 connect_block(&nodes[4], &block, TEST_FINAL_CLTV - 5);
2451
2452                 check_preimage_claim(&nodes[4], &node_txn);
2453                 (close_chan_update_1, close_chan_update_2)
2454         };
2455         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2456         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2457         assert_eq!(nodes[3].node.list_channels().len(), 0);
2458         assert_eq!(nodes[4].node.list_channels().len(), 0);
2459 }
2460
2461 #[test]
2462 fn test_justice_tx() {
2463         // Test justice txn built on revoked HTLC-Success tx, against both sides
2464         let mut alice_config = UserConfig::default();
2465         alice_config.channel_options.announced_channel = true;
2466         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2467         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2468         let mut bob_config = UserConfig::default();
2469         bob_config.channel_options.announced_channel = true;
2470         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2471         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2472         let user_cfgs = [Some(alice_config), Some(bob_config)];
2473         let chanmon_cfgs = create_chanmon_cfgs(2);
2474         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2475         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2476         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2477         // Create some new channels:
2478         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2479
2480         // A pending HTLC which will be revoked:
2481         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2482         // Get the will-be-revoked local txn from nodes[0]
2483         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2484         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2485         assert_eq!(revoked_local_txn[0].input.len(), 1);
2486         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2487         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2488         assert_eq!(revoked_local_txn[1].input.len(), 1);
2489         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2490         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2491         // Revoke the old state
2492         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2493
2494         {
2495                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2496                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2497                 {
2498                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2499                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2500                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2501
2502                         check_spends!(node_txn[0], revoked_local_txn[0]);
2503                         node_txn.swap_remove(0);
2504                         node_txn.truncate(1);
2505                 }
2506                 check_added_monitors!(nodes[1], 1);
2507                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2508
2509                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2510                 // Verify broadcast of revoked HTLC-timeout
2511                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2512                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2513                 check_added_monitors!(nodes[0], 1);
2514                 // Broadcast revoked HTLC-timeout on node 1
2515                 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2516                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2517         }
2518         get_announce_close_broadcast_events(&nodes, 0, 1);
2519
2520         assert_eq!(nodes[0].node.list_channels().len(), 0);
2521         assert_eq!(nodes[1].node.list_channels().len(), 0);
2522
2523         // We test justice_tx build by A on B's revoked HTLC-Success tx
2524         // Create some new channels:
2525         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2526         {
2527                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2528                 node_txn.clear();
2529         }
2530
2531         // A pending HTLC which will be revoked:
2532         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2533         // Get the will-be-revoked local txn from B
2534         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2535         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2536         assert_eq!(revoked_local_txn[0].input.len(), 1);
2537         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2538         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2539         // Revoke the old state
2540         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2541         {
2542                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2543                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2544                 {
2545                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2546                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2547                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2548
2549                         check_spends!(node_txn[0], revoked_local_txn[0]);
2550                         node_txn.swap_remove(0);
2551                 }
2552                 check_added_monitors!(nodes[0], 1);
2553                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2554
2555                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2556                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2557                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2558                 check_added_monitors!(nodes[1], 1);
2559                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2560                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2561         }
2562         get_announce_close_broadcast_events(&nodes, 0, 1);
2563         assert_eq!(nodes[0].node.list_channels().len(), 0);
2564         assert_eq!(nodes[1].node.list_channels().len(), 0);
2565 }
2566
2567 #[test]
2568 fn revoked_output_claim() {
2569         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2570         // transaction is broadcast by its counterparty
2571         let chanmon_cfgs = create_chanmon_cfgs(2);
2572         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2573         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2574         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2575         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2576         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2577         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2578         assert_eq!(revoked_local_txn.len(), 1);
2579         // Only output is the full channel value back to nodes[0]:
2580         assert_eq!(revoked_local_txn[0].output.len(), 1);
2581         // Send a payment through, updating everyone's latest commitment txn
2582         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2583
2584         // Inform nodes[1] that nodes[0] broadcast a stale tx
2585         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2586         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2587         check_added_monitors!(nodes[1], 1);
2588         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2589         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2590
2591         check_spends!(node_txn[0], revoked_local_txn[0]);
2592         check_spends!(node_txn[1], chan_1.3);
2593
2594         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2595         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2596         get_announce_close_broadcast_events(&nodes, 0, 1);
2597         check_added_monitors!(nodes[0], 1)
2598 }
2599
2600 #[test]
2601 fn claim_htlc_outputs_shared_tx() {
2602         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2603         let chanmon_cfgs = create_chanmon_cfgs(2);
2604         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2605         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2606         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2607
2608         // Create some new channel:
2609         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2610
2611         // Rebalance the network to generate htlc in the two directions
2612         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2613         // 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
2614         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2615         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2616
2617         // Get the will-be-revoked local txn from node[0]
2618         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2619         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2620         assert_eq!(revoked_local_txn[0].input.len(), 1);
2621         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2622         assert_eq!(revoked_local_txn[1].input.len(), 1);
2623         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2624         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2625         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2626
2627         //Revoke the old state
2628         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2629
2630         {
2631                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2632                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2633                 check_added_monitors!(nodes[0], 1);
2634                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2635                 check_added_monitors!(nodes[1], 1);
2636                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
2637                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2638
2639                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2640                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2641
2642                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2643                 check_spends!(node_txn[0], revoked_local_txn[0]);
2644
2645                 let mut witness_lens = BTreeSet::new();
2646                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2647                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2648                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2649                 assert_eq!(witness_lens.len(), 3);
2650                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2651                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2652                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2653
2654                 // Next nodes[1] broadcasts its current local tx state:
2655                 assert_eq!(node_txn[1].input.len(), 1);
2656                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2657
2658                 assert_eq!(node_txn[2].input.len(), 1);
2659                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2660                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2661                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2662                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2663                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2664         }
2665         get_announce_close_broadcast_events(&nodes, 0, 1);
2666         assert_eq!(nodes[0].node.list_channels().len(), 0);
2667         assert_eq!(nodes[1].node.list_channels().len(), 0);
2668 }
2669
2670 #[test]
2671 fn claim_htlc_outputs_single_tx() {
2672         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2673         let chanmon_cfgs = create_chanmon_cfgs(2);
2674         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2675         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2676         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2677
2678         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2679
2680         // Rebalance the network to generate htlc in the two directions
2681         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2682         // 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
2683         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2684         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2685         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2686
2687         // Get the will-be-revoked local txn from node[0]
2688         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2689
2690         //Revoke the old state
2691         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2692
2693         {
2694                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2695                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2696                 check_added_monitors!(nodes[0], 1);
2697                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2698                 check_added_monitors!(nodes[1], 1);
2699                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2700
2701                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
2702                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2703
2704                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2705                 assert_eq!(node_txn.len(), 9);
2706                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2707                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2708                 // 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)
2709                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2710
2711                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2712                 assert_eq!(node_txn[2].input.len(), 1);
2713                 check_spends!(node_txn[2], chan_1.3);
2714                 assert_eq!(node_txn[3].input.len(), 1);
2715                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2716                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2717                 check_spends!(node_txn[3], node_txn[2]);
2718
2719                 // Justice transactions are indices 1-2-4
2720                 assert_eq!(node_txn[0].input.len(), 1);
2721                 assert_eq!(node_txn[1].input.len(), 1);
2722                 assert_eq!(node_txn[4].input.len(), 1);
2723
2724                 check_spends!(node_txn[0], revoked_local_txn[0]);
2725                 check_spends!(node_txn[1], revoked_local_txn[0]);
2726                 check_spends!(node_txn[4], revoked_local_txn[0]);
2727
2728                 let mut witness_lens = BTreeSet::new();
2729                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2730                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2731                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2732                 assert_eq!(witness_lens.len(), 3);
2733                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2734                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2735                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2736         }
2737         get_announce_close_broadcast_events(&nodes, 0, 1);
2738         assert_eq!(nodes[0].node.list_channels().len(), 0);
2739         assert_eq!(nodes[1].node.list_channels().len(), 0);
2740 }
2741
2742 #[test]
2743 fn test_htlc_on_chain_success() {
2744         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2745         // the preimage backward accordingly. So here we test that ChannelManager is
2746         // broadcasting the right event to other nodes in payment path.
2747         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2748         // A --------------------> B ----------------------> C (preimage)
2749         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2750         // commitment transaction was broadcast.
2751         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2752         // towards B.
2753         // B should be able to claim via preimage if A then broadcasts its local tx.
2754         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2755         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2756         // PaymentSent event).
2757
2758         let chanmon_cfgs = create_chanmon_cfgs(3);
2759         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2760         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2761         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2762
2763         // Create some initial channels
2764         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2765         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2766
2767         // Rebalance the network a bit by relaying one payment through all the channels...
2768         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2769         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2770
2771         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2772         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2773         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2774
2775         // Broadcast legit commitment tx from C on B's chain
2776         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2777         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2778         assert_eq!(commitment_tx.len(), 1);
2779         check_spends!(commitment_tx[0], chan_2.3);
2780         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2781         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2782         check_added_monitors!(nodes[2], 2);
2783         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2784         assert!(updates.update_add_htlcs.is_empty());
2785         assert!(updates.update_fail_htlcs.is_empty());
2786         assert!(updates.update_fail_malformed_htlcs.is_empty());
2787         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2788
2789         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2790         check_closed_broadcast!(nodes[2], false);
2791         check_added_monitors!(nodes[2], 1);
2792         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)
2793         assert_eq!(node_txn.len(), 5);
2794         assert_eq!(node_txn[0], node_txn[3]);
2795         assert_eq!(node_txn[1], node_txn[4]);
2796         assert_eq!(node_txn[2], commitment_tx[0]);
2797         check_spends!(node_txn[0], commitment_tx[0]);
2798         check_spends!(node_txn[1], commitment_tx[0]);
2799         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2800         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2801         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2802         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2803         assert_eq!(node_txn[0].lock_time, 0);
2804         assert_eq!(node_txn[1].lock_time, 0);
2805
2806         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2807         connect_block(&nodes[1], &Block { header, txdata: node_txn}, 1);
2808         {
2809                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2810                 assert_eq!(added_monitors.len(), 1);
2811                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2812                 added_monitors.clear();
2813         }
2814         let events = nodes[1].node.get_and_clear_pending_msg_events();
2815         {
2816                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2817                 assert_eq!(added_monitors.len(), 2);
2818                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2819                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2820                 added_monitors.clear();
2821         }
2822         assert_eq!(events.len(), 2);
2823         match events[0] {
2824                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2825                 _ => panic!("Unexpected event"),
2826         }
2827         match events[1] {
2828                 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, .. } } => {
2829                         assert!(update_add_htlcs.is_empty());
2830                         assert!(update_fail_htlcs.is_empty());
2831                         assert_eq!(update_fulfill_htlcs.len(), 1);
2832                         assert!(update_fail_malformed_htlcs.is_empty());
2833                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2834                 },
2835                 _ => panic!("Unexpected event"),
2836         };
2837         macro_rules! check_tx_local_broadcast {
2838                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2839                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2840                         assert_eq!(node_txn.len(), 5);
2841                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2842                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2843                         check_spends!(node_txn[0], $commitment_tx);
2844                         check_spends!(node_txn[1], $commitment_tx);
2845                         assert_ne!(node_txn[0].lock_time, 0);
2846                         assert_ne!(node_txn[1].lock_time, 0);
2847                         if $htlc_offered {
2848                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2849                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2850                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2851                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2852                         } else {
2853                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2854                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2855                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2856                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2857                         }
2858                         check_spends!(node_txn[2], $chan_tx);
2859                         check_spends!(node_txn[3], node_txn[2]);
2860                         check_spends!(node_txn[4], node_txn[2]);
2861                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2862                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2863                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2864                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2865                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2866                         assert_ne!(node_txn[3].lock_time, 0);
2867                         assert_ne!(node_txn[4].lock_time, 0);
2868                         node_txn.clear();
2869                 } }
2870         }
2871         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2872         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2873         // timeout-claim of the output that nodes[2] just claimed via success.
2874         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2875
2876         // Broadcast legit commitment tx from A on B's chain
2877         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2878         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2879         check_spends!(commitment_tx[0], chan_1.3);
2880         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2881         check_closed_broadcast!(nodes[1], false);
2882         check_added_monitors!(nodes[1], 1);
2883         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2884         assert_eq!(node_txn.len(), 4);
2885         check_spends!(node_txn[0], commitment_tx[0]);
2886         assert_eq!(node_txn[0].input.len(), 2);
2887         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2888         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2889         assert_eq!(node_txn[0].lock_time, 0);
2890         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2891         check_spends!(node_txn[1], chan_1.3);
2892         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2893         check_spends!(node_txn[2], node_txn[1]);
2894         check_spends!(node_txn[3], node_txn[1]);
2895         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2896         // we already checked the same situation with A.
2897
2898         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2899         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2900         check_closed_broadcast!(nodes[0], false);
2901         check_added_monitors!(nodes[0], 1);
2902         let events = nodes[0].node.get_and_clear_pending_events();
2903         assert_eq!(events.len(), 2);
2904         let mut first_claimed = false;
2905         for event in events {
2906                 match event {
2907                         Event::PaymentSent { payment_preimage } => {
2908                                 if payment_preimage == our_payment_preimage {
2909                                         assert!(!first_claimed);
2910                                         first_claimed = true;
2911                                 } else {
2912                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2913                                 }
2914                         },
2915                         _ => panic!("Unexpected event"),
2916                 }
2917         }
2918         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2919 }
2920
2921 #[test]
2922 fn test_htlc_on_chain_timeout() {
2923         // Test that in case of a unilateral close onchain, we detect the state of output and
2924         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2925         // broadcasting the right event to other nodes in payment path.
2926         // A ------------------> B ----------------------> C (timeout)
2927         //    B's commitment tx                 C's commitment tx
2928         //            \                                  \
2929         //         B's HTLC timeout tx               B's timeout tx
2930
2931         let chanmon_cfgs = create_chanmon_cfgs(3);
2932         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2933         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2934         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2935
2936         // Create some intial channels
2937         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2938         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2939
2940         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2941         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2942         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2943
2944         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2945         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2946
2947         // Broadcast legit commitment tx from C on B's chain
2948         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2949         check_spends!(commitment_tx[0], chan_2.3);
2950         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2951         check_added_monitors!(nodes[2], 0);
2952         expect_pending_htlcs_forwardable!(nodes[2]);
2953         check_added_monitors!(nodes[2], 1);
2954
2955         let events = nodes[2].node.get_and_clear_pending_msg_events();
2956         assert_eq!(events.len(), 1);
2957         match events[0] {
2958                 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, .. } } => {
2959                         assert!(update_add_htlcs.is_empty());
2960                         assert!(!update_fail_htlcs.is_empty());
2961                         assert!(update_fulfill_htlcs.is_empty());
2962                         assert!(update_fail_malformed_htlcs.is_empty());
2963                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2964                 },
2965                 _ => panic!("Unexpected event"),
2966         };
2967         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2968         check_closed_broadcast!(nodes[2], false);
2969         check_added_monitors!(nodes[2], 1);
2970         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2971         assert_eq!(node_txn.len(), 1);
2972         check_spends!(node_txn[0], chan_2.3);
2973         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2974
2975         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2976         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2977         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2978         let timeout_tx;
2979         {
2980                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2981                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2982                 assert_eq!(node_txn[1], node_txn[3]);
2983                 assert_eq!(node_txn[2], node_txn[4]);
2984
2985                 check_spends!(node_txn[0], commitment_tx[0]);
2986                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2987
2988                 check_spends!(node_txn[1], chan_2.3);
2989                 check_spends!(node_txn[2], node_txn[1]);
2990                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2991                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2992
2993                 timeout_tx = node_txn[0].clone();
2994                 node_txn.clear();
2995         }
2996
2997         connect_block(&nodes[1], &Block { header, txdata: vec![timeout_tx]}, 1);
2998         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
2999         check_added_monitors!(nodes[1], 1);
3000         check_closed_broadcast!(nodes[1], false);
3001
3002         expect_pending_htlcs_forwardable!(nodes[1]);
3003         check_added_monitors!(nodes[1], 1);
3004         let events = nodes[1].node.get_and_clear_pending_msg_events();
3005         assert_eq!(events.len(), 1);
3006         match events[0] {
3007                 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, .. } } => {
3008                         assert!(update_add_htlcs.is_empty());
3009                         assert!(!update_fail_htlcs.is_empty());
3010                         assert!(update_fulfill_htlcs.is_empty());
3011                         assert!(update_fail_malformed_htlcs.is_empty());
3012                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3013                 },
3014                 _ => panic!("Unexpected event"),
3015         };
3016         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
3017         assert_eq!(node_txn.len(), 0);
3018
3019         // Broadcast legit commitment tx from B on A's chain
3020         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3021         check_spends!(commitment_tx[0], chan_1.3);
3022
3023         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3024         check_closed_broadcast!(nodes[0], false);
3025         check_added_monitors!(nodes[0], 1);
3026         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3027         assert_eq!(node_txn.len(), 3);
3028         check_spends!(node_txn[0], commitment_tx[0]);
3029         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3030         check_spends!(node_txn[1], chan_1.3);
3031         check_spends!(node_txn[2], node_txn[1]);
3032         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3033         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3034 }
3035
3036 #[test]
3037 fn test_simple_commitment_revoked_fail_backward() {
3038         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3039         // and fail backward accordingly.
3040
3041         let chanmon_cfgs = create_chanmon_cfgs(3);
3042         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3043         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3044         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3045
3046         // Create some initial channels
3047         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3048         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3049
3050         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3051         // Get the will-be-revoked local txn from nodes[2]
3052         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3053         // Revoke the old state
3054         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3055
3056         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3057
3058         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3059         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3060         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3061         check_added_monitors!(nodes[1], 1);
3062         check_closed_broadcast!(nodes[1], false);
3063
3064         expect_pending_htlcs_forwardable!(nodes[1]);
3065         check_added_monitors!(nodes[1], 1);
3066         let events = nodes[1].node.get_and_clear_pending_msg_events();
3067         assert_eq!(events.len(), 1);
3068         match events[0] {
3069                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3070                         assert!(update_add_htlcs.is_empty());
3071                         assert_eq!(update_fail_htlcs.len(), 1);
3072                         assert!(update_fulfill_htlcs.is_empty());
3073                         assert!(update_fail_malformed_htlcs.is_empty());
3074                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3075
3076                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3077                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3078
3079                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3080                         assert_eq!(events.len(), 1);
3081                         match events[0] {
3082                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3083                                 _ => panic!("Unexpected event"),
3084                         }
3085                         expect_payment_failed!(nodes[0], payment_hash, false);
3086                 },
3087                 _ => panic!("Unexpected event"),
3088         }
3089 }
3090
3091 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3092         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3093         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3094         // commitment transaction anymore.
3095         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3096         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3097         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3098         // technically disallowed and we should probably handle it reasonably.
3099         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3100         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3101         // transactions:
3102         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3103         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3104         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3105         //   and once they revoke the previous commitment transaction (allowing us to send a new
3106         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3107         let chanmon_cfgs = create_chanmon_cfgs(3);
3108         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3109         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3110         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3111
3112         // Create some initial channels
3113         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3114         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3115
3116         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3117         // Get the will-be-revoked local txn from nodes[2]
3118         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3119         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3120         // Revoke the old state
3121         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3122
3123         let value = if use_dust {
3124                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3125                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3126                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3127         } else { 3000000 };
3128
3129         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3130         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3131         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3132
3133         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3134         expect_pending_htlcs_forwardable!(nodes[2]);
3135         check_added_monitors!(nodes[2], 1);
3136         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3137         assert!(updates.update_add_htlcs.is_empty());
3138         assert!(updates.update_fulfill_htlcs.is_empty());
3139         assert!(updates.update_fail_malformed_htlcs.is_empty());
3140         assert_eq!(updates.update_fail_htlcs.len(), 1);
3141         assert!(updates.update_fee.is_none());
3142         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3143         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3144         // Drop the last RAA from 3 -> 2
3145
3146         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3147         expect_pending_htlcs_forwardable!(nodes[2]);
3148         check_added_monitors!(nodes[2], 1);
3149         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3150         assert!(updates.update_add_htlcs.is_empty());
3151         assert!(updates.update_fulfill_htlcs.is_empty());
3152         assert!(updates.update_fail_malformed_htlcs.is_empty());
3153         assert_eq!(updates.update_fail_htlcs.len(), 1);
3154         assert!(updates.update_fee.is_none());
3155         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3156         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3157         check_added_monitors!(nodes[1], 1);
3158         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3159         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3160         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3161         check_added_monitors!(nodes[2], 1);
3162
3163         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3164         expect_pending_htlcs_forwardable!(nodes[2]);
3165         check_added_monitors!(nodes[2], 1);
3166         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3167         assert!(updates.update_add_htlcs.is_empty());
3168         assert!(updates.update_fulfill_htlcs.is_empty());
3169         assert!(updates.update_fail_malformed_htlcs.is_empty());
3170         assert_eq!(updates.update_fail_htlcs.len(), 1);
3171         assert!(updates.update_fee.is_none());
3172         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3173         // At this point first_payment_hash has dropped out of the latest two commitment
3174         // transactions that nodes[1] is tracking...
3175         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3176         check_added_monitors!(nodes[1], 1);
3177         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3178         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3179         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3180         check_added_monitors!(nodes[2], 1);
3181
3182         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3183         // on nodes[2]'s RAA.
3184         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3185         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3186         let logger = test_utils::TestLogger::new();
3187         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3188         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3189         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3190         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3191         check_added_monitors!(nodes[1], 0);
3192
3193         if deliver_bs_raa {
3194                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3195                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3196                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3197                 check_added_monitors!(nodes[1], 1);
3198                 let events = nodes[1].node.get_and_clear_pending_events();
3199                 assert_eq!(events.len(), 1);
3200                 match events[0] {
3201                         Event::PendingHTLCsForwardable { .. } => { },
3202                         _ => panic!("Unexpected event"),
3203                 };
3204                 // Deliberately don't process the pending fail-back so they all fail back at once after
3205                 // block connection just like the !deliver_bs_raa case
3206         }
3207
3208         let mut failed_htlcs = HashSet::new();
3209         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3210
3211         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3212         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3213         check_added_monitors!(nodes[1], 1);
3214         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3215
3216         let events = nodes[1].node.get_and_clear_pending_events();
3217         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3218         match events[0] {
3219                 Event::PaymentFailed { ref payment_hash, .. } => {
3220                         assert_eq!(*payment_hash, fourth_payment_hash);
3221                 },
3222                 _ => panic!("Unexpected event"),
3223         }
3224         if !deliver_bs_raa {
3225                 match events[1] {
3226                         Event::PendingHTLCsForwardable { .. } => { },
3227                         _ => panic!("Unexpected event"),
3228                 };
3229         }
3230         nodes[1].node.process_pending_htlc_forwards();
3231         check_added_monitors!(nodes[1], 1);
3232
3233         let events = nodes[1].node.get_and_clear_pending_msg_events();
3234         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3235         match events[if deliver_bs_raa { 1 } else { 0 }] {
3236                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3237                 _ => panic!("Unexpected event"),
3238         }
3239         if deliver_bs_raa {
3240                 match events[0] {
3241                         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, .. } } => {
3242                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3243                                 assert_eq!(update_add_htlcs.len(), 1);
3244                                 assert!(update_fulfill_htlcs.is_empty());
3245                                 assert!(update_fail_htlcs.is_empty());
3246                                 assert!(update_fail_malformed_htlcs.is_empty());
3247                         },
3248                         _ => panic!("Unexpected event"),
3249                 }
3250         }
3251         match events[if deliver_bs_raa { 2 } else { 1 }] {
3252                 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, .. } } => {
3253                         assert!(update_add_htlcs.is_empty());
3254                         assert_eq!(update_fail_htlcs.len(), 3);
3255                         assert!(update_fulfill_htlcs.is_empty());
3256                         assert!(update_fail_malformed_htlcs.is_empty());
3257                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3258
3259                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3260                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3261                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3262
3263                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3264
3265                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3266                         // If we delivered B's RAA we got an unknown preimage error, not something
3267                         // that we should update our routing table for.
3268                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3269                         for event in events {
3270                                 match event {
3271                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3272                                         _ => panic!("Unexpected event"),
3273                                 }
3274                         }
3275                         let events = nodes[0].node.get_and_clear_pending_events();
3276                         assert_eq!(events.len(), 3);
3277                         match events[0] {
3278                                 Event::PaymentFailed { ref payment_hash, .. } => {
3279                                         assert!(failed_htlcs.insert(payment_hash.0));
3280                                 },
3281                                 _ => panic!("Unexpected event"),
3282                         }
3283                         match events[1] {
3284                                 Event::PaymentFailed { ref payment_hash, .. } => {
3285                                         assert!(failed_htlcs.insert(payment_hash.0));
3286                                 },
3287                                 _ => panic!("Unexpected event"),
3288                         }
3289                         match events[2] {
3290                                 Event::PaymentFailed { ref payment_hash, .. } => {
3291                                         assert!(failed_htlcs.insert(payment_hash.0));
3292                                 },
3293                                 _ => panic!("Unexpected event"),
3294                         }
3295                 },
3296                 _ => panic!("Unexpected event"),
3297         }
3298
3299         assert!(failed_htlcs.contains(&first_payment_hash.0));
3300         assert!(failed_htlcs.contains(&second_payment_hash.0));
3301         assert!(failed_htlcs.contains(&third_payment_hash.0));
3302 }
3303
3304 #[test]
3305 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3306         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3307         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3308         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3309         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3310 }
3311
3312 #[test]
3313 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3314         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3315         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3316         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3317         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3318 }
3319
3320 #[test]
3321 fn fail_backward_pending_htlc_upon_channel_failure() {
3322         let chanmon_cfgs = create_chanmon_cfgs(2);
3323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3325         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3326         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3327         let logger = test_utils::TestLogger::new();
3328
3329         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3330         {
3331                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3332                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3333                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3334                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3335                 check_added_monitors!(nodes[0], 1);
3336
3337                 let payment_event = {
3338                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3339                         assert_eq!(events.len(), 1);
3340                         SendEvent::from_event(events.remove(0))
3341                 };
3342                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3343                 assert_eq!(payment_event.msgs.len(), 1);
3344         }
3345
3346         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3347         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3348         {
3349                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3350                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3351                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3352                 check_added_monitors!(nodes[0], 0);
3353
3354                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3355         }
3356
3357         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3358         {
3359                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3360
3361                 let secp_ctx = Secp256k1::new();
3362                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3363                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3364                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3365                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3366                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3367                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3368                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3369
3370                 // Send a 0-msat update_add_htlc to fail the channel.
3371                 let update_add_htlc = msgs::UpdateAddHTLC {
3372                         channel_id: chan.2,
3373                         htlc_id: 0,
3374                         amount_msat: 0,
3375                         payment_hash,
3376                         cltv_expiry,
3377                         onion_routing_packet,
3378                 };
3379                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3380         }
3381
3382         // Check that Alice fails backward the pending HTLC from the second payment.
3383         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3384         check_closed_broadcast!(nodes[0], true);
3385         check_added_monitors!(nodes[0], 1);
3386 }
3387
3388 #[test]
3389 fn test_htlc_ignore_latest_remote_commitment() {
3390         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3391         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3392         let chanmon_cfgs = create_chanmon_cfgs(2);
3393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3396         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3397
3398         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3399         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3400         check_closed_broadcast!(nodes[0], false);
3401         check_added_monitors!(nodes[0], 1);
3402
3403         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3404         assert_eq!(node_txn.len(), 2);
3405
3406         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3407         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3408         check_closed_broadcast!(nodes[1], false);
3409         check_added_monitors!(nodes[1], 1);
3410
3411         // Duplicate the connect_block call since this may happen due to other listeners
3412         // registering new transactions
3413         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3414 }
3415
3416 #[test]
3417 fn test_force_close_fail_back() {
3418         // Check which HTLCs are failed-backwards on channel force-closure
3419         let chanmon_cfgs = create_chanmon_cfgs(3);
3420         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3421         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3422         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3423         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3424         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3425         let logger = test_utils::TestLogger::new();
3426
3427         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3428
3429         let mut payment_event = {
3430                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3431                 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(), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3432                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3433                 check_added_monitors!(nodes[0], 1);
3434
3435                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3436                 assert_eq!(events.len(), 1);
3437                 SendEvent::from_event(events.remove(0))
3438         };
3439
3440         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3441         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3442
3443         expect_pending_htlcs_forwardable!(nodes[1]);
3444
3445         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3446         assert_eq!(events_2.len(), 1);
3447         payment_event = SendEvent::from_event(events_2.remove(0));
3448         assert_eq!(payment_event.msgs.len(), 1);
3449
3450         check_added_monitors!(nodes[1], 1);
3451         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3452         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3453         check_added_monitors!(nodes[2], 1);
3454         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3455
3456         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3457         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3458         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3459
3460         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3461         check_closed_broadcast!(nodes[2], false);
3462         check_added_monitors!(nodes[2], 1);
3463         let tx = {
3464                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3465                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3466                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3467                 // back to nodes[1] upon timeout otherwise.
3468                 assert_eq!(node_txn.len(), 1);
3469                 node_txn.remove(0)
3470         };
3471
3472         let block = Block {
3473                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3474                 txdata: vec![tx.clone()],
3475         };
3476         connect_block(&nodes[1], &block, 1);
3477
3478         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3479         check_closed_broadcast!(nodes[1], false);
3480         check_added_monitors!(nodes[1], 1);
3481
3482         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3483         {
3484                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.lock().unwrap();
3485                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3486                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3487         }
3488         connect_block(&nodes[2], &block, 1);
3489         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3490         assert_eq!(node_txn.len(), 1);
3491         assert_eq!(node_txn[0].input.len(), 1);
3492         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3493         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3494         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3495
3496         check_spends!(node_txn[0], tx);
3497 }
3498
3499 #[test]
3500 fn test_unconf_chan() {
3501         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3502         let chanmon_cfgs = create_chanmon_cfgs(2);
3503         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3504         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3505         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3506         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3507
3508         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3509         assert_eq!(channel_state.by_id.len(), 1);
3510         assert_eq!(channel_state.short_to_id.len(), 1);
3511         mem::drop(channel_state);
3512
3513         let mut headers = Vec::new();
3514         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3515         headers.push(header.clone());
3516         for _i in 2..100 {
3517                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3518                 headers.push(header.clone());
3519         }
3520         while !headers.is_empty() {
3521                 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3522         }
3523         check_closed_broadcast!(nodes[0], false);
3524         check_added_monitors!(nodes[0], 1);
3525         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3526         assert_eq!(channel_state.by_id.len(), 0);
3527         assert_eq!(channel_state.short_to_id.len(), 0);
3528 }
3529
3530 #[test]
3531 fn test_simple_peer_disconnect() {
3532         // Test that we can reconnect when there are no lost messages
3533         let chanmon_cfgs = create_chanmon_cfgs(3);
3534         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3535         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3536         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3537         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3538         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3539
3540         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3541         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3542         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3543
3544         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3545         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3546         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3547         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3548
3549         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3550         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3551         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3552
3553         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3554         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3555         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3556         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3557
3558         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3559         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3560
3561         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3562         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3563
3564         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3565         {
3566                 let events = nodes[0].node.get_and_clear_pending_events();
3567                 assert_eq!(events.len(), 2);
3568                 match events[0] {
3569                         Event::PaymentSent { payment_preimage } => {
3570                                 assert_eq!(payment_preimage, payment_preimage_3);
3571                         },
3572                         _ => panic!("Unexpected event"),
3573                 }
3574                 match events[1] {
3575                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3576                                 assert_eq!(payment_hash, payment_hash_5);
3577                                 assert!(rejected_by_dest);
3578                         },
3579                         _ => panic!("Unexpected event"),
3580                 }
3581         }
3582
3583         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3584         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3585 }
3586
3587 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3588         // Test that we can reconnect when in-flight HTLC updates get dropped
3589         let chanmon_cfgs = create_chanmon_cfgs(2);
3590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3592         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3593         if messages_delivered == 0 {
3594                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3595                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3596         } else {
3597                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3598         }
3599
3600         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3601
3602         let logger = test_utils::TestLogger::new();
3603         let payment_event = {
3604                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3605                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3606                         &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3607                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3608                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3609                 check_added_monitors!(nodes[0], 1);
3610
3611                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3612                 assert_eq!(events.len(), 1);
3613                 SendEvent::from_event(events.remove(0))
3614         };
3615         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3616
3617         if messages_delivered < 2 {
3618                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3619         } else {
3620                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3621                 if messages_delivered >= 3 {
3622                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3623                         check_added_monitors!(nodes[1], 1);
3624                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3625
3626                         if messages_delivered >= 4 {
3627                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3628                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3629                                 check_added_monitors!(nodes[0], 1);
3630
3631                                 if messages_delivered >= 5 {
3632                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3633                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3634                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3635                                         check_added_monitors!(nodes[0], 1);
3636
3637                                         if messages_delivered >= 6 {
3638                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3639                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3640                                                 check_added_monitors!(nodes[1], 1);
3641                                         }
3642                                 }
3643                         }
3644                 }
3645         }
3646
3647         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3648         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3649         if messages_delivered < 3 {
3650                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3651                 // received on either side, both sides will need to resend them.
3652                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3653         } else if messages_delivered == 3 {
3654                 // nodes[0] still wants its RAA + commitment_signed
3655                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3656         } else if messages_delivered == 4 {
3657                 // nodes[0] still wants its commitment_signed
3658                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3659         } else if messages_delivered == 5 {
3660                 // nodes[1] still wants its final RAA
3661                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3662         } else if messages_delivered == 6 {
3663                 // Everything was delivered...
3664                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3665         }
3666
3667         let events_1 = nodes[1].node.get_and_clear_pending_events();
3668         assert_eq!(events_1.len(), 1);
3669         match events_1[0] {
3670                 Event::PendingHTLCsForwardable { .. } => { },
3671                 _ => panic!("Unexpected event"),
3672         };
3673
3674         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3675         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3676         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3677
3678         nodes[1].node.process_pending_htlc_forwards();
3679
3680         let events_2 = nodes[1].node.get_and_clear_pending_events();
3681         assert_eq!(events_2.len(), 1);
3682         match events_2[0] {
3683                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3684                         assert_eq!(payment_hash_1, *payment_hash);
3685                         assert_eq!(*payment_secret, None);
3686                         assert_eq!(amt, 1000000);
3687                 },
3688                 _ => panic!("Unexpected event"),
3689         }
3690
3691         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3692         check_added_monitors!(nodes[1], 1);
3693
3694         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3695         assert_eq!(events_3.len(), 1);
3696         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3697                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3698                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3699                         assert!(updates.update_add_htlcs.is_empty());
3700                         assert!(updates.update_fail_htlcs.is_empty());
3701                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3702                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3703                         assert!(updates.update_fee.is_none());
3704                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3705                 },
3706                 _ => panic!("Unexpected event"),
3707         };
3708
3709         if messages_delivered >= 1 {
3710                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3711
3712                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3713                 assert_eq!(events_4.len(), 1);
3714                 match events_4[0] {
3715                         Event::PaymentSent { ref payment_preimage } => {
3716                                 assert_eq!(payment_preimage_1, *payment_preimage);
3717                         },
3718                         _ => panic!("Unexpected event"),
3719                 }
3720
3721                 if messages_delivered >= 2 {
3722                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3723                         check_added_monitors!(nodes[0], 1);
3724                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3725
3726                         if messages_delivered >= 3 {
3727                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3728                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3729                                 check_added_monitors!(nodes[1], 1);
3730
3731                                 if messages_delivered >= 4 {
3732                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3733                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3734                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3735                                         check_added_monitors!(nodes[1], 1);
3736
3737                                         if messages_delivered >= 5 {
3738                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3739                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3740                                                 check_added_monitors!(nodes[0], 1);
3741                                         }
3742                                 }
3743                         }
3744                 }
3745         }
3746
3747         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3748         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3749         if messages_delivered < 2 {
3750                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3751                 //TODO: Deduplicate PaymentSent events, then enable this if:
3752                 //if messages_delivered < 1 {
3753                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3754                         assert_eq!(events_4.len(), 1);
3755                         match events_4[0] {
3756                                 Event::PaymentSent { ref payment_preimage } => {
3757                                         assert_eq!(payment_preimage_1, *payment_preimage);
3758                                 },
3759                                 _ => panic!("Unexpected event"),
3760                         }
3761                 //}
3762         } else if messages_delivered == 2 {
3763                 // nodes[0] still wants its RAA + commitment_signed
3764                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3765         } else if messages_delivered == 3 {
3766                 // nodes[0] still wants its commitment_signed
3767                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3768         } else if messages_delivered == 4 {
3769                 // nodes[1] still wants its final RAA
3770                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3771         } else if messages_delivered == 5 {
3772                 // Everything was delivered...
3773                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3774         }
3775
3776         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3777         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3778         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3779
3780         // Channel should still work fine...
3781         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3782         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3783                 &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3784                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3785         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3786         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3787 }
3788
3789 #[test]
3790 fn test_drop_messages_peer_disconnect_a() {
3791         do_test_drop_messages_peer_disconnect(0);
3792         do_test_drop_messages_peer_disconnect(1);
3793         do_test_drop_messages_peer_disconnect(2);
3794         do_test_drop_messages_peer_disconnect(3);
3795 }
3796
3797 #[test]
3798 fn test_drop_messages_peer_disconnect_b() {
3799         do_test_drop_messages_peer_disconnect(4);
3800         do_test_drop_messages_peer_disconnect(5);
3801         do_test_drop_messages_peer_disconnect(6);
3802 }
3803
3804 #[test]
3805 fn test_funding_peer_disconnect() {
3806         // Test that we can lock in our funding tx while disconnected
3807         let chanmon_cfgs = create_chanmon_cfgs(2);
3808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3810         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3811         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3812
3813         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3814         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3815
3816         confirm_transaction(&nodes[0], &tx);
3817         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3818         assert_eq!(events_1.len(), 1);
3819         match events_1[0] {
3820                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3821                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3822                 },
3823                 _ => panic!("Unexpected event"),
3824         }
3825
3826         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3827
3828         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3829         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3830
3831         confirm_transaction(&nodes[1], &tx);
3832         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3833         assert_eq!(events_2.len(), 2);
3834         let funding_locked = match events_2[0] {
3835                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3836                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3837                         msg.clone()
3838                 },
3839                 _ => panic!("Unexpected event"),
3840         };
3841         let bs_announcement_sigs = match events_2[1] {
3842                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3843                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3844                         msg.clone()
3845                 },
3846                 _ => panic!("Unexpected event"),
3847         };
3848
3849         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3850
3851         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3852         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3853         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3854         assert_eq!(events_3.len(), 2);
3855         let as_announcement_sigs = match events_3[0] {
3856                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3857                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3858                         msg.clone()
3859                 },
3860                 _ => panic!("Unexpected event"),
3861         };
3862         let (as_announcement, as_update) = match events_3[1] {
3863                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3864                         (msg.clone(), update_msg.clone())
3865                 },
3866                 _ => panic!("Unexpected event"),
3867         };
3868
3869         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3870         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3871         assert_eq!(events_4.len(), 1);
3872         let (_, bs_update) = match events_4[0] {
3873                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3874                         (msg.clone(), update_msg.clone())
3875                 },
3876                 _ => panic!("Unexpected event"),
3877         };
3878
3879         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3880         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3881         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3882
3883         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3884         let logger = test_utils::TestLogger::new();
3885         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3886         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3887         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3888 }
3889
3890 #[test]
3891 fn test_drop_messages_peer_disconnect_dual_htlc() {
3892         // Test that we can handle reconnecting when both sides of a channel have pending
3893         // commitment_updates when we disconnect.
3894         let chanmon_cfgs = create_chanmon_cfgs(2);
3895         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3896         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3897         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3898         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3899         let logger = test_utils::TestLogger::new();
3900
3901         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3902
3903         // Now try to send a second payment which will fail to send
3904         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3905         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3906         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3907         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3908         check_added_monitors!(nodes[0], 1);
3909
3910         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3911         assert_eq!(events_1.len(), 1);
3912         match events_1[0] {
3913                 MessageSendEvent::UpdateHTLCs { .. } => {},
3914                 _ => panic!("Unexpected event"),
3915         }
3916
3917         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3918         check_added_monitors!(nodes[1], 1);
3919
3920         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3921         assert_eq!(events_2.len(), 1);
3922         match events_2[0] {
3923                 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 } } => {
3924                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3925                         assert!(update_add_htlcs.is_empty());
3926                         assert_eq!(update_fulfill_htlcs.len(), 1);
3927                         assert!(update_fail_htlcs.is_empty());
3928                         assert!(update_fail_malformed_htlcs.is_empty());
3929                         assert!(update_fee.is_none());
3930
3931                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3932                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3933                         assert_eq!(events_3.len(), 1);
3934                         match events_3[0] {
3935                                 Event::PaymentSent { ref payment_preimage } => {
3936                                         assert_eq!(*payment_preimage, payment_preimage_1);
3937                                 },
3938                                 _ => panic!("Unexpected event"),
3939                         }
3940
3941                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3942                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3943                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3944                         check_added_monitors!(nodes[0], 1);
3945                 },
3946                 _ => panic!("Unexpected event"),
3947         }
3948
3949         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3950         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3951
3952         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3953         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3954         assert_eq!(reestablish_1.len(), 1);
3955         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3956         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3957         assert_eq!(reestablish_2.len(), 1);
3958
3959         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3960         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3961         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3962         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3963
3964         assert!(as_resp.0.is_none());
3965         assert!(bs_resp.0.is_none());
3966
3967         assert!(bs_resp.1.is_none());
3968         assert!(bs_resp.2.is_none());
3969
3970         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3971
3972         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3973         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3974         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3975         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3976         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3977         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3978         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3979         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3980         // No commitment_signed so get_event_msg's assert(len == 1) passes
3981         check_added_monitors!(nodes[1], 1);
3982
3983         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3984         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3985         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3986         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3987         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3988         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3989         assert!(bs_second_commitment_signed.update_fee.is_none());
3990         check_added_monitors!(nodes[1], 1);
3991
3992         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3993         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3994         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3995         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3996         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3997         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3998         assert!(as_commitment_signed.update_fee.is_none());
3999         check_added_monitors!(nodes[0], 1);
4000
4001         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4002         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4003         // No commitment_signed so get_event_msg's assert(len == 1) passes
4004         check_added_monitors!(nodes[0], 1);
4005
4006         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4007         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4008         // No commitment_signed so get_event_msg's assert(len == 1) passes
4009         check_added_monitors!(nodes[1], 1);
4010
4011         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4012         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4013         check_added_monitors!(nodes[1], 1);
4014
4015         expect_pending_htlcs_forwardable!(nodes[1]);
4016
4017         let events_5 = nodes[1].node.get_and_clear_pending_events();
4018         assert_eq!(events_5.len(), 1);
4019         match events_5[0] {
4020                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4021                         assert_eq!(payment_hash_2, *payment_hash);
4022                         assert_eq!(*payment_secret, None);
4023                 },
4024                 _ => panic!("Unexpected event"),
4025         }
4026
4027         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4028         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4029         check_added_monitors!(nodes[0], 1);
4030
4031         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4032 }
4033
4034 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4035         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4036         // to avoid our counterparty failing the channel.
4037         let chanmon_cfgs = create_chanmon_cfgs(2);
4038         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4039         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4040         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4041
4042         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4043         let logger = test_utils::TestLogger::new();
4044
4045         let our_payment_hash = if send_partial_mpp {
4046                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4047                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4048                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4049                 let payment_secret = PaymentSecret([0xdb; 32]);
4050                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4051                 // indicates there are more HTLCs coming.
4052                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4053                 check_added_monitors!(nodes[0], 1);
4054                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4055                 assert_eq!(events.len(), 1);
4056                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4057                 // hop should *not* yet generate any PaymentReceived event(s).
4058                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4059                 our_payment_hash
4060         } else {
4061                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4062         };
4063
4064         let mut block = Block {
4065                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4066                 txdata: vec![],
4067         };
4068         connect_block(&nodes[0], &block, 101);
4069         connect_block(&nodes[1], &block, 101);
4070         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4071                 block.header.prev_blockhash = block.block_hash();
4072                 connect_block(&nodes[0], &block, i);
4073                 connect_block(&nodes[1], &block, i);
4074         }
4075
4076         expect_pending_htlcs_forwardable!(nodes[1]);
4077
4078         check_added_monitors!(nodes[1], 1);
4079         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4080         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4081         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4082         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4083         assert!(htlc_timeout_updates.update_fee.is_none());
4084
4085         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4086         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4087         // 100_000 msat as u64, followed by a height of 123 as u32
4088         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4089         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4090         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4091 }
4092
4093 #[test]
4094 fn test_htlc_timeout() {
4095         do_test_htlc_timeout(true);
4096         do_test_htlc_timeout(false);
4097 }
4098
4099 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4100         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4101         let chanmon_cfgs = create_chanmon_cfgs(3);
4102         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4103         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4104         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4105         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4106         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4107         let logger = test_utils::TestLogger::new();
4108
4109         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4110         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4111         {
4112                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4113                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4114                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4115         }
4116         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4117         check_added_monitors!(nodes[1], 1);
4118
4119         // Now attempt to route a second payment, which should be placed in the holding cell
4120         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4121         if forwarded_htlc {
4122                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4123                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4124                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4125                 check_added_monitors!(nodes[0], 1);
4126                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4127                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4128                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4129                 expect_pending_htlcs_forwardable!(nodes[1]);
4130                 check_added_monitors!(nodes[1], 0);
4131         } else {
4132                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4133                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4134                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4135                 check_added_monitors!(nodes[1], 0);
4136         }
4137
4138         let mut block = Block {
4139                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4140                 txdata: vec![],
4141         };
4142         connect_block(&nodes[1], &block, 101);
4143         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4144                 block.header.prev_blockhash = block.block_hash();
4145                 connect_block(&nodes[1], &block, i);
4146         }
4147
4148         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4149         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4150
4151         block.header.prev_blockhash = block.block_hash();
4152         connect_block(&nodes[1], &block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4153
4154         if forwarded_htlc {
4155                 expect_pending_htlcs_forwardable!(nodes[1]);
4156                 check_added_monitors!(nodes[1], 1);
4157                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4158                 assert_eq!(fail_commit.len(), 1);
4159                 match fail_commit[0] {
4160                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4161                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4162                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4163                         },
4164                         _ => unreachable!(),
4165                 }
4166                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4167                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4168                         match update {
4169                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4170                                 _ => panic!("Unexpected event"),
4171                         }
4172                 } else {
4173                         panic!("Unexpected event");
4174                 }
4175         } else {
4176                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4177         }
4178 }
4179
4180 #[test]
4181 fn test_holding_cell_htlc_add_timeouts() {
4182         do_test_holding_cell_htlc_add_timeouts(false);
4183         do_test_holding_cell_htlc_add_timeouts(true);
4184 }
4185
4186 #[test]
4187 fn test_invalid_channel_announcement() {
4188         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4189         let secp_ctx = Secp256k1::new();
4190         let chanmon_cfgs = create_chanmon_cfgs(2);
4191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4193         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4194
4195         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4196
4197         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4198         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4199         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4200         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4201
4202         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 } );
4203
4204         let as_bitcoin_key = as_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4205         let bs_bitcoin_key = bs_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4206
4207         let as_network_key = nodes[0].node.get_our_node_id();
4208         let bs_network_key = nodes[1].node.get_our_node_id();
4209
4210         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4211
4212         let mut chan_announcement;
4213
4214         macro_rules! dummy_unsigned_msg {
4215                 () => {
4216                         msgs::UnsignedChannelAnnouncement {
4217                                 features: ChannelFeatures::known(),
4218                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4219                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4220                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4221                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4222                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4223                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4224                                 excess_data: Vec::new(),
4225                         };
4226                 }
4227         }
4228
4229         macro_rules! sign_msg {
4230                 ($unsigned_msg: expr) => {
4231                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4232                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_keys().inner.funding_key);
4233                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_keys().inner.funding_key);
4234                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4235                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4236                         chan_announcement = msgs::ChannelAnnouncement {
4237                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4238                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4239                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4240                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4241                                 contents: $unsigned_msg
4242                         }
4243                 }
4244         }
4245
4246         let unsigned_msg = dummy_unsigned_msg!();
4247         sign_msg!(unsigned_msg);
4248         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4249         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 } );
4250
4251         // Configured with Network::Testnet
4252         let mut unsigned_msg = dummy_unsigned_msg!();
4253         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4254         sign_msg!(unsigned_msg);
4255         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4256
4257         let mut unsigned_msg = dummy_unsigned_msg!();
4258         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4259         sign_msg!(unsigned_msg);
4260         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4261 }
4262
4263 #[test]
4264 fn test_no_txn_manager_serialize_deserialize() {
4265         let chanmon_cfgs = create_chanmon_cfgs(2);
4266         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4267         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4268         let logger: test_utils::TestLogger;
4269         let fee_estimator: test_utils::TestFeeEstimator;
4270         let persister: test_utils::TestPersister;
4271         let new_chain_monitor: test_utils::TestChainMonitor;
4272         let keys_manager: test_utils::TestKeysInterface;
4273         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4274         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4275
4276         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4277
4278         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4279
4280         let nodes_0_serialized = nodes[0].node.encode();
4281         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4282         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4283
4284         logger = test_utils::TestLogger::new();
4285         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4286         persister = test_utils::TestPersister::new();
4287         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister);
4288         nodes[0].chain_monitor = &new_chain_monitor;
4289         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4290         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4291         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4292                 &mut chan_0_monitor_read, &keys_manager).unwrap();
4293         assert!(chan_0_monitor_read.is_empty());
4294
4295         let mut nodes_0_read = &nodes_0_serialized[..];
4296         let config = UserConfig::default();
4297         let (_, nodes_0_deserialized_tmp) = {
4298                 let mut channel_monitors = HashMap::new();
4299                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4300                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4301                         default_config: config,
4302                         keys_manager: &keys_manager,
4303                         fee_estimator: &fee_estimator,
4304                         chain_monitor: nodes[0].chain_monitor,
4305                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4306                         logger: &logger,
4307                         channel_monitors,
4308                 }).unwrap()
4309         };
4310         nodes_0_deserialized = nodes_0_deserialized_tmp;
4311         assert!(nodes_0_read.is_empty());
4312
4313         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4314         nodes[0].node = &nodes_0_deserialized;
4315         assert_eq!(nodes[0].node.list_channels().len(), 1);
4316         check_added_monitors!(nodes[0], 1);
4317
4318         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4319         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4320         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4321         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4322
4323         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4324         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4325         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4326         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4327
4328         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4329         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4330         for node in nodes.iter() {
4331                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4332                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4333                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4334         }
4335
4336         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4337 }
4338
4339 #[test]
4340 fn test_manager_serialize_deserialize_events() {
4341         // This test makes sure the events field in ChannelManager survives de/serialization
4342         let chanmon_cfgs = create_chanmon_cfgs(2);
4343         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4344         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4345         let fee_estimator: test_utils::TestFeeEstimator;
4346         let persister: test_utils::TestPersister;
4347         let logger: test_utils::TestLogger;
4348         let new_chain_monitor: test_utils::TestChainMonitor;
4349         let keys_manager: test_utils::TestKeysInterface;
4350         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4351         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4352
4353         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4354         let channel_value = 100000;
4355         let push_msat = 10001;
4356         let a_flags = InitFeatures::known();
4357         let b_flags = InitFeatures::known();
4358         let node_a = nodes.pop().unwrap();
4359         let node_b = nodes.pop().unwrap();
4360         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4361         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()));
4362         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()));
4363
4364         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4365
4366         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4367         check_added_monitors!(node_a, 0);
4368
4369         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()));
4370         {
4371                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4372                 assert_eq!(added_monitors.len(), 1);
4373                 assert_eq!(added_monitors[0].0, funding_output);
4374                 added_monitors.clear();
4375         }
4376
4377         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()));
4378         {
4379                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4380                 assert_eq!(added_monitors.len(), 1);
4381                 assert_eq!(added_monitors[0].0, funding_output);
4382                 added_monitors.clear();
4383         }
4384         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4385
4386         nodes.push(node_a);
4387         nodes.push(node_b);
4388
4389         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
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.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4393
4394         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4395         logger = test_utils::TestLogger::new();
4396         persister = test_utils::TestPersister::new();
4397         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister);
4398         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
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<EnforcingChannelKeys>)>::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<EnforcingChannelKeys, &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: &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         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4424
4425         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4426         nodes[0].node = &nodes_0_deserialized;
4427
4428         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4429         let events_4 = nodes[0].node.get_and_clear_pending_events();
4430         assert_eq!(events_4.len(), 1);
4431         match events_4[0] {
4432                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4433                         assert_eq!(user_channel_id, 42);
4434                         assert_eq!(*funding_txo, funding_output);
4435                 },
4436                 _ => panic!("Unexpected event"),
4437         };
4438
4439         // Make sure the channel is functioning as though the de/serialization never happened
4440         assert_eq!(nodes[0].node.list_channels().len(), 1);
4441         check_added_monitors!(nodes[0], 1);
4442
4443         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4444         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4445         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4446         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4447
4448         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4449         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4450         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4451         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4452
4453         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4454         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4455         for node in nodes.iter() {
4456                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4457                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4458                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4459         }
4460
4461         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4462 }
4463
4464 #[test]
4465 fn test_simple_manager_serialize_deserialize() {
4466         let chanmon_cfgs = create_chanmon_cfgs(2);
4467         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4468         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4469         let logger: test_utils::TestLogger;
4470         let fee_estimator: test_utils::TestFeeEstimator;
4471         let persister: test_utils::TestPersister;
4472         let new_chain_monitor: test_utils::TestChainMonitor;
4473         let keys_manager: test_utils::TestKeysInterface;
4474         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4475         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4476         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4477
4478         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4479         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4480
4481         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4482
4483         let nodes_0_serialized = nodes[0].node.encode();
4484         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4485         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4486
4487         logger = test_utils::TestLogger::new();
4488         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4489         persister = test_utils::TestPersister::new();
4490         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister);
4491         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4492         nodes[0].chain_monitor = &new_chain_monitor;
4493         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4494         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4495                 &mut chan_0_monitor_read, &keys_manager).unwrap();
4496         assert!(chan_0_monitor_read.is_empty());
4497
4498         let mut nodes_0_read = &nodes_0_serialized[..];
4499         let (_, nodes_0_deserialized_tmp) = {
4500                 let mut channel_monitors = HashMap::new();
4501                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4502                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4503                         default_config: UserConfig::default(),
4504                         keys_manager: &keys_manager,
4505                         fee_estimator: &fee_estimator,
4506                         chain_monitor: nodes[0].chain_monitor,
4507                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4508                         logger: &logger,
4509                         channel_monitors,
4510                 }).unwrap()
4511         };
4512         nodes_0_deserialized = nodes_0_deserialized_tmp;
4513         assert!(nodes_0_read.is_empty());
4514
4515         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4516         nodes[0].node = &nodes_0_deserialized;
4517         check_added_monitors!(nodes[0], 1);
4518
4519         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4520
4521         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4522         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4523 }
4524
4525 #[test]
4526 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4527         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4528         let chanmon_cfgs = create_chanmon_cfgs(4);
4529         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4530         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4531         let logger: test_utils::TestLogger;
4532         let fee_estimator: test_utils::TestFeeEstimator;
4533         let persister: test_utils::TestPersister;
4534         let new_chain_monitor: test_utils::TestChainMonitor;
4535         let keys_manager: test_utils::TestKeysInterface;
4536         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4537         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4538         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4539         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4540         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4541
4542         let mut node_0_stale_monitors_serialized = Vec::new();
4543         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4544                 let mut writer = test_utils::TestVecWriter(Vec::new());
4545                 monitor.1.write(&mut writer).unwrap();
4546                 node_0_stale_monitors_serialized.push(writer.0);
4547         }
4548
4549         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4550
4551         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4552         let nodes_0_serialized = nodes[0].node.encode();
4553
4554         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4555         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4556         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4557         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4558
4559         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4560         // nodes[3])
4561         let mut node_0_monitors_serialized = Vec::new();
4562         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4563                 let mut writer = test_utils::TestVecWriter(Vec::new());
4564                 monitor.1.write(&mut writer).unwrap();
4565                 node_0_monitors_serialized.push(writer.0);
4566         }
4567
4568         logger = test_utils::TestLogger::new();
4569         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4570         persister = test_utils::TestPersister::new();
4571         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister);
4572         nodes[0].chain_monitor = &new_chain_monitor;
4573
4574         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4575
4576         let mut node_0_stale_monitors = Vec::new();
4577         for serialized in node_0_stale_monitors_serialized.iter() {
4578                 let mut read = &serialized[..];
4579                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, &keys_manager).unwrap();
4580                 assert!(read.is_empty());
4581                 node_0_stale_monitors.push(monitor);
4582         }
4583
4584         let mut node_0_monitors = Vec::new();
4585         for serialized in node_0_monitors_serialized.iter() {
4586                 let mut read = &serialized[..];
4587                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, &keys_manager).unwrap();
4588                 assert!(read.is_empty());
4589                 node_0_monitors.push(monitor);
4590         }
4591
4592         let mut nodes_0_read = &nodes_0_serialized[..];
4593         if let Err(msgs::DecodeError::InvalidValue) =
4594                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4595                 default_config: UserConfig::default(),
4596                 keys_manager: &keys_manager,
4597                 fee_estimator: &fee_estimator,
4598                 chain_monitor: nodes[0].chain_monitor,
4599                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4600                 logger: &logger,
4601                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4602         }) { } else {
4603                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4604         };
4605
4606         let mut nodes_0_read = &nodes_0_serialized[..];
4607         let (_, nodes_0_deserialized_tmp) =
4608                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4609                 default_config: UserConfig::default(),
4610                 keys_manager: &keys_manager,
4611                 fee_estimator: &fee_estimator,
4612                 chain_monitor: nodes[0].chain_monitor,
4613                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4614                 logger: &logger,
4615                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4616         }).unwrap();
4617         nodes_0_deserialized = nodes_0_deserialized_tmp;
4618         assert!(nodes_0_read.is_empty());
4619
4620         { // Channel close should result in a commitment tx and an HTLC tx
4621                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4622                 assert_eq!(txn.len(), 2);
4623                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4624                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4625         }
4626
4627         for monitor in node_0_monitors.drain(..) {
4628                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4629                 check_added_monitors!(nodes[0], 1);
4630         }
4631         nodes[0].node = &nodes_0_deserialized;
4632
4633         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4634         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4635         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4636         //... and we can even still claim the payment!
4637         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4638
4639         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4640         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4641         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4642         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4643         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4644         assert_eq!(msg_events.len(), 1);
4645         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4646                 match action {
4647                         &ErrorAction::SendErrorMessage { ref msg } => {
4648                                 assert_eq!(msg.channel_id, channel_id);
4649                         },
4650                         _ => panic!("Unexpected event!"),
4651                 }
4652         }
4653 }
4654
4655 macro_rules! check_spendable_outputs {
4656         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4657                 {
4658                         let events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4659                         let mut txn = Vec::new();
4660                         for event in events {
4661                                 match event {
4662                                         Event::SpendableOutputs { ref outputs } => {
4663                                                 for outp in outputs {
4664                                                         match *outp {
4665                                                                 SpendableOutputDescriptor::StaticOutputCounterpartyPayment { ref outpoint, ref output, ref key_derivation_params } => {
4666                                                                         let input = TxIn {
4667                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4668                                                                                 script_sig: Script::new(),
4669                                                                                 sequence: 0,
4670                                                                                 witness: Vec::new(),
4671                                                                         };
4672                                                                         let outp = TxOut {
4673                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4674                                                                                 value: output.value,
4675                                                                         };
4676                                                                         let mut spend_tx = Transaction {
4677                                                                                 version: 2,
4678                                                                                 lock_time: 0,
4679                                                                                 input: vec![input],
4680                                                                                 output: vec![outp],
4681                                                                         };
4682                                                                         spend_tx.output[0].value -= (spend_tx.get_weight() + 2 + 1 + 73 + 35 + 3) as u64 / 4; // (Max weight + 3 (to round up)) / 4
4683                                                                         let secp_ctx = Secp256k1::new();
4684                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4685                                                                         let remotepubkey = keys.pubkeys().payment_point;
4686                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4687                                                                         let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4688                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4689                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4690                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4691                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4692                                                                         txn.push(spend_tx);
4693                                                                 },
4694                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref revocation_pubkey } => {
4695                                                                         let input = TxIn {
4696                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4697                                                                                 script_sig: Script::new(),
4698                                                                                 sequence: *to_self_delay as u32,
4699                                                                                 witness: Vec::new(),
4700                                                                         };
4701                                                                         let outp = TxOut {
4702                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4703                                                                                 value: output.value,
4704                                                                         };
4705                                                                         let mut spend_tx = Transaction {
4706                                                                                 version: 2,
4707                                                                                 lock_time: 0,
4708                                                                                 input: vec![input],
4709                                                                                 output: vec![outp],
4710                                                                         };
4711                                                                         let secp_ctx = Secp256k1::new();
4712                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4713                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4714
4715                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4716                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4717                                                                                 spend_tx.output[0].value -= (spend_tx.get_weight() + 2 + 1 + 73 + 1 + witness_script.len() + 1 + 3) as u64 / 4; // (Max weight + 3 (to round up)) / 4
4718                                                                                 let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4719                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4720                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4721                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4722                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4723                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4724                                                                         } else { panic!() }
4725                                                                         txn.push(spend_tx);
4726                                                                 },
4727                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4728                                                                         let secp_ctx = Secp256k1::new();
4729                                                                         let input = TxIn {
4730                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4731                                                                                 script_sig: Script::new(),
4732                                                                                 sequence: 0,
4733                                                                                 witness: Vec::new(),
4734                                                                         };
4735                                                                         let outp = TxOut {
4736                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4737                                                                                 value: output.value,
4738                                                                         };
4739                                                                         let mut spend_tx = Transaction {
4740                                                                                 version: 2,
4741                                                                                 lock_time: 0,
4742                                                                                 input: vec![input],
4743                                                                                 output: vec![outp.clone()],
4744                                                                         };
4745                                                                         spend_tx.output[0].value -= (spend_tx.get_weight() + 2 + 1 + 73 + 35 + 3) as u64 / 4; // (Max weight + 3 (to round up)) / 4
4746                                                                         let secret = {
4747                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4748                                                                                         Ok(master_key) => {
4749                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4750                                                                                                         Ok(key) => key,
4751                                                                                                         Err(_) => panic!("Your RNG is busted"),
4752                                                                                                 }
4753                                                                                         }
4754                                                                                         Err(_) => panic!("Your rng is busted"),
4755                                                                                 }
4756                                                                         };
4757                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4758                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4759                                                                         let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4760                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4761                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4762                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4763                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4764                                                                         txn.push(spend_tx);
4765                                                                 },
4766                                                         }
4767                                                 }
4768                                         },
4769                                         _ => panic!("Unexpected event"),
4770                                 };
4771                         }
4772                         txn
4773                 }
4774         }
4775 }
4776
4777 #[test]
4778 fn test_claim_sizeable_push_msat() {
4779         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4780         let chanmon_cfgs = create_chanmon_cfgs(2);
4781         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4782         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4783         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4784
4785         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4786         nodes[1].node.force_close_channel(&chan.2);
4787         check_closed_broadcast!(nodes[1], false);
4788         check_added_monitors!(nodes[1], 1);
4789         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4790         assert_eq!(node_txn.len(), 1);
4791         check_spends!(node_txn[0], chan.3);
4792         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
4793
4794         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4795         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4796         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4797
4798         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4799         assert_eq!(spend_txn.len(), 1);
4800         check_spends!(spend_txn[0], node_txn[0]);
4801 }
4802
4803 #[test]
4804 fn test_claim_on_remote_sizeable_push_msat() {
4805         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4806         // to_remote output is encumbered by a P2WPKH
4807         let chanmon_cfgs = create_chanmon_cfgs(2);
4808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4810         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4811
4812         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4813         nodes[0].node.force_close_channel(&chan.2);
4814         check_closed_broadcast!(nodes[0], false);
4815         check_added_monitors!(nodes[0], 1);
4816
4817         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4818         assert_eq!(node_txn.len(), 1);
4819         check_spends!(node_txn[0], chan.3);
4820         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
4821
4822         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4823         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4824         check_closed_broadcast!(nodes[1], false);
4825         check_added_monitors!(nodes[1], 1);
4826         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4827
4828         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4829         assert_eq!(spend_txn.len(), 1);
4830         check_spends!(spend_txn[0], node_txn[0]);
4831 }
4832
4833 #[test]
4834 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4835         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4836         // to_remote output is encumbered by a P2WPKH
4837
4838         let chanmon_cfgs = create_chanmon_cfgs(2);
4839         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4840         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4841         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4842
4843         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4844         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4845         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4846         assert_eq!(revoked_local_txn[0].input.len(), 1);
4847         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4848
4849         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4850         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4851         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4852         check_closed_broadcast!(nodes[1], false);
4853         check_added_monitors!(nodes[1], 1);
4854
4855         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4856         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4857         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4858         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4859
4860         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4861         assert_eq!(spend_txn.len(), 2);
4862         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4863         check_spends!(spend_txn[1], node_txn[0]);
4864 }
4865
4866 #[test]
4867 fn test_static_spendable_outputs_preimage_tx() {
4868         let chanmon_cfgs = create_chanmon_cfgs(2);
4869         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4870         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4871         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4872
4873         // Create some initial channels
4874         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4875
4876         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4877
4878         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4879         assert_eq!(commitment_tx[0].input.len(), 1);
4880         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4881
4882         // Settle A's commitment tx on B's chain
4883         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4884         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4885         check_added_monitors!(nodes[1], 1);
4886         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4887         check_added_monitors!(nodes[1], 1);
4888         let events = nodes[1].node.get_and_clear_pending_msg_events();
4889         match events[0] {
4890                 MessageSendEvent::UpdateHTLCs { .. } => {},
4891                 _ => panic!("Unexpected event"),
4892         }
4893         match events[1] {
4894                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4895                 _ => panic!("Unexepected event"),
4896         }
4897
4898         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4899         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4900         assert_eq!(node_txn.len(), 3);
4901         check_spends!(node_txn[0], commitment_tx[0]);
4902         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4903         check_spends!(node_txn[1], chan_1.3);
4904         check_spends!(node_txn[2], node_txn[1]);
4905
4906         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4907         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4908         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4909
4910         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4911         assert_eq!(spend_txn.len(), 1);
4912         check_spends!(spend_txn[0], node_txn[0]);
4913 }
4914
4915 #[test]
4916 fn test_static_spendable_outputs_timeout_tx() {
4917         let chanmon_cfgs = create_chanmon_cfgs(2);
4918         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4919         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4920         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4921
4922         // Create some initial channels
4923         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4924
4925         // Rebalance the network a bit by relaying one payment through all the channels ...
4926         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4927
4928         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4929
4930         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4931         assert_eq!(commitment_tx[0].input.len(), 1);
4932         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4933
4934         // Settle A's commitment tx on B' chain
4935         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4936         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4937         check_added_monitors!(nodes[1], 1);
4938         let events = nodes[1].node.get_and_clear_pending_msg_events();
4939         match events[0] {
4940                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4941                 _ => panic!("Unexpected event"),
4942         }
4943
4944         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4945         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4946         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4947         check_spends!(node_txn[0],  commitment_tx[0].clone());
4948         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4949         check_spends!(node_txn[1], chan_1.3.clone());
4950         check_spends!(node_txn[2], node_txn[1]);
4951
4952         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4953         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4954         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4955         expect_payment_failed!(nodes[1], our_payment_hash, true);
4956
4957         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4958         assert_eq!(spend_txn.len(), 2); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4959         check_spends!(spend_txn[1], node_txn[0]);
4960 }
4961
4962 #[test]
4963 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4964         let chanmon_cfgs = create_chanmon_cfgs(2);
4965         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4966         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4967         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4968
4969         // Create some initial channels
4970         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4971
4972         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4973         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4974         assert_eq!(revoked_local_txn[0].input.len(), 1);
4975         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4976
4977         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4978
4979         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4980         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4981         check_closed_broadcast!(nodes[1], false);
4982         check_added_monitors!(nodes[1], 1);
4983
4984         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4985         assert_eq!(node_txn.len(), 2);
4986         assert_eq!(node_txn[0].input.len(), 2);
4987         check_spends!(node_txn[0], revoked_local_txn[0]);
4988
4989         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4990         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4991         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4992
4993         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4994         assert_eq!(spend_txn.len(), 1);
4995         check_spends!(spend_txn[0], node_txn[0]);
4996 }
4997
4998 #[test]
4999 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5000         let chanmon_cfgs = create_chanmon_cfgs(2);
5001         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5002         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5003         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5004
5005         // Create some initial channels
5006         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5007
5008         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5009         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5010         assert_eq!(revoked_local_txn[0].input.len(), 1);
5011         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5012
5013         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5014
5015         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5016         // A will generate HTLC-Timeout from revoked commitment tx
5017         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5018         check_closed_broadcast!(nodes[0], false);
5019         check_added_monitors!(nodes[0], 1);
5020
5021         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5022         assert_eq!(revoked_htlc_txn.len(), 2);
5023         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5024         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5025         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5026         check_spends!(revoked_htlc_txn[1], chan_1.3);
5027
5028         // B will generate justice tx from A's revoked commitment/HTLC tx
5029         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5030         check_closed_broadcast!(nodes[1], false);
5031         check_added_monitors!(nodes[1], 1);
5032
5033         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5034         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5035         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5036         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5037         // transactions next...
5038         assert_eq!(node_txn[0].input.len(), 3);
5039         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5040
5041         assert_eq!(node_txn[1].input.len(), 2);
5042         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5043         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5044                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5045         } else {
5046                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5047                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5048         }
5049
5050         assert_eq!(node_txn[2].input.len(), 1);
5051         check_spends!(node_txn[2], chan_1.3);
5052
5053         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5054         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5055         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5056
5057         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5058         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5059         assert_eq!(spend_txn.len(), 1);
5060         assert_eq!(spend_txn[0].input.len(), 1);
5061         check_spends!(spend_txn[0], node_txn[1]);
5062 }
5063
5064 #[test]
5065 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5066         let chanmon_cfgs = create_chanmon_cfgs(2);
5067         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5068         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5069         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5070
5071         // Create some initial channels
5072         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5073
5074         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5075         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5076         assert_eq!(revoked_local_txn[0].input.len(), 1);
5077         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5078
5079         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5080         assert_eq!(revoked_local_txn[0].output.len(), 2);
5081
5082         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5083
5084         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5085         // B will generate HTLC-Success from revoked commitment tx
5086         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5087         check_closed_broadcast!(nodes[1], false);
5088         check_added_monitors!(nodes[1], 1);
5089         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5090
5091         assert_eq!(revoked_htlc_txn.len(), 2);
5092         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5093         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5094         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5095
5096         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5097         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5098         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5099
5100         // A will generate justice tx from B's revoked commitment/HTLC tx
5101         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5102         check_closed_broadcast!(nodes[0], false);
5103         check_added_monitors!(nodes[0], 1);
5104
5105         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5106         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5107
5108         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5109         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5110         // transactions next...
5111         assert_eq!(node_txn[0].input.len(), 2);
5112         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5113         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5114                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5115         } else {
5116                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5117                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5118         }
5119
5120         assert_eq!(node_txn[1].input.len(), 1);
5121         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5122
5123         check_spends!(node_txn[2], chan_1.3);
5124
5125         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5126         connect_block(&nodes[0], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5127         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5128
5129         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5130         // didn't try to generate any new transactions.
5131
5132         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5133         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5134         assert_eq!(spend_txn.len(), 2);
5135         assert_eq!(spend_txn[0].input.len(), 1);
5136         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5137         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5138         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5139 }
5140
5141 #[test]
5142 fn test_onchain_to_onchain_claim() {
5143         // Test that in case of channel closure, we detect the state of output and claim HTLC
5144         // on downstream peer's remote commitment tx.
5145         // First, have C claim an HTLC against its own latest commitment transaction.
5146         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5147         // channel.
5148         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5149         // gets broadcast.
5150
5151         let chanmon_cfgs = create_chanmon_cfgs(3);
5152         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5153         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5154         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5155
5156         // Create some initial channels
5157         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5158         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5159
5160         // Rebalance the network a bit by relaying one payment through all the channels ...
5161         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5162         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5163
5164         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5165         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5166         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5167         check_spends!(commitment_tx[0], chan_2.3);
5168         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5169         check_added_monitors!(nodes[2], 1);
5170         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5171         assert!(updates.update_add_htlcs.is_empty());
5172         assert!(updates.update_fail_htlcs.is_empty());
5173         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5174         assert!(updates.update_fail_malformed_htlcs.is_empty());
5175
5176         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5177         check_closed_broadcast!(nodes[2], false);
5178         check_added_monitors!(nodes[2], 1);
5179
5180         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5181         assert_eq!(c_txn.len(), 3);
5182         assert_eq!(c_txn[0], c_txn[2]);
5183         assert_eq!(commitment_tx[0], c_txn[1]);
5184         check_spends!(c_txn[1], chan_2.3);
5185         check_spends!(c_txn[2], c_txn[1]);
5186         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5187         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5188         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5189         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5190
5191         // 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
5192         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5193         {
5194                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5195                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5196                 assert_eq!(b_txn.len(), 3);
5197                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5198                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5199                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5200                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5201                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5202                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5203                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5204                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5205                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5206                 b_txn.clear();
5207         }
5208         check_added_monitors!(nodes[1], 1);
5209         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5210         check_added_monitors!(nodes[1], 1);
5211         match msg_events[0] {
5212                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5213                 _ => panic!("Unexpected event"),
5214         }
5215         match msg_events[1] {
5216                 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, .. } } => {
5217                         assert!(update_add_htlcs.is_empty());
5218                         assert!(update_fail_htlcs.is_empty());
5219                         assert_eq!(update_fulfill_htlcs.len(), 1);
5220                         assert!(update_fail_malformed_htlcs.is_empty());
5221                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5222                 },
5223                 _ => panic!("Unexpected event"),
5224         };
5225         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5226         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5227         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5228         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5229         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5230         assert_eq!(b_txn.len(), 3);
5231         check_spends!(b_txn[1], chan_1.3);
5232         check_spends!(b_txn[2], b_txn[1]);
5233         check_spends!(b_txn[0], commitment_tx[0]);
5234         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5235         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5236         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5237
5238         check_closed_broadcast!(nodes[1], false);
5239         check_added_monitors!(nodes[1], 1);
5240 }
5241
5242 #[test]
5243 fn test_duplicate_payment_hash_one_failure_one_success() {
5244         // Topology : A --> B --> C
5245         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5246         let chanmon_cfgs = create_chanmon_cfgs(3);
5247         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5248         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5249         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5250
5251         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5252         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5253
5254         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5255         *nodes[0].network_payment_count.borrow_mut() -= 1;
5256         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5257
5258         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5259         assert_eq!(commitment_txn[0].input.len(), 1);
5260         check_spends!(commitment_txn[0], chan_2.3);
5261
5262         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5263         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5264         check_closed_broadcast!(nodes[1], false);
5265         check_added_monitors!(nodes[1], 1);
5266
5267         let htlc_timeout_tx;
5268         { // Extract one of the two HTLC-Timeout transaction
5269                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5270                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5271                 assert_eq!(node_txn.len(), 5);
5272                 check_spends!(node_txn[0], commitment_txn[0]);
5273                 assert_eq!(node_txn[0].input.len(), 1);
5274                 check_spends!(node_txn[1], commitment_txn[0]);
5275                 assert_eq!(node_txn[1].input.len(), 1);
5276                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5277                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5278                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5279                 check_spends!(node_txn[2], chan_2.3);
5280                 check_spends!(node_txn[3], node_txn[2]);
5281                 check_spends!(node_txn[4], node_txn[2]);
5282                 htlc_timeout_tx = node_txn[1].clone();
5283         }
5284
5285         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5286         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5287         check_added_monitors!(nodes[2], 3);
5288         let events = nodes[2].node.get_and_clear_pending_msg_events();
5289         match events[0] {
5290                 MessageSendEvent::UpdateHTLCs { .. } => {},
5291                 _ => panic!("Unexpected event"),
5292         }
5293         match events[1] {
5294                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5295                 _ => panic!("Unexepected event"),
5296         }
5297         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5298         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)
5299         check_spends!(htlc_success_txn[2], chan_2.3);
5300         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5301         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5302         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5303         assert_eq!(htlc_success_txn[0].input.len(), 1);
5304         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5305         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5306         assert_eq!(htlc_success_txn[1].input.len(), 1);
5307         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5308         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5309         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5310         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5311
5312         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5313         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
5314         expect_pending_htlcs_forwardable!(nodes[1]);
5315         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5316         assert!(htlc_updates.update_add_htlcs.is_empty());
5317         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5318         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5319         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5320         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5321         check_added_monitors!(nodes[1], 1);
5322
5323         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5324         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5325         {
5326                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5327                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5328                 assert_eq!(events.len(), 1);
5329                 match events[0] {
5330                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5331                         },
5332                         _ => { panic!("Unexpected event"); }
5333                 }
5334         }
5335         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5336
5337         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5338         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5339         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5340         assert!(updates.update_add_htlcs.is_empty());
5341         assert!(updates.update_fail_htlcs.is_empty());
5342         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5343         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5344         assert!(updates.update_fail_malformed_htlcs.is_empty());
5345         check_added_monitors!(nodes[1], 1);
5346
5347         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5348         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5349
5350         let events = nodes[0].node.get_and_clear_pending_events();
5351         match events[0] {
5352                 Event::PaymentSent { ref payment_preimage } => {
5353                         assert_eq!(*payment_preimage, our_payment_preimage);
5354                 }
5355                 _ => panic!("Unexpected event"),
5356         }
5357 }
5358
5359 #[test]
5360 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5361         let chanmon_cfgs = create_chanmon_cfgs(2);
5362         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5363         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5364         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5365
5366         // Create some initial channels
5367         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5368
5369         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5370         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5371         assert_eq!(local_txn[0].input.len(), 1);
5372         check_spends!(local_txn[0], chan_1.3);
5373
5374         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5375         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5376         check_added_monitors!(nodes[1], 1);
5377         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5378         connect_block(&nodes[1], &Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5379         check_added_monitors!(nodes[1], 1);
5380         let events = nodes[1].node.get_and_clear_pending_msg_events();
5381         match events[0] {
5382                 MessageSendEvent::UpdateHTLCs { .. } => {},
5383                 _ => panic!("Unexpected event"),
5384         }
5385         match events[1] {
5386                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5387                 _ => panic!("Unexepected event"),
5388         }
5389         let node_txn = {
5390                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5391                 assert_eq!(node_txn[0].input.len(), 1);
5392                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5393                 check_spends!(node_txn[0], local_txn[0]);
5394                 vec![node_txn[0].clone(), node_txn[2].clone()]
5395         };
5396
5397         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5398         connect_block(&nodes[1], &Block { header: header_201, txdata: node_txn.clone() }, 201);
5399         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5400
5401         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5402         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5403         assert_eq!(spend_txn.len(), 2);
5404         check_spends!(spend_txn[0], node_txn[0]);
5405         check_spends!(spend_txn[1], node_txn[1]);
5406 }
5407
5408 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5409         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5410         // unrevoked commitment transaction.
5411         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5412         // a remote RAA before they could be failed backwards (and combinations thereof).
5413         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5414         // use the same payment hashes.
5415         // Thus, we use a six-node network:
5416         //
5417         // A \         / E
5418         //    - C - D -
5419         // B /         \ F
5420         // And test where C fails back to A/B when D announces its latest commitment transaction
5421         let chanmon_cfgs = create_chanmon_cfgs(6);
5422         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5423         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5424         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5425         let logger = test_utils::TestLogger::new();
5426
5427         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5428         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5429         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5430         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5431         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5432
5433         // Rebalance and check output sanity...
5434         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5435         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5436         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5437
5438         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5439         // 0th HTLC:
5440         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
5441         // 1st HTLC:
5442         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
5443         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5444         let our_node_id = &nodes[1].node.get_our_node_id();
5445         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5446         // 2nd HTLC:
5447         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_1); // not added < dust limit + HTLC tx fee
5448         // 3rd HTLC:
5449         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_2); // not added < dust limit + HTLC tx fee
5450         // 4th HTLC:
5451         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5452         // 5th HTLC:
5453         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5454         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5455         // 6th HTLC:
5456         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5457         // 7th HTLC:
5458         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5459
5460         // 8th HTLC:
5461         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5462         // 9th HTLC:
5463         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5464         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_5); // not added < dust limit + HTLC tx fee
5465
5466         // 10th HTLC:
5467         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
5468         // 11th HTLC:
5469         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5470         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5471
5472         // Double-check that six of the new HTLC were added
5473         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5474         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5475         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5476         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5477
5478         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5479         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5480         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5481         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5482         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5483         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5484         check_added_monitors!(nodes[4], 0);
5485         expect_pending_htlcs_forwardable!(nodes[4]);
5486         check_added_monitors!(nodes[4], 1);
5487
5488         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5489         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5490         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5491         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5492         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5493         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5494
5495         // Fail 3rd below-dust and 7th above-dust HTLCs
5496         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5497         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5498         check_added_monitors!(nodes[5], 0);
5499         expect_pending_htlcs_forwardable!(nodes[5]);
5500         check_added_monitors!(nodes[5], 1);
5501
5502         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5503         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5504         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5505         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5506
5507         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5508
5509         expect_pending_htlcs_forwardable!(nodes[3]);
5510         check_added_monitors!(nodes[3], 1);
5511         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5512         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5513         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5514         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5515         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5516         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5517         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5518         if deliver_last_raa {
5519                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5520         } else {
5521                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5522         }
5523
5524         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5525         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5526         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5527         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5528         //
5529         // We now broadcast the latest commitment transaction, which *should* result in failures for
5530         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5531         // the non-broadcast above-dust HTLCs.
5532         //
5533         // Alternatively, we may broadcast the previous commitment transaction, which should only
5534         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5535         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5536
5537         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5538         if announce_latest {
5539                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5540         } else {
5541                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5542         }
5543         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, 1, true,  header.block_hash());
5544         check_closed_broadcast!(nodes[2], false);
5545         expect_pending_htlcs_forwardable!(nodes[2]);
5546         check_added_monitors!(nodes[2], 3);
5547
5548         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5549         assert_eq!(cs_msgs.len(), 2);
5550         let mut a_done = false;
5551         for msg in cs_msgs {
5552                 match msg {
5553                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5554                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5555                                 // should be failed-backwards here.
5556                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5557                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5558                                         for htlc in &updates.update_fail_htlcs {
5559                                                 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 });
5560                                         }
5561                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5562                                         assert!(!a_done);
5563                                         a_done = true;
5564                                         &nodes[0]
5565                                 } else {
5566                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5567                                         for htlc in &updates.update_fail_htlcs {
5568                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5569                                         }
5570                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5571                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5572                                         &nodes[1]
5573                                 };
5574                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5575                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5576                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5577                                 if announce_latest {
5578                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5579                                         if *node_id == nodes[0].node.get_our_node_id() {
5580                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5581                                         }
5582                                 }
5583                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5584                         },
5585                         _ => panic!("Unexpected event"),
5586                 }
5587         }
5588
5589         let as_events = nodes[0].node.get_and_clear_pending_events();
5590         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5591         let mut as_failds = HashSet::new();
5592         for event in as_events.iter() {
5593                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5594                         assert!(as_failds.insert(*payment_hash));
5595                         if *payment_hash != payment_hash_2 {
5596                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5597                         } else {
5598                                 assert!(!rejected_by_dest);
5599                         }
5600                 } else { panic!("Unexpected event"); }
5601         }
5602         assert!(as_failds.contains(&payment_hash_1));
5603         assert!(as_failds.contains(&payment_hash_2));
5604         if announce_latest {
5605                 assert!(as_failds.contains(&payment_hash_3));
5606                 assert!(as_failds.contains(&payment_hash_5));
5607         }
5608         assert!(as_failds.contains(&payment_hash_6));
5609
5610         let bs_events = nodes[1].node.get_and_clear_pending_events();
5611         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5612         let mut bs_failds = HashSet::new();
5613         for event in bs_events.iter() {
5614                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5615                         assert!(bs_failds.insert(*payment_hash));
5616                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5617                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5618                         } else {
5619                                 assert!(!rejected_by_dest);
5620                         }
5621                 } else { panic!("Unexpected event"); }
5622         }
5623         assert!(bs_failds.contains(&payment_hash_1));
5624         assert!(bs_failds.contains(&payment_hash_2));
5625         if announce_latest {
5626                 assert!(bs_failds.contains(&payment_hash_4));
5627         }
5628         assert!(bs_failds.contains(&payment_hash_5));
5629
5630         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5631         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5632         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5633         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5634         // PaymentFailureNetworkUpdates.
5635         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5636         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5637         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5638         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5639         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5640                 match event {
5641                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5642                         _ => panic!("Unexpected event"),
5643                 }
5644         }
5645 }
5646
5647 #[test]
5648 fn test_fail_backwards_latest_remote_announce_a() {
5649         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5650 }
5651
5652 #[test]
5653 fn test_fail_backwards_latest_remote_announce_b() {
5654         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5655 }
5656
5657 #[test]
5658 fn test_fail_backwards_previous_remote_announce() {
5659         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5660         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5661         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5662 }
5663
5664 #[test]
5665 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5666         let chanmon_cfgs = create_chanmon_cfgs(2);
5667         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5668         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5669         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5670
5671         // Create some initial channels
5672         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5673
5674         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5675         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5676         assert_eq!(local_txn[0].input.len(), 1);
5677         check_spends!(local_txn[0], chan_1.3);
5678
5679         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5680         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5681         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5682         check_closed_broadcast!(nodes[0], false);
5683         check_added_monitors!(nodes[0], 1);
5684
5685         let htlc_timeout = {
5686                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5687                 assert_eq!(node_txn[0].input.len(), 1);
5688                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5689                 check_spends!(node_txn[0], local_txn[0]);
5690                 node_txn[0].clone()
5691         };
5692
5693         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5694         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5695         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5696         expect_payment_failed!(nodes[0], our_payment_hash, true);
5697
5698         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5699         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5700         assert_eq!(spend_txn.len(), 2);
5701         check_spends!(spend_txn[0], local_txn[0]);
5702         check_spends!(spend_txn[1], htlc_timeout);
5703 }
5704
5705 #[test]
5706 fn test_key_derivation_params() {
5707         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5708         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5709         // let us re-derive the channel key set to then derive a delayed_payment_key.
5710
5711         let chanmon_cfgs = create_chanmon_cfgs(3);
5712
5713         // We manually create the node configuration to backup the seed.
5714         let seed = [42; 32];
5715         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5716         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);
5717         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, node_seed: seed };
5718         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5719         node_cfgs.remove(0);
5720         node_cfgs.insert(0, node);
5721
5722         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5723         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5724
5725         // Create some initial channels
5726         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5727         // for node 0
5728         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5729         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5730         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5731
5732         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5733         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5734         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5735         assert_eq!(local_txn_1[0].input.len(), 1);
5736         check_spends!(local_txn_1[0], chan_1.3);
5737
5738         // We check funding pubkey are unique
5739         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]));
5740         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]));
5741         if from_0_funding_key_0 == from_1_funding_key_0
5742             || from_0_funding_key_0 == from_1_funding_key_1
5743             || from_0_funding_key_1 == from_1_funding_key_0
5744             || from_0_funding_key_1 == from_1_funding_key_1 {
5745                 panic!("Funding pubkeys aren't unique");
5746         }
5747
5748         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5749         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5750         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5751         check_closed_broadcast!(nodes[0], false);
5752         check_added_monitors!(nodes[0], 1);
5753
5754         let htlc_timeout = {
5755                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5756                 assert_eq!(node_txn[0].input.len(), 1);
5757                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5758                 check_spends!(node_txn[0], local_txn_1[0]);
5759                 node_txn[0].clone()
5760         };
5761
5762         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5763         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5764         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5765         expect_payment_failed!(nodes[0], our_payment_hash, true);
5766
5767         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5768         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5769         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5770         assert_eq!(spend_txn.len(), 2);
5771         check_spends!(spend_txn[0], local_txn_1[0]);
5772         check_spends!(spend_txn[1], htlc_timeout);
5773 }
5774
5775 #[test]
5776 fn test_static_output_closing_tx() {
5777         let chanmon_cfgs = create_chanmon_cfgs(2);
5778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5780         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5781
5782         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5783
5784         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5785         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5786
5787         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5788         connect_block(&nodes[0], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5789         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5790
5791         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5792         assert_eq!(spend_txn.len(), 1);
5793         check_spends!(spend_txn[0], closing_tx);
5794
5795         connect_block(&nodes[1], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5796         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5797
5798         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5799         assert_eq!(spend_txn.len(), 1);
5800         check_spends!(spend_txn[0], closing_tx);
5801 }
5802
5803 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5804         let chanmon_cfgs = create_chanmon_cfgs(2);
5805         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5806         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5807         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5808         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5809
5810         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5811
5812         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5813         // present in B's local commitment transaction, but none of A's commitment transactions.
5814         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5815         check_added_monitors!(nodes[1], 1);
5816
5817         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5818         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5819         let events = nodes[0].node.get_and_clear_pending_events();
5820         assert_eq!(events.len(), 1);
5821         match events[0] {
5822                 Event::PaymentSent { payment_preimage } => {
5823                         assert_eq!(payment_preimage, our_payment_preimage);
5824                 },
5825                 _ => panic!("Unexpected event"),
5826         }
5827
5828         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5829         check_added_monitors!(nodes[0], 1);
5830         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5831         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5832         check_added_monitors!(nodes[1], 1);
5833
5834         let mut block = Block {
5835                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5836                 txdata: vec![],
5837         };
5838         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5839                 connect_block(&nodes[1], &block, i);
5840                 block.header.prev_blockhash = block.block_hash();
5841         }
5842         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5843         check_closed_broadcast!(nodes[1], false);
5844         check_added_monitors!(nodes[1], 1);
5845 }
5846
5847 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5848         let chanmon_cfgs = create_chanmon_cfgs(2);
5849         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5850         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5851         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5852         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5853         let logger = test_utils::TestLogger::new();
5854
5855         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5856         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5857         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(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5858         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5859         check_added_monitors!(nodes[0], 1);
5860
5861         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5862
5863         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5864         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5865         // to "time out" the HTLC.
5866
5867         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5868
5869         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5870                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5871                 header.prev_blockhash = header.block_hash();
5872         }
5873         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5874         check_closed_broadcast!(nodes[0], false);
5875         check_added_monitors!(nodes[0], 1);
5876 }
5877
5878 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5879         let chanmon_cfgs = create_chanmon_cfgs(3);
5880         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5881         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5882         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5883         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5884
5885         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5886         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5887         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5888         // actually revoked.
5889         let htlc_value = if use_dust { 50000 } else { 3000000 };
5890         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5891         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5892         expect_pending_htlcs_forwardable!(nodes[1]);
5893         check_added_monitors!(nodes[1], 1);
5894
5895         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5896         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5897         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5898         check_added_monitors!(nodes[0], 1);
5899         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5900         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5901         check_added_monitors!(nodes[1], 1);
5902         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5903         check_added_monitors!(nodes[1], 1);
5904         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5905
5906         if check_revoke_no_close {
5907                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5908                 check_added_monitors!(nodes[0], 1);
5909         }
5910
5911         let mut block = Block {
5912                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5913                 txdata: vec![],
5914         };
5915         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5916                 connect_block(&nodes[0], &block, i);
5917                 block.header.prev_blockhash = block.block_hash();
5918         }
5919         if !check_revoke_no_close {
5920                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5921                 check_closed_broadcast!(nodes[0], false);
5922                 check_added_monitors!(nodes[0], 1);
5923         } else {
5924                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5925         }
5926 }
5927
5928 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5929 // There are only a few cases to test here:
5930 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5931 //    broadcastable commitment transactions result in channel closure,
5932 //  * its included in an unrevoked-but-previous remote commitment transaction,
5933 //  * its included in the latest remote or local commitment transactions.
5934 // We test each of the three possible commitment transactions individually and use both dust and
5935 // non-dust HTLCs.
5936 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5937 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5938 // tested for at least one of the cases in other tests.
5939 #[test]
5940 fn htlc_claim_single_commitment_only_a() {
5941         do_htlc_claim_local_commitment_only(true);
5942         do_htlc_claim_local_commitment_only(false);
5943
5944         do_htlc_claim_current_remote_commitment_only(true);
5945         do_htlc_claim_current_remote_commitment_only(false);
5946 }
5947
5948 #[test]
5949 fn htlc_claim_single_commitment_only_b() {
5950         do_htlc_claim_previous_remote_commitment_only(true, false);
5951         do_htlc_claim_previous_remote_commitment_only(false, false);
5952         do_htlc_claim_previous_remote_commitment_only(true, true);
5953         do_htlc_claim_previous_remote_commitment_only(false, true);
5954 }
5955
5956 #[test]
5957 #[should_panic]
5958 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5959         let chanmon_cfgs = create_chanmon_cfgs(2);
5960         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5961         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5962         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5963         //Force duplicate channel ids
5964         for node in nodes.iter() {
5965                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5966         }
5967
5968         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5969         let channel_value_satoshis=10000;
5970         let push_msat=10001;
5971         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5972         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5973         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5974
5975         //Create a second channel with a channel_id collision
5976         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5977 }
5978
5979 #[test]
5980 fn bolt2_open_channel_sending_node_checks_part2() {
5981         let chanmon_cfgs = create_chanmon_cfgs(2);
5982         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5983         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5984         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5985
5986         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5987         let channel_value_satoshis=2^24;
5988         let push_msat=10001;
5989         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5990
5991         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5992         let channel_value_satoshis=10000;
5993         // Test when push_msat is equal to 1000 * funding_satoshis.
5994         let push_msat=1000*channel_value_satoshis+1;
5995         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5996
5997         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5998         let channel_value_satoshis=10000;
5999         let push_msat=10001;
6000         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
6001         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6002         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6003
6004         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6005         // 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
6006         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6007
6008         // 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.
6009         assert!(BREAKDOWN_TIMEOUT>0);
6010         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6011
6012         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6013         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6014         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6015
6016         // 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.
6017         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6018         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6019         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6020         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6021         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6022 }
6023
6024 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6025 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6026 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6027 // is no longer affordable once it's freed.
6028 #[test]
6029 fn test_fail_holding_cell_htlc_upon_free() {
6030         let chanmon_cfgs = create_chanmon_cfgs(2);
6031         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6032         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6033         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6034         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6035         let logger = test_utils::TestLogger::new();
6036
6037         // First nodes[0] generates an update_fee, setting the channel's
6038         // pending_update_fee.
6039         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6040         check_added_monitors!(nodes[0], 1);
6041
6042         let events = nodes[0].node.get_and_clear_pending_msg_events();
6043         assert_eq!(events.len(), 1);
6044         let (update_msg, commitment_signed) = match events[0] {
6045                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6046                         (update_fee.as_ref(), commitment_signed)
6047                 },
6048                 _ => panic!("Unexpected event"),
6049         };
6050
6051         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6052
6053         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6054         let channel_reserve = chan_stat.channel_reserve_msat;
6055         let feerate = get_feerate!(nodes[0], chan.2);
6056
6057         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6058         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6059         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6060         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6061         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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6062
6063         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6064         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6065         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6066         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6067
6068         // Flush the pending fee update.
6069         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6070         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6071         check_added_monitors!(nodes[1], 1);
6072         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6073         check_added_monitors!(nodes[0], 1);
6074
6075         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6076         // HTLC, but now that the fee has been raised the payment will now fail, causing
6077         // us to surface its failure to the user.
6078         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6079         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6080         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6081         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6082         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6083
6084         // Check that the payment failed to be sent out.
6085         let events = nodes[0].node.get_and_clear_pending_events();
6086         assert_eq!(events.len(), 1);
6087         match &events[0] {
6088                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6089                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6090                         assert_eq!(*rejected_by_dest, false);
6091                         assert_eq!(*error_code, None);
6092                         assert_eq!(*error_data, None);
6093                 },
6094                 _ => panic!("Unexpected event"),
6095         }
6096 }
6097
6098 // Test that if multiple HTLCs are released from the holding cell and one is
6099 // valid but the other is no longer valid upon release, the valid HTLC can be
6100 // successfully completed while the other one fails as expected.
6101 #[test]
6102 fn test_free_and_fail_holding_cell_htlcs() {
6103         let chanmon_cfgs = create_chanmon_cfgs(2);
6104         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6105         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6106         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6107         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6108         let logger = test_utils::TestLogger::new();
6109
6110         // First nodes[0] generates an update_fee, setting the channel's
6111         // pending_update_fee.
6112         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6113         check_added_monitors!(nodes[0], 1);
6114
6115         let events = nodes[0].node.get_and_clear_pending_msg_events();
6116         assert_eq!(events.len(), 1);
6117         let (update_msg, commitment_signed) = match events[0] {
6118                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6119                         (update_fee.as_ref(), commitment_signed)
6120                 },
6121                 _ => panic!("Unexpected event"),
6122         };
6123
6124         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6125
6126         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6127         let channel_reserve = chan_stat.channel_reserve_msat;
6128         let feerate = get_feerate!(nodes[0], chan.2);
6129
6130         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6131         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6132         let amt_1 = 20000;
6133         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6134         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6135         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6136         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(), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6137         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(), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6138
6139         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6140         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6141         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6142         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6143         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6144         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6145         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6146
6147         // Flush the pending fee update.
6148         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6149         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6150         check_added_monitors!(nodes[1], 1);
6151         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6152         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6153         check_added_monitors!(nodes[0], 2);
6154
6155         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6156         // but now that the fee has been raised the second payment will now fail, causing us
6157         // to surface its failure to the user. The first payment should succeed.
6158         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6159         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6160         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6161         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6162         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6163
6164         // Check that the second payment failed to be sent out.
6165         let events = nodes[0].node.get_and_clear_pending_events();
6166         assert_eq!(events.len(), 1);
6167         match &events[0] {
6168                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6169                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6170                         assert_eq!(*rejected_by_dest, false);
6171                         assert_eq!(*error_code, None);
6172                         assert_eq!(*error_data, None);
6173                 },
6174                 _ => panic!("Unexpected event"),
6175         }
6176
6177         // Complete the first payment and the RAA from the fee update.
6178         let (payment_event, send_raa_event) = {
6179                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6180                 assert_eq!(msgs.len(), 2);
6181                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6182         };
6183         let raa = match send_raa_event {
6184                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6185                 _ => panic!("Unexpected event"),
6186         };
6187         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6188         check_added_monitors!(nodes[1], 1);
6189         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6190         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6191         let events = nodes[1].node.get_and_clear_pending_events();
6192         assert_eq!(events.len(), 1);
6193         match events[0] {
6194                 Event::PendingHTLCsForwardable { .. } => {},
6195                 _ => panic!("Unexpected event"),
6196         }
6197         nodes[1].node.process_pending_htlc_forwards();
6198         let events = nodes[1].node.get_and_clear_pending_events();
6199         assert_eq!(events.len(), 1);
6200         match events[0] {
6201                 Event::PaymentReceived { .. } => {},
6202                 _ => panic!("Unexpected event"),
6203         }
6204         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6205         check_added_monitors!(nodes[1], 1);
6206         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6207         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6208         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6209         let events = nodes[0].node.get_and_clear_pending_events();
6210         assert_eq!(events.len(), 1);
6211         match events[0] {
6212                 Event::PaymentSent { ref payment_preimage } => {
6213                         assert_eq!(*payment_preimage, payment_preimage_1);
6214                 }
6215                 _ => panic!("Unexpected event"),
6216         }
6217 }
6218
6219 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6220 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6221 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6222 // once it's freed.
6223 #[test]
6224 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6225         let chanmon_cfgs = create_chanmon_cfgs(3);
6226         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6227         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6228         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6229         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6230         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6231         let logger = test_utils::TestLogger::new();
6232
6233         // First nodes[1] generates an update_fee, setting the channel's
6234         // pending_update_fee.
6235         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6236         check_added_monitors!(nodes[1], 1);
6237
6238         let events = nodes[1].node.get_and_clear_pending_msg_events();
6239         assert_eq!(events.len(), 1);
6240         let (update_msg, commitment_signed) = match events[0] {
6241                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6242                         (update_fee.as_ref(), commitment_signed)
6243                 },
6244                 _ => panic!("Unexpected event"),
6245         };
6246
6247         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6248
6249         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6250         let channel_reserve = chan_stat.channel_reserve_msat;
6251         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6252
6253         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6254         let feemsat = 239;
6255         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6256         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6257         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6258         let payment_event = {
6259                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6260                 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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6261                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6262                 check_added_monitors!(nodes[0], 1);
6263
6264                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6265                 assert_eq!(events.len(), 1);
6266
6267                 SendEvent::from_event(events.remove(0))
6268         };
6269         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6270         check_added_monitors!(nodes[1], 0);
6271         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6272         expect_pending_htlcs_forwardable!(nodes[1]);
6273
6274         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6275         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6276
6277         // Flush the pending fee update.
6278         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6279         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6280         check_added_monitors!(nodes[2], 1);
6281         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6282         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6283         check_added_monitors!(nodes[1], 2);
6284
6285         // A final RAA message is generated to finalize the fee update.
6286         let events = nodes[1].node.get_and_clear_pending_msg_events();
6287         assert_eq!(events.len(), 1);
6288
6289         let raa_msg = match &events[0] {
6290                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6291                         msg.clone()
6292                 },
6293                 _ => panic!("Unexpected event"),
6294         };
6295
6296         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6297         check_added_monitors!(nodes[2], 1);
6298         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6299
6300         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6301         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6302         assert_eq!(process_htlc_forwards_event.len(), 1);
6303         match &process_htlc_forwards_event[0] {
6304                 &Event::PendingHTLCsForwardable { .. } => {},
6305                 _ => panic!("Unexpected event"),
6306         }
6307
6308         // In response, we call ChannelManager's process_pending_htlc_forwards
6309         nodes[1].node.process_pending_htlc_forwards();
6310         check_added_monitors!(nodes[1], 1);
6311
6312         // This causes the HTLC to be failed backwards.
6313         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6314         assert_eq!(fail_event.len(), 1);
6315         let (fail_msg, commitment_signed) = match &fail_event[0] {
6316                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6317                         assert_eq!(updates.update_add_htlcs.len(), 0);
6318                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6319                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6320                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6321                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6322                 },
6323                 _ => panic!("Unexpected event"),
6324         };
6325
6326         // Pass the failure messages back to nodes[0].
6327         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6328         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6329
6330         // Complete the HTLC failure+removal process.
6331         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6332         check_added_monitors!(nodes[0], 1);
6333         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6334         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6335         check_added_monitors!(nodes[1], 2);
6336         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6337         assert_eq!(final_raa_event.len(), 1);
6338         let raa = match &final_raa_event[0] {
6339                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6340                 _ => panic!("Unexpected event"),
6341         };
6342         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6343         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6344         assert_eq!(fail_msg_event.len(), 1);
6345         match &fail_msg_event[0] {
6346                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6347                 _ => panic!("Unexpected event"),
6348         }
6349         let failure_event = nodes[0].node.get_and_clear_pending_events();
6350         assert_eq!(failure_event.len(), 1);
6351         match &failure_event[0] {
6352                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6353                         assert!(!rejected_by_dest);
6354                 },
6355                 _ => panic!("Unexpected event"),
6356         }
6357         check_added_monitors!(nodes[0], 1);
6358 }
6359
6360 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6361 // 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.
6362 //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.
6363
6364 #[test]
6365 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6366         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6367         let chanmon_cfgs = create_chanmon_cfgs(2);
6368         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6369         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6370         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6371         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6372
6373         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6374         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6375         let logger = test_utils::TestLogger::new();
6376         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6377         route.paths[0][0].fee_msat = 100;
6378
6379         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6380                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6381         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6382         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6383 }
6384
6385 #[test]
6386 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6387         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6388         let chanmon_cfgs = create_chanmon_cfgs(2);
6389         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6390         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6391         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6392         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6393         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6394
6395         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6396         let logger = test_utils::TestLogger::new();
6397         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6398         route.paths[0][0].fee_msat = 0;
6399         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6400                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6401
6402         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6403         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6404 }
6405
6406 #[test]
6407 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6408         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6409         let chanmon_cfgs = create_chanmon_cfgs(2);
6410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6413         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6414
6415         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6416         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6417         let logger = test_utils::TestLogger::new();
6418         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6419         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6420         check_added_monitors!(nodes[0], 1);
6421         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6422         updates.update_add_htlcs[0].amount_msat = 0;
6423
6424         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6425         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6426         check_closed_broadcast!(nodes[1], true).unwrap();
6427         check_added_monitors!(nodes[1], 1);
6428 }
6429
6430 #[test]
6431 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6432         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6433         //It is enforced when constructing a route.
6434         let chanmon_cfgs = create_chanmon_cfgs(2);
6435         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6436         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6437         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6438         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6439         let logger = test_utils::TestLogger::new();
6440
6441         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6442
6443         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6444         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(), None, &[], 100000000, 500000001, &logger).unwrap();
6445         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6446                 assert_eq!(err, &"Channel CLTV overflowed?"));
6447 }
6448
6449 #[test]
6450 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6451         //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.
6452         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6453         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6454         let chanmon_cfgs = create_chanmon_cfgs(2);
6455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6457         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6458         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6459         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6460
6461         let logger = test_utils::TestLogger::new();
6462         for i in 0..max_accepted_htlcs {
6463                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6464                 let payment_event = {
6465                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6466                         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6467                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6468                         check_added_monitors!(nodes[0], 1);
6469
6470                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6471                         assert_eq!(events.len(), 1);
6472                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6473                                 assert_eq!(htlcs[0].htlc_id, i);
6474                         } else {
6475                                 assert!(false);
6476                         }
6477                         SendEvent::from_event(events.remove(0))
6478                 };
6479                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6480                 check_added_monitors!(nodes[1], 0);
6481                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6482
6483                 expect_pending_htlcs_forwardable!(nodes[1]);
6484                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6485         }
6486         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6487         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6488         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6489         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6490                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6491
6492         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6493         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6494 }
6495
6496 #[test]
6497 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6498         //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.
6499         let chanmon_cfgs = create_chanmon_cfgs(2);
6500         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6501         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6502         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6503         let channel_value = 100000;
6504         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6505         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6506
6507         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6508
6509         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6510         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6511         let logger = test_utils::TestLogger::new();
6512         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(), None, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6513         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6514                 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)));
6515
6516         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6517         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);
6518
6519         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6520 }
6521
6522 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6523 #[test]
6524 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6525         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6526         let chanmon_cfgs = create_chanmon_cfgs(2);
6527         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6528         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6529         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6530         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6531         let htlc_minimum_msat: u64;
6532         {
6533                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6534                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6535                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6536         }
6537
6538         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6539         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6540         let logger = test_utils::TestLogger::new();
6541         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(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6542         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6543         check_added_monitors!(nodes[0], 1);
6544         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6545         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6546         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6547         assert!(nodes[1].node.list_channels().is_empty());
6548         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6549         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()));
6550         check_added_monitors!(nodes[1], 1);
6551 }
6552
6553 #[test]
6554 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6555         //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
6556         let chanmon_cfgs = create_chanmon_cfgs(2);
6557         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6558         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6559         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6560         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6561         let logger = test_utils::TestLogger::new();
6562
6563         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6564         let channel_reserve = chan_stat.channel_reserve_msat;
6565         let feerate = get_feerate!(nodes[0], chan.2);
6566         // The 2* and +1 are for the fee spike reserve.
6567         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6568
6569         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6570         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6571         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6572         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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6573         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6574         check_added_monitors!(nodes[0], 1);
6575         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6576
6577         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6578         // at this time channel-initiatee receivers are not required to enforce that senders
6579         // respect the fee_spike_reserve.
6580         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6581         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6582
6583         assert!(nodes[1].node.list_channels().is_empty());
6584         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6585         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6586         check_added_monitors!(nodes[1], 1);
6587 }
6588
6589 #[test]
6590 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6591         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6592         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6593         let chanmon_cfgs = create_chanmon_cfgs(2);
6594         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6595         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6596         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6597         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6598         let logger = test_utils::TestLogger::new();
6599
6600         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6601         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6602
6603         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6604         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6605
6606         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6607         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6608         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6609         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6610
6611         let mut msg = msgs::UpdateAddHTLC {
6612                 channel_id: chan.2,
6613                 htlc_id: 0,
6614                 amount_msat: 1000,
6615                 payment_hash: our_payment_hash,
6616                 cltv_expiry: htlc_cltv,
6617                 onion_routing_packet: onion_packet.clone(),
6618         };
6619
6620         for i in 0..super::channel::OUR_MAX_HTLCS {
6621                 msg.htlc_id = i as u64;
6622                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6623         }
6624         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6625         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6626
6627         assert!(nodes[1].node.list_channels().is_empty());
6628         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6629         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6630         check_added_monitors!(nodes[1], 1);
6631 }
6632
6633 #[test]
6634 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6635         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6636         let chanmon_cfgs = create_chanmon_cfgs(2);
6637         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6638         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6639         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6640         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6641         let logger = test_utils::TestLogger::new();
6642
6643         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6644         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6645         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6646         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6647         check_added_monitors!(nodes[0], 1);
6648         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6649         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6650         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6651
6652         assert!(nodes[1].node.list_channels().is_empty());
6653         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6654         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6655         check_added_monitors!(nodes[1], 1);
6656 }
6657
6658 #[test]
6659 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6660         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6661         let chanmon_cfgs = create_chanmon_cfgs(2);
6662         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6663         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6664         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6665         let logger = test_utils::TestLogger::new();
6666
6667         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6668         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6669         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6670         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6671         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6672         check_added_monitors!(nodes[0], 1);
6673         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6674         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6675         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6676
6677         assert!(nodes[1].node.list_channels().is_empty());
6678         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6679         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6680         check_added_monitors!(nodes[1], 1);
6681 }
6682
6683 #[test]
6684 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6685         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6686         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6687         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6688         let chanmon_cfgs = create_chanmon_cfgs(2);
6689         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6690         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6691         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6692         let logger = test_utils::TestLogger::new();
6693
6694         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6695         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6696         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6697         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6698         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6699         check_added_monitors!(nodes[0], 1);
6700         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6701         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6702
6703         //Disconnect and Reconnect
6704         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6705         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6706         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6707         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6708         assert_eq!(reestablish_1.len(), 1);
6709         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6710         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6711         assert_eq!(reestablish_2.len(), 1);
6712         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6713         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6714         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6715         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6716
6717         //Resend HTLC
6718         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6719         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6720         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6721         check_added_monitors!(nodes[1], 1);
6722         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6723
6724         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6725
6726         assert!(nodes[1].node.list_channels().is_empty());
6727         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6728         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6729         check_added_monitors!(nodes[1], 1);
6730 }
6731
6732 #[test]
6733 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6734         //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.
6735
6736         let chanmon_cfgs = create_chanmon_cfgs(2);
6737         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6738         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6739         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6740         let logger = test_utils::TestLogger::new();
6741         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6742         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6743         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6744         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6745         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6746
6747         check_added_monitors!(nodes[0], 1);
6748         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6749         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6750
6751         let update_msg = msgs::UpdateFulfillHTLC{
6752                 channel_id: chan.2,
6753                 htlc_id: 0,
6754                 payment_preimage: our_payment_preimage,
6755         };
6756
6757         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6758
6759         assert!(nodes[0].node.list_channels().is_empty());
6760         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6761         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()));
6762         check_added_monitors!(nodes[0], 1);
6763 }
6764
6765 #[test]
6766 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6767         //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.
6768
6769         let chanmon_cfgs = create_chanmon_cfgs(2);
6770         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6771         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6772         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6773         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6774         let logger = test_utils::TestLogger::new();
6775
6776         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6777         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6778         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6779         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6780         check_added_monitors!(nodes[0], 1);
6781         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6782         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6783
6784         let update_msg = msgs::UpdateFailHTLC{
6785                 channel_id: chan.2,
6786                 htlc_id: 0,
6787                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6788         };
6789
6790         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6791
6792         assert!(nodes[0].node.list_channels().is_empty());
6793         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6794         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()));
6795         check_added_monitors!(nodes[0], 1);
6796 }
6797
6798 #[test]
6799 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6800         //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.
6801
6802         let chanmon_cfgs = create_chanmon_cfgs(2);
6803         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6804         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6805         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6806         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6807         let logger = test_utils::TestLogger::new();
6808
6809         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6810         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6811         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6812         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6813         check_added_monitors!(nodes[0], 1);
6814         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6815         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6816
6817         let update_msg = msgs::UpdateFailMalformedHTLC{
6818                 channel_id: chan.2,
6819                 htlc_id: 0,
6820                 sha256_of_onion: [1; 32],
6821                 failure_code: 0x8000,
6822         };
6823
6824         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6825
6826         assert!(nodes[0].node.list_channels().is_empty());
6827         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6828         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()));
6829         check_added_monitors!(nodes[0], 1);
6830 }
6831
6832 #[test]
6833 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6834         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6835
6836         let chanmon_cfgs = create_chanmon_cfgs(2);
6837         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6838         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6839         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6840         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6841
6842         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6843
6844         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6845         check_added_monitors!(nodes[1], 1);
6846
6847         let events = nodes[1].node.get_and_clear_pending_msg_events();
6848         assert_eq!(events.len(), 1);
6849         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6850                 match events[0] {
6851                         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, .. } } => {
6852                                 assert!(update_add_htlcs.is_empty());
6853                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6854                                 assert!(update_fail_htlcs.is_empty());
6855                                 assert!(update_fail_malformed_htlcs.is_empty());
6856                                 assert!(update_fee.is_none());
6857                                 update_fulfill_htlcs[0].clone()
6858                         },
6859                         _ => panic!("Unexpected event"),
6860                 }
6861         };
6862
6863         update_fulfill_msg.htlc_id = 1;
6864
6865         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6866
6867         assert!(nodes[0].node.list_channels().is_empty());
6868         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6869         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6870         check_added_monitors!(nodes[0], 1);
6871 }
6872
6873 #[test]
6874 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6875         //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.
6876
6877         let chanmon_cfgs = create_chanmon_cfgs(2);
6878         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6879         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6880         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6881         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6882
6883         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6884
6885         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6886         check_added_monitors!(nodes[1], 1);
6887
6888         let events = nodes[1].node.get_and_clear_pending_msg_events();
6889         assert_eq!(events.len(), 1);
6890         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6891                 match events[0] {
6892                         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, .. } } => {
6893                                 assert!(update_add_htlcs.is_empty());
6894                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6895                                 assert!(update_fail_htlcs.is_empty());
6896                                 assert!(update_fail_malformed_htlcs.is_empty());
6897                                 assert!(update_fee.is_none());
6898                                 update_fulfill_htlcs[0].clone()
6899                         },
6900                         _ => panic!("Unexpected event"),
6901                 }
6902         };
6903
6904         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6905
6906         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6907
6908         assert!(nodes[0].node.list_channels().is_empty());
6909         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6910         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6911         check_added_monitors!(nodes[0], 1);
6912 }
6913
6914 #[test]
6915 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6916         //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.
6917
6918         let chanmon_cfgs = create_chanmon_cfgs(2);
6919         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6920         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6921         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6922         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6923         let logger = test_utils::TestLogger::new();
6924
6925         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6926         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6927         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6928         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6929         check_added_monitors!(nodes[0], 1);
6930
6931         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6932         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6933
6934         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6935         check_added_monitors!(nodes[1], 0);
6936         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6937
6938         let events = nodes[1].node.get_and_clear_pending_msg_events();
6939
6940         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6941                 match events[0] {
6942                         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, .. } } => {
6943                                 assert!(update_add_htlcs.is_empty());
6944                                 assert!(update_fulfill_htlcs.is_empty());
6945                                 assert!(update_fail_htlcs.is_empty());
6946                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6947                                 assert!(update_fee.is_none());
6948                                 update_fail_malformed_htlcs[0].clone()
6949                         },
6950                         _ => panic!("Unexpected event"),
6951                 }
6952         };
6953         update_msg.failure_code &= !0x8000;
6954         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6955
6956         assert!(nodes[0].node.list_channels().is_empty());
6957         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6958         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6959         check_added_monitors!(nodes[0], 1);
6960 }
6961
6962 #[test]
6963 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6964         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6965         //    * 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.
6966
6967         let chanmon_cfgs = create_chanmon_cfgs(3);
6968         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6969         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6970         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6971         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6972         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6973         let logger = test_utils::TestLogger::new();
6974
6975         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6976
6977         //First hop
6978         let mut payment_event = {
6979                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6980                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6981                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6982                 check_added_monitors!(nodes[0], 1);
6983                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6984                 assert_eq!(events.len(), 1);
6985                 SendEvent::from_event(events.remove(0))
6986         };
6987         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6988         check_added_monitors!(nodes[1], 0);
6989         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6990         expect_pending_htlcs_forwardable!(nodes[1]);
6991         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6992         assert_eq!(events_2.len(), 1);
6993         check_added_monitors!(nodes[1], 1);
6994         payment_event = SendEvent::from_event(events_2.remove(0));
6995         assert_eq!(payment_event.msgs.len(), 1);
6996
6997         //Second Hop
6998         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6999         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7000         check_added_monitors!(nodes[2], 0);
7001         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7002
7003         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7004         assert_eq!(events_3.len(), 1);
7005         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7006                 match events_3[0] {
7007                         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 } } => {
7008                                 assert!(update_add_htlcs.is_empty());
7009                                 assert!(update_fulfill_htlcs.is_empty());
7010                                 assert!(update_fail_htlcs.is_empty());
7011                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7012                                 assert!(update_fee.is_none());
7013                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7014                         },
7015                         _ => panic!("Unexpected event"),
7016                 }
7017         };
7018
7019         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7020
7021         check_added_monitors!(nodes[1], 0);
7022         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7023         expect_pending_htlcs_forwardable!(nodes[1]);
7024         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7025         assert_eq!(events_4.len(), 1);
7026
7027         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7028         match events_4[0] {
7029                 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, .. } } => {
7030                         assert!(update_add_htlcs.is_empty());
7031                         assert!(update_fulfill_htlcs.is_empty());
7032                         assert_eq!(update_fail_htlcs.len(), 1);
7033                         assert!(update_fail_malformed_htlcs.is_empty());
7034                         assert!(update_fee.is_none());
7035                 },
7036                 _ => panic!("Unexpected event"),
7037         };
7038
7039         check_added_monitors!(nodes[1], 1);
7040 }
7041
7042 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7043         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7044         // 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
7045         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7046
7047         let chanmon_cfgs = create_chanmon_cfgs(2);
7048         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7049         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7050         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7051         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7052
7053         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7054
7055         // We route 2 dust-HTLCs between A and B
7056         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7057         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7058         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7059
7060         // Cache one local commitment tx as previous
7061         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7062
7063         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7064         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7065         check_added_monitors!(nodes[1], 0);
7066         expect_pending_htlcs_forwardable!(nodes[1]);
7067         check_added_monitors!(nodes[1], 1);
7068
7069         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7070         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7071         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7072         check_added_monitors!(nodes[0], 1);
7073
7074         // Cache one local commitment tx as lastest
7075         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7076
7077         let events = nodes[0].node.get_and_clear_pending_msg_events();
7078         match events[0] {
7079                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7080                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7081                 },
7082                 _ => panic!("Unexpected event"),
7083         }
7084         match events[1] {
7085                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7086                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7087                 },
7088                 _ => panic!("Unexpected event"),
7089         }
7090
7091         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7092         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7093         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7094
7095         if announce_latest {
7096                 connect_block(&nodes[0], &Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7097         } else {
7098                 connect_block(&nodes[0], &Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7099         }
7100
7101         check_closed_broadcast!(nodes[0], false);
7102         check_added_monitors!(nodes[0], 1);
7103
7104         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7105         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true,  header.block_hash());
7106         let events = nodes[0].node.get_and_clear_pending_events();
7107         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7108         assert_eq!(events.len(), 2);
7109         let mut first_failed = false;
7110         for event in events {
7111                 match event {
7112                         Event::PaymentFailed { payment_hash, .. } => {
7113                                 if payment_hash == payment_hash_1 {
7114                                         assert!(!first_failed);
7115                                         first_failed = true;
7116                                 } else {
7117                                         assert_eq!(payment_hash, payment_hash_2);
7118                                 }
7119                         }
7120                         _ => panic!("Unexpected event"),
7121                 }
7122         }
7123 }
7124
7125 #[test]
7126 fn test_failure_delay_dust_htlc_local_commitment() {
7127         do_test_failure_delay_dust_htlc_local_commitment(true);
7128         do_test_failure_delay_dust_htlc_local_commitment(false);
7129 }
7130
7131 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7132         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7133         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7134         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7135         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7136         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7137         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7138
7139         let chanmon_cfgs = create_chanmon_cfgs(3);
7140         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7141         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7142         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7143         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7144
7145         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7146
7147         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7148         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7149
7150         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7151         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7152
7153         // We revoked bs_commitment_tx
7154         if revoked {
7155                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7156                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7157         }
7158
7159         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7160         let mut timeout_tx = Vec::new();
7161         if local {
7162                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7163                 connect_block(&nodes[0], &Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7164                 check_closed_broadcast!(nodes[0], false);
7165                 check_added_monitors!(nodes[0], 1);
7166                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7167                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7168                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7169                 expect_payment_failed!(nodes[0], dust_hash, true);
7170                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7171                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7172                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7173                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7174                 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7175                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7176                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7177                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7178         } else {
7179                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7180                 connect_block(&nodes[0], &Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7181                 check_closed_broadcast!(nodes[0], false);
7182                 check_added_monitors!(nodes[0], 1);
7183                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7184                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7185                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7186                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7187                 if !revoked {
7188                         expect_payment_failed!(nodes[0], dust_hash, true);
7189                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7190                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7191                         connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7192                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7193                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7194                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7195                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7196                 } else {
7197                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7198                         // commitment tx
7199                         let events = nodes[0].node.get_and_clear_pending_events();
7200                         assert_eq!(events.len(), 2);
7201                         let first;
7202                         match events[0] {
7203                                 Event::PaymentFailed { payment_hash, .. } => {
7204                                         if payment_hash == dust_hash { first = true; }
7205                                         else { first = false; }
7206                                 },
7207                                 _ => panic!("Unexpected event"),
7208                         }
7209                         match events[1] {
7210                                 Event::PaymentFailed { payment_hash, .. } => {
7211                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7212                                         else { assert_eq!(payment_hash, dust_hash); }
7213                                 },
7214                                 _ => panic!("Unexpected event"),
7215                         }
7216                 }
7217         }
7218 }
7219
7220 #[test]
7221 fn test_sweep_outbound_htlc_failure_update() {
7222         do_test_sweep_outbound_htlc_failure_update(false, true);
7223         do_test_sweep_outbound_htlc_failure_update(false, false);
7224         do_test_sweep_outbound_htlc_failure_update(true, false);
7225 }
7226
7227 #[test]
7228 fn test_upfront_shutdown_script() {
7229         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7230         // enforce it at shutdown message
7231
7232         let mut config = UserConfig::default();
7233         config.channel_options.announced_channel = true;
7234         config.peer_channel_config_limits.force_announced_channel_preference = false;
7235         config.channel_options.commit_upfront_shutdown_pubkey = false;
7236         let user_cfgs = [None, Some(config), None];
7237         let chanmon_cfgs = create_chanmon_cfgs(3);
7238         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7239         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7240         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7241
7242         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7243         let flags = InitFeatures::known();
7244         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7245         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7246         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7247         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7248         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7249         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7250     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()));
7251         check_added_monitors!(nodes[2], 1);
7252
7253         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7254         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7255         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7256         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7257         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7258         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7259         let events = nodes[2].node.get_and_clear_pending_msg_events();
7260         assert_eq!(events.len(), 1);
7261         match events[0] {
7262                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7263                 _ => panic!("Unexpected event"),
7264         }
7265
7266         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7267         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7268         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7269         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7270         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7271         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7272         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7273         let events = nodes[1].node.get_and_clear_pending_msg_events();
7274         assert_eq!(events.len(), 1);
7275         match events[0] {
7276                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7277                 _ => panic!("Unexpected event"),
7278         }
7279
7280         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7281         // channel smoothly, opt-out is from channel initiator here
7282         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7283         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7284         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7285         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7286         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7287         let events = nodes[0].node.get_and_clear_pending_msg_events();
7288         assert_eq!(events.len(), 1);
7289         match events[0] {
7290                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7291                 _ => panic!("Unexpected event"),
7292         }
7293
7294         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7295         //// channel smoothly
7296         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7297         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7298         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7299         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7300         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7301         let events = nodes[0].node.get_and_clear_pending_msg_events();
7302         assert_eq!(events.len(), 2);
7303         match events[0] {
7304                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7305                 _ => panic!("Unexpected event"),
7306         }
7307         match events[1] {
7308                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7309                 _ => panic!("Unexpected event"),
7310         }
7311 }
7312
7313 #[test]
7314 fn test_user_configurable_csv_delay() {
7315         // We test our channel constructors yield errors when we pass them absurd csv delay
7316
7317         let mut low_our_to_self_config = UserConfig::default();
7318         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7319         let mut high_their_to_self_config = UserConfig::default();
7320         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7321         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7322         let chanmon_cfgs = create_chanmon_cfgs(2);
7323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7325         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7326
7327         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7328         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7329         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7330                 match error {
7331                         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())); },
7332                         _ => panic!("Unexpected event"),
7333                 }
7334         } else { assert!(false) }
7335
7336         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7337         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7338         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7339         open_channel.to_self_delay = 200;
7340         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7341                 match error {
7342                         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()));  },
7343                         _ => panic!("Unexpected event"),
7344                 }
7345         } else { assert!(false); }
7346
7347         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7348         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7349         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()));
7350         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7351         accept_channel.to_self_delay = 200;
7352         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7353         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7354                 match action {
7355                         &ErrorAction::SendErrorMessage { ref msg } => {
7356                                 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()));
7357                         },
7358                         _ => { assert!(false); }
7359                 }
7360         } else { assert!(false); }
7361
7362         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7363         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7364         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7365         open_channel.to_self_delay = 200;
7366         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7367                 match error {
7368                         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())); },
7369                         _ => panic!("Unexpected event"),
7370                 }
7371         } else { assert!(false); }
7372 }
7373
7374 #[test]
7375 fn test_data_loss_protect() {
7376         // We want to be sure that :
7377         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7378         // * we close channel in case of detecting other being fallen behind
7379         // * we are able to claim our own outputs thanks to to_remote being static
7380         let keys_manager;
7381         let persister;
7382         let logger;
7383         let fee_estimator;
7384         let tx_broadcaster;
7385         let chain_source;
7386         let monitor;
7387         let node_state_0;
7388         let chanmon_cfgs = create_chanmon_cfgs(2);
7389         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7390         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7391         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7392
7393         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7394
7395         // Cache node A state before any channel update
7396         let previous_node_state = nodes[0].node.encode();
7397         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7398         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7399
7400         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7401         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7402
7403         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7404         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7405
7406         // Restore node A from previous state
7407         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7408         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7409         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), &keys_manager).unwrap().1;
7410         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7411         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7412         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7413         persister = test_utils::TestPersister::new();
7414         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister);
7415         node_state_0 = {
7416                 let mut channel_monitors = HashMap::new();
7417                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7418                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &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 {
7419                         keys_manager: &keys_manager,
7420                         fee_estimator: &fee_estimator,
7421                         chain_monitor: &monitor,
7422                         logger: &logger,
7423                         tx_broadcaster: &tx_broadcaster,
7424                         default_config: UserConfig::default(),
7425                         channel_monitors,
7426                 }).unwrap().1
7427         };
7428         nodes[0].node = &node_state_0;
7429         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7430         nodes[0].chain_monitor = &monitor;
7431         nodes[0].chain_source = &chain_source;
7432
7433         check_added_monitors!(nodes[0], 1);
7434
7435         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7436         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7437
7438         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7439
7440         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7441         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7442         check_added_monitors!(nodes[0], 1);
7443
7444         {
7445                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7446                 assert_eq!(node_txn.len(), 0);
7447         }
7448
7449         let mut reestablish_1 = Vec::with_capacity(1);
7450         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7451                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7452                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7453                         reestablish_1.push(msg.clone());
7454                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7455                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7456                         match action {
7457                                 &ErrorAction::SendErrorMessage { ref msg } => {
7458                                         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");
7459                                 },
7460                                 _ => panic!("Unexpected event!"),
7461                         }
7462                 } else {
7463                         panic!("Unexpected event")
7464                 }
7465         }
7466
7467         // Check we close channel detecting A is fallen-behind
7468         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7469         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7470         check_added_monitors!(nodes[1], 1);
7471
7472
7473         // Check A is able to claim to_remote output
7474         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7475         assert_eq!(node_txn.len(), 1);
7476         check_spends!(node_txn[0], chan.3);
7477         assert_eq!(node_txn[0].output.len(), 2);
7478         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7479         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7480         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
7481         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7482         assert_eq!(spend_txn.len(), 1);
7483         check_spends!(spend_txn[0], node_txn[0]);
7484 }
7485
7486 #[test]
7487 fn test_check_htlc_underpaying() {
7488         // Send payment through A -> B but A is maliciously
7489         // sending a probe payment (i.e less than expected value0
7490         // to B, B should refuse payment.
7491
7492         let chanmon_cfgs = create_chanmon_cfgs(2);
7493         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7494         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7495         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7496
7497         // Create some initial channels
7498         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7499
7500         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7501
7502         // Node 3 is expecting payment of 100_000 but receive 10_000,
7503         // fail htlc like we didn't know the preimage.
7504         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7505         nodes[1].node.process_pending_htlc_forwards();
7506
7507         let events = nodes[1].node.get_and_clear_pending_msg_events();
7508         assert_eq!(events.len(), 1);
7509         let (update_fail_htlc, commitment_signed) = match events[0] {
7510                 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 } } => {
7511                         assert!(update_add_htlcs.is_empty());
7512                         assert!(update_fulfill_htlcs.is_empty());
7513                         assert_eq!(update_fail_htlcs.len(), 1);
7514                         assert!(update_fail_malformed_htlcs.is_empty());
7515                         assert!(update_fee.is_none());
7516                         (update_fail_htlcs[0].clone(), commitment_signed)
7517                 },
7518                 _ => panic!("Unexpected event"),
7519         };
7520         check_added_monitors!(nodes[1], 1);
7521
7522         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7523         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7524
7525         // 10_000 msat as u64, followed by a height of 99 as u32
7526         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7527         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7528         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7529         nodes[1].node.get_and_clear_pending_events();
7530 }
7531
7532 #[test]
7533 fn test_announce_disable_channels() {
7534         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7535         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7536
7537         let chanmon_cfgs = create_chanmon_cfgs(2);
7538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7540         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7541
7542         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7543         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7544         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7545
7546         // Disconnect peers
7547         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7548         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7549
7550         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7551         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7552         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7553         assert_eq!(msg_events.len(), 3);
7554         for e in msg_events {
7555                 match e {
7556                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7557                                 let short_id = msg.contents.short_channel_id;
7558                                 // Check generated channel_update match list in PendingChannelUpdate
7559                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7560                                         panic!("Generated ChannelUpdate for wrong chan!");
7561                                 }
7562                         },
7563                         _ => panic!("Unexpected event"),
7564                 }
7565         }
7566         // Reconnect peers
7567         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7568         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7569         assert_eq!(reestablish_1.len(), 3);
7570         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7571         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7572         assert_eq!(reestablish_2.len(), 3);
7573
7574         // Reestablish chan_1
7575         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7576         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7577         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7578         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7579         // Reestablish chan_2
7580         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7581         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7582         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7583         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7584         // Reestablish chan_3
7585         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7586         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7587         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7588         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7589
7590         nodes[0].node.timer_chan_freshness_every_min();
7591         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7592 }
7593
7594 #[test]
7595 fn test_bump_penalty_txn_on_revoked_commitment() {
7596         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7597         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7598
7599         let chanmon_cfgs = create_chanmon_cfgs(2);
7600         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7601         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7602         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7603
7604         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7605         let logger = test_utils::TestLogger::new();
7606
7607
7608         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7609         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7610         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(), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7611         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7612
7613         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7614         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7615         assert_eq!(revoked_txn[0].output.len(), 4);
7616         assert_eq!(revoked_txn[0].input.len(), 1);
7617         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7618         let revoked_txid = revoked_txn[0].txid();
7619
7620         let mut penalty_sum = 0;
7621         for outp in revoked_txn[0].output.iter() {
7622                 if outp.script_pubkey.is_v0_p2wsh() {
7623                         penalty_sum += outp.value;
7624                 }
7625         }
7626
7627         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7628         let header_114 = connect_blocks(&nodes[1], 114, 0, false, Default::default());
7629
7630         // Actually revoke tx by claiming a HTLC
7631         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7632         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7633         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7634         check_added_monitors!(nodes[1], 1);
7635
7636         // One or more justice tx should have been broadcast, check it
7637         let penalty_1;
7638         let feerate_1;
7639         {
7640                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7641                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7642                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7643                 assert_eq!(node_txn[0].output.len(), 1);
7644                 check_spends!(node_txn[0], revoked_txn[0]);
7645                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7646                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7647                 penalty_1 = node_txn[0].txid();
7648                 node_txn.clear();
7649         };
7650
7651         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7652         let header = connect_blocks(&nodes[1], 3, 115,  true, header.block_hash());
7653         let mut penalty_2 = penalty_1;
7654         let mut feerate_2 = 0;
7655         {
7656                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7657                 assert_eq!(node_txn.len(), 1);
7658                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7659                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7660                         assert_eq!(node_txn[0].output.len(), 1);
7661                         check_spends!(node_txn[0], revoked_txn[0]);
7662                         penalty_2 = node_txn[0].txid();
7663                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7664                         assert_ne!(penalty_2, penalty_1);
7665                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7666                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7667                         // Verify 25% bump heuristic
7668                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7669                         node_txn.clear();
7670                 }
7671         }
7672         assert_ne!(feerate_2, 0);
7673
7674         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7675         connect_blocks(&nodes[1], 3, 118, true, header);
7676         let penalty_3;
7677         let mut feerate_3 = 0;
7678         {
7679                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7680                 assert_eq!(node_txn.len(), 1);
7681                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7682                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7683                         assert_eq!(node_txn[0].output.len(), 1);
7684                         check_spends!(node_txn[0], revoked_txn[0]);
7685                         penalty_3 = node_txn[0].txid();
7686                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7687                         assert_ne!(penalty_3, penalty_2);
7688                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7689                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7690                         // Verify 25% bump heuristic
7691                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7692                         node_txn.clear();
7693                 }
7694         }
7695         assert_ne!(feerate_3, 0);
7696
7697         nodes[1].node.get_and_clear_pending_events();
7698         nodes[1].node.get_and_clear_pending_msg_events();
7699 }
7700
7701 #[test]
7702 fn test_bump_penalty_txn_on_revoked_htlcs() {
7703         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7704         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7705
7706         let chanmon_cfgs = create_chanmon_cfgs(2);
7707         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7708         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7709         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7710
7711         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7712         // Lock HTLC in both directions
7713         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7714         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7715
7716         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7717         assert_eq!(revoked_local_txn[0].input.len(), 1);
7718         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7719
7720         // Revoke local commitment tx
7721         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7722
7723         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7724         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7725         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7726         check_closed_broadcast!(nodes[1], false);
7727         check_added_monitors!(nodes[1], 1);
7728
7729         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7730         assert_eq!(revoked_htlc_txn.len(), 4);
7731         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7732                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7733                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7734                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7735                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7736                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7737                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7738         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7739                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7740                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7741                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7742                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7743                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7744                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7745         }
7746
7747         // Broadcast set of revoked txn on A
7748         let header_128 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7749         connect_block(&nodes[0], &Block { header: header_128, txdata: vec![revoked_local_txn[0].clone()] }, 128);
7750         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7751         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7752         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7753         let first;
7754         let feerate_1;
7755         let penalty_txn;
7756         {
7757                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7758                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7759                 // Verify claim tx are spending revoked HTLC txn
7760
7761                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7762                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7763                 // which are included in the same block (they are broadcasted because we scan the
7764                 // transactions linearly and generate claims as we go, they likely should be removed in the
7765                 // future).
7766                 assert_eq!(node_txn[0].input.len(), 1);
7767                 check_spends!(node_txn[0], revoked_local_txn[0]);
7768                 assert_eq!(node_txn[1].input.len(), 1);
7769                 check_spends!(node_txn[1], revoked_local_txn[0]);
7770                 assert_eq!(node_txn[2].input.len(), 1);
7771                 check_spends!(node_txn[2], revoked_local_txn[0]);
7772
7773                 // Each of the three justice transactions claim a separate (single) output of the three
7774                 // available, which we check here:
7775                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7776                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7777                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7778
7779                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7780                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7781
7782                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7783                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7784                 // a remote commitment tx has already been confirmed).
7785                 check_spends!(node_txn[3], chan.3);
7786
7787                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7788                 // output, checked above).
7789                 assert_eq!(node_txn[4].input.len(), 2);
7790                 assert_eq!(node_txn[4].output.len(), 1);
7791                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7792
7793                 first = node_txn[4].txid();
7794                 // Store both feerates for later comparison
7795                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7796                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7797                 penalty_txn = vec![node_txn[2].clone()];
7798                 node_txn.clear();
7799         }
7800
7801         // Connect one more block to see if bumped penalty are issued for HTLC txn
7802         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7803         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
7804         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7805         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() }, 131);
7806         {
7807                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7808                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7809
7810                 check_spends!(node_txn[0], revoked_local_txn[0]);
7811                 check_spends!(node_txn[1], revoked_local_txn[0]);
7812                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7813                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7814                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7815                 } else {
7816                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7817                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7818                 }
7819
7820                 node_txn.clear();
7821         };
7822
7823         // Few more blocks to confirm penalty txn
7824         let header_135 = connect_blocks(&nodes[0], 4, 131, true, header_131.block_hash());
7825         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7826         let header_144 = connect_blocks(&nodes[0], 9, 135, true, header_135);
7827         let node_txn = {
7828                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7829                 assert_eq!(node_txn.len(), 1);
7830
7831                 assert_eq!(node_txn[0].input.len(), 2);
7832                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7833                 // Verify bumped tx is different and 25% bump heuristic
7834                 assert_ne!(first, node_txn[0].txid());
7835                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7836                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7837                 assert!(feerate_2 * 100 > feerate_1 * 125);
7838                 let txn = vec![node_txn[0].clone()];
7839                 node_txn.clear();
7840                 txn
7841         };
7842         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7843         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7844         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, 145);
7845         connect_blocks(&nodes[0], 20, 145, true, header_145.block_hash());
7846         {
7847                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7848                 // We verify than no new transaction has been broadcast because previously
7849                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7850                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7851                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7852                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7853                 // up bumped justice generation.
7854                 assert_eq!(node_txn.len(), 0);
7855                 node_txn.clear();
7856         }
7857         check_closed_broadcast!(nodes[0], false);
7858         check_added_monitors!(nodes[0], 1);
7859 }
7860
7861 #[test]
7862 fn test_bump_penalty_txn_on_remote_commitment() {
7863         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7864         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7865
7866         // Create 2 HTLCs
7867         // Provide preimage for one
7868         // Check aggregation
7869
7870         let chanmon_cfgs = create_chanmon_cfgs(2);
7871         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7872         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7873         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7874
7875         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7876         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7877         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7878
7879         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7880         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7881         assert_eq!(remote_txn[0].output.len(), 4);
7882         assert_eq!(remote_txn[0].input.len(), 1);
7883         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7884
7885         // Claim a HTLC without revocation (provide B monitor with preimage)
7886         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7887         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7888         connect_block(&nodes[1], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7889         check_added_monitors!(nodes[1], 2);
7890
7891         // One or more claim tx should have been broadcast, check it
7892         let timeout;
7893         let preimage;
7894         let feerate_timeout;
7895         let feerate_preimage;
7896         {
7897                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7898                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7899                 assert_eq!(node_txn[0].input.len(), 1);
7900                 assert_eq!(node_txn[1].input.len(), 1);
7901                 check_spends!(node_txn[0], remote_txn[0]);
7902                 check_spends!(node_txn[1], remote_txn[0]);
7903                 check_spends!(node_txn[2], chan.3);
7904                 check_spends!(node_txn[3], node_txn[2]);
7905                 check_spends!(node_txn[4], node_txn[2]);
7906                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7907                         timeout = node_txn[0].txid();
7908                         let index = node_txn[0].input[0].previous_output.vout;
7909                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7910                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7911
7912                         preimage = node_txn[1].txid();
7913                         let index = node_txn[1].input[0].previous_output.vout;
7914                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7915                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7916                 } else {
7917                         timeout = node_txn[1].txid();
7918                         let index = node_txn[1].input[0].previous_output.vout;
7919                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7920                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7921
7922                         preimage = node_txn[0].txid();
7923                         let index = node_txn[0].input[0].previous_output.vout;
7924                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7925                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7926                 }
7927                 node_txn.clear();
7928         };
7929         assert_ne!(feerate_timeout, 0);
7930         assert_ne!(feerate_preimage, 0);
7931
7932         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7933         connect_blocks(&nodes[1], 15, 1,  true, header.block_hash());
7934         {
7935                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7936                 assert_eq!(node_txn.len(), 2);
7937                 assert_eq!(node_txn[0].input.len(), 1);
7938                 assert_eq!(node_txn[1].input.len(), 1);
7939                 check_spends!(node_txn[0], remote_txn[0]);
7940                 check_spends!(node_txn[1], remote_txn[0]);
7941                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7942                         let index = node_txn[0].input[0].previous_output.vout;
7943                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7944                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7945                         assert!(new_feerate * 100 > feerate_timeout * 125);
7946                         assert_ne!(timeout, node_txn[0].txid());
7947
7948                         let index = node_txn[1].input[0].previous_output.vout;
7949                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7950                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7951                         assert!(new_feerate * 100 > feerate_preimage * 125);
7952                         assert_ne!(preimage, node_txn[1].txid());
7953                 } else {
7954                         let index = node_txn[1].input[0].previous_output.vout;
7955                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7956                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7957                         assert!(new_feerate * 100 > feerate_timeout * 125);
7958                         assert_ne!(timeout, node_txn[1].txid());
7959
7960                         let index = node_txn[0].input[0].previous_output.vout;
7961                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7962                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7963                         assert!(new_feerate * 100 > feerate_preimage * 125);
7964                         assert_ne!(preimage, node_txn[0].txid());
7965                 }
7966                 node_txn.clear();
7967         }
7968
7969         nodes[1].node.get_and_clear_pending_events();
7970         nodes[1].node.get_and_clear_pending_msg_events();
7971 }
7972
7973 #[test]
7974 fn test_set_outpoints_partial_claiming() {
7975         // - remote party claim tx, new bump tx
7976         // - disconnect remote claiming tx, new bump
7977         // - disconnect tx, see no tx anymore
7978         let chanmon_cfgs = create_chanmon_cfgs(2);
7979         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7980         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7981         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7982
7983         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7984         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7985         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7986
7987         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7988         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7989         assert_eq!(remote_txn.len(), 3);
7990         assert_eq!(remote_txn[0].output.len(), 4);
7991         assert_eq!(remote_txn[0].input.len(), 1);
7992         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7993         check_spends!(remote_txn[1], remote_txn[0]);
7994         check_spends!(remote_txn[2], remote_txn[0]);
7995
7996         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7997         let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
7998         // Provide node A with both preimage
7999         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8000         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8001         check_added_monitors!(nodes[0], 2);
8002         nodes[0].node.get_and_clear_pending_events();
8003         nodes[0].node.get_and_clear_pending_msg_events();
8004
8005         // Connect blocks on node A commitment transaction
8006         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8007         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8008         check_closed_broadcast!(nodes[0], false);
8009         check_added_monitors!(nodes[0], 1);
8010         // Verify node A broadcast tx claiming both HTLCs
8011         {
8012                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8013                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8014                 assert_eq!(node_txn.len(), 4);
8015                 check_spends!(node_txn[0], remote_txn[0]);
8016                 check_spends!(node_txn[1], chan.3);
8017                 check_spends!(node_txn[2], node_txn[1]);
8018                 check_spends!(node_txn[3], node_txn[1]);
8019                 assert_eq!(node_txn[0].input.len(), 2);
8020                 node_txn.clear();
8021         }
8022
8023         // Connect blocks on node B
8024         connect_blocks(&nodes[1], 135, 0, false, Default::default());
8025         check_closed_broadcast!(nodes[1], false);
8026         check_added_monitors!(nodes[1], 1);
8027         // Verify node B broadcast 2 HTLC-timeout txn
8028         let partial_claim_tx = {
8029                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8030                 assert_eq!(node_txn.len(), 3);
8031                 check_spends!(node_txn[1], node_txn[0]);
8032                 check_spends!(node_txn[2], node_txn[0]);
8033                 assert_eq!(node_txn[1].input.len(), 1);
8034                 assert_eq!(node_txn[2].input.len(), 1);
8035                 node_txn[1].clone()
8036         };
8037
8038         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8039         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8040         connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8041         {
8042                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8043                 assert_eq!(node_txn.len(), 1);
8044                 check_spends!(node_txn[0], remote_txn[0]);
8045                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8046                 node_txn.clear();
8047         }
8048         nodes[0].node.get_and_clear_pending_msg_events();
8049
8050         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8051         disconnect_block(&nodes[0], &header, 102);
8052         {
8053                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8054                 assert_eq!(node_txn.len(), 1);
8055                 check_spends!(node_txn[0], remote_txn[0]);
8056                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8057                 node_txn.clear();
8058         }
8059
8060         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8061         disconnect_block(&nodes[0], &header, 101);
8062         connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
8063         {
8064                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8065                 assert_eq!(node_txn.len(), 0);
8066                 node_txn.clear();
8067         }
8068 }
8069
8070 #[test]
8071 fn test_counterparty_raa_skip_no_crash() {
8072         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8073         // commitment transaction, we would have happily carried on and provided them the next
8074         // commitment transaction based on one RAA forward. This would probably eventually have led to
8075         // channel closure, but it would not have resulted in funds loss. Still, our
8076         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8077         // check simply that the channel is closed in response to such an RAA, but don't check whether
8078         // we decide to punish our counterparty for revoking their funds (as we don't currently
8079         // implement that).
8080         let chanmon_cfgs = create_chanmon_cfgs(2);
8081         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8082         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8083         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8084         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8085
8086         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8087         let keys = &guard.by_id.get_mut(&channel_id).unwrap().holder_keys;
8088         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8089         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8090                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8091         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8092
8093         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8094                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8095         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8096         check_added_monitors!(nodes[1], 1);
8097 }
8098
8099 #[test]
8100 fn test_bump_txn_sanitize_tracking_maps() {
8101         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8102         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8103
8104         let chanmon_cfgs = create_chanmon_cfgs(2);
8105         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8106         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8107         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8108
8109         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8110         // Lock HTLC in both directions
8111         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8112         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8113
8114         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8115         assert_eq!(revoked_local_txn[0].input.len(), 1);
8116         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8117
8118         // Revoke local commitment tx
8119         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8120
8121         // Broadcast set of revoked txn on A
8122         let header_128 = connect_blocks(&nodes[0], 128, 0,  false, Default::default());
8123         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8124
8125         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8126         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8127         check_closed_broadcast!(nodes[0], false);
8128         check_added_monitors!(nodes[0], 1);
8129         let penalty_txn = {
8130                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8131                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8132                 check_spends!(node_txn[0], revoked_local_txn[0]);
8133                 check_spends!(node_txn[1], revoked_local_txn[0]);
8134                 check_spends!(node_txn[2], revoked_local_txn[0]);
8135                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8136                 node_txn.clear();
8137                 penalty_txn
8138         };
8139         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8140         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
8141         connect_blocks(&nodes[0], 5, 130,  false, header_130.block_hash());
8142         {
8143                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8144                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8145                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8146                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8147                 }
8148         }
8149 }
8150
8151 #[test]
8152 fn test_override_channel_config() {
8153         let chanmon_cfgs = create_chanmon_cfgs(2);
8154         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8155         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8156         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8157
8158         // Node0 initiates a channel to node1 using the override config.
8159         let mut override_config = UserConfig::default();
8160         override_config.own_channel_config.our_to_self_delay = 200;
8161
8162         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8163
8164         // Assert the channel created by node0 is using the override config.
8165         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8166         assert_eq!(res.channel_flags, 0);
8167         assert_eq!(res.to_self_delay, 200);
8168 }
8169
8170 #[test]
8171 fn test_override_0msat_htlc_minimum() {
8172         let mut zero_config = UserConfig::default();
8173         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8174         let chanmon_cfgs = create_chanmon_cfgs(2);
8175         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8176         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8177         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8178
8179         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8180         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8181         assert_eq!(res.htlc_minimum_msat, 1);
8182
8183         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8184         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8185         assert_eq!(res.htlc_minimum_msat, 1);
8186 }
8187
8188 #[test]
8189 fn test_simple_payment_secret() {
8190         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8191         // features, however.
8192         let chanmon_cfgs = create_chanmon_cfgs(3);
8193         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8194         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8195         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8196
8197         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8198         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8199         let logger = test_utils::TestLogger::new();
8200
8201         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8202         let payment_secret = PaymentSecret([0xdb; 32]);
8203         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8204         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8205         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8206         // Claiming with all the correct values but the wrong secret should result in nothing...
8207         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8208         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8209         // ...but with the right secret we should be able to claim all the way back
8210         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8211 }
8212
8213 #[test]
8214 fn test_simple_mpp() {
8215         // Simple test of sending a multi-path payment.
8216         let chanmon_cfgs = create_chanmon_cfgs(4);
8217         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8218         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8219         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8220
8221         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8222         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8223         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8224         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8225         let logger = test_utils::TestLogger::new();
8226
8227         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8228         let payment_secret = PaymentSecret([0xdb; 32]);
8229         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8230         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8231         let path = route.paths[0].clone();
8232         route.paths.push(path);
8233         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8234         route.paths[0][0].short_channel_id = chan_1_id;
8235         route.paths[0][1].short_channel_id = chan_3_id;
8236         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8237         route.paths[1][0].short_channel_id = chan_2_id;
8238         route.paths[1][1].short_channel_id = chan_4_id;
8239         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8240         // Claiming with all the correct values but the wrong secret should result in nothing...
8241         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8242         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8243         // ...but with the right secret we should be able to claim all the way back
8244         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8245 }
8246
8247 #[test]
8248 fn test_update_err_monitor_lockdown() {
8249         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8250         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8251         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8252         //
8253         // This scenario may happen in a watchtower setup, where watchtower process a block height
8254         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8255         // commitment at same time.
8256
8257         let chanmon_cfgs = create_chanmon_cfgs(2);
8258         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8259         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8260         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8261
8262         // Create some initial channel
8263         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8264         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8265
8266         // Rebalance the network to generate htlc in the two directions
8267         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8268
8269         // Route a HTLC from node 0 to node 1 (but don't settle)
8270         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8271
8272         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8273         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8274         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8275         let persister = test_utils::TestPersister::new();
8276         let watchtower = {
8277                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8278                 let monitor = monitors.get(&outpoint).unwrap();
8279                 let mut w = test_utils::TestVecWriter(Vec::new());
8280                 monitor.write(&mut w).unwrap();
8281                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8282                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8283                 assert!(new_monitor == *monitor);
8284                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister);
8285                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8286                 watchtower
8287         };
8288         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8289         watchtower.chain_monitor.block_connected(&header, &[], 200);
8290
8291         // Try to update ChannelMonitor
8292         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8293         check_added_monitors!(nodes[1], 1);
8294         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8295         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8296         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8297         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8298                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8299                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8300                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8301                 } else { assert!(false); }
8302         } else { assert!(false); };
8303         // Our local monitor is in-sync and hasn't processed yet timeout
8304         check_added_monitors!(nodes[0], 1);
8305         let events = nodes[0].node.get_and_clear_pending_events();
8306         assert_eq!(events.len(), 1);
8307 }
8308
8309 #[test]
8310 fn test_concurrent_monitor_claim() {
8311         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8312         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8313         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8314         // state N+1 confirms. Alice claims output from state N+1.
8315
8316         let chanmon_cfgs = create_chanmon_cfgs(2);
8317         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8318         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8319         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8320
8321         // Create some initial channel
8322         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8323         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8324
8325         // Rebalance the network to generate htlc in the two directions
8326         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8327
8328         // Route a HTLC from node 0 to node 1 (but don't settle)
8329         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8330
8331         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8332         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8333         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8334         let persister = test_utils::TestPersister::new();
8335         let watchtower_alice = {
8336                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8337                 let monitor = monitors.get(&outpoint).unwrap();
8338                 let mut w = test_utils::TestVecWriter(Vec::new());
8339                 monitor.write(&mut w).unwrap();
8340                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8341                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8342                 assert!(new_monitor == *monitor);
8343                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister);
8344                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8345                 watchtower
8346         };
8347         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8348         watchtower_alice.chain_monitor.block_connected(&header, &vec![], 135);
8349
8350         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8351         {
8352                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8353                 assert_eq!(txn.len(), 2);
8354                 txn.clear();
8355         }
8356
8357         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8358         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8359         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8360         let persister = test_utils::TestPersister::new();
8361         let watchtower_bob = {
8362                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8363                 let monitor = monitors.get(&outpoint).unwrap();
8364                 let mut w = test_utils::TestVecWriter(Vec::new());
8365                 monitor.write(&mut w).unwrap();
8366                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8367                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8368                 assert!(new_monitor == *monitor);
8369                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister);
8370                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8371                 watchtower
8372         };
8373         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8374         watchtower_bob.chain_monitor.block_connected(&header, &vec![], 134);
8375
8376         // Route another payment to generate another update with still previous HTLC pending
8377         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8378         {
8379                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8380                 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(), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8381                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8382         }
8383         check_added_monitors!(nodes[1], 1);
8384
8385         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8386         assert_eq!(updates.update_add_htlcs.len(), 1);
8387         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8388         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8389                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8390                         // Watchtower Alice should already have seen the block and reject the update
8391                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8392                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8393                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8394                 } else { assert!(false); }
8395         } else { assert!(false); };
8396         // Our local monitor is in-sync and hasn't processed yet timeout
8397         check_added_monitors!(nodes[0], 1);
8398
8399         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8400         watchtower_bob.chain_monitor.block_connected(&header, &vec![], 135);
8401
8402         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8403         let bob_state_y;
8404         {
8405                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8406                 assert_eq!(txn.len(), 2);
8407                 bob_state_y = txn[0].clone();
8408                 txn.clear();
8409         };
8410
8411         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8412         watchtower_alice.chain_monitor.block_connected(&header, &vec![(0, &bob_state_y)], 136);
8413         {
8414                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8415                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8416                 // the onchain detection of the HTLC output
8417                 assert_eq!(htlc_txn.len(), 2);
8418                 check_spends!(htlc_txn[0], bob_state_y);
8419                 check_spends!(htlc_txn[1], bob_state_y);
8420         }
8421 }
8422
8423 #[test]
8424 fn test_pre_lockin_no_chan_closed_update() {
8425         // Test that if a peer closes a channel in response to a funding_created message we don't
8426         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8427         // message).
8428         //
8429         // Doing so would imply a channel monitor update before the initial channel monitor
8430         // registration, violating our API guarantees.
8431         //
8432         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8433         // then opening a second channel with the same funding output as the first (which is not
8434         // rejected because the first channel does not exist in the ChannelManager) and closing it
8435         // before receiving funding_signed.
8436         let chanmon_cfgs = create_chanmon_cfgs(2);
8437         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8438         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8439         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8440
8441         // Create an initial channel
8442         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8443         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8444         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8445         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8446         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8447
8448         // Move the first channel through the funding flow...
8449         let (temporary_channel_id, _tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8450
8451         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8452         check_added_monitors!(nodes[0], 0);
8453
8454         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8455         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8456         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8457         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8458 }
8459
8460 #[test]
8461 fn test_htlc_no_detection() {
8462         // This test is a mutation to underscore the detection logic bug we had
8463         // before #653. HTLC value routed is above the remaining balance, thus
8464         // inverting HTLC and `to_remote` output. HTLC will come second and
8465         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8466         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8467         // outputs order detection for correct spending children filtring.
8468
8469         let chanmon_cfgs = create_chanmon_cfgs(2);
8470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8472         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8473
8474         // Create some initial channels
8475         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8476
8477         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8478         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8479         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8480         assert_eq!(local_txn[0].input.len(), 1);
8481         assert_eq!(local_txn[0].output.len(), 3);
8482         check_spends!(local_txn[0], chan_1.3);
8483
8484         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8485         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8486         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8487         // We deliberately connect the local tx twice as this should provoke a failure calling
8488         // this test before #653 fix.
8489         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8490         check_closed_broadcast!(nodes[0], false);
8491         check_added_monitors!(nodes[0], 1);
8492
8493         let htlc_timeout = {
8494                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8495                 assert_eq!(node_txn[0].input.len(), 1);
8496                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8497                 check_spends!(node_txn[0], local_txn[0]);
8498                 node_txn[0].clone()
8499         };
8500
8501         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8502         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
8503         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
8504         expect_payment_failed!(nodes[0], our_payment_hash, true);
8505 }
8506
8507 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8508         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8509         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8510         // Carol, Alice would be the upstream node, and Carol the downstream.)
8511         //
8512         // Steps of the test:
8513         // 1) Alice sends a HTLC to Carol through Bob.
8514         // 2) Carol doesn't settle the HTLC.
8515         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8516         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8517         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8518         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8519         // 5) Carol release the preimage to Bob off-chain.
8520         // 6) Bob claims the offered output on the broadcasted commitment.
8521         let chanmon_cfgs = create_chanmon_cfgs(3);
8522         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8523         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8524         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8525
8526         // Create some initial channels
8527         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8528         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8529
8530         // Steps (1) and (2):
8531         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8532         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8533
8534         // Check that Alice's commitment transaction now contains an output for this HTLC.
8535         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8536         check_spends!(alice_txn[0], chan_ab.3);
8537         assert_eq!(alice_txn[0].output.len(), 2);
8538         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8539         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8540         assert_eq!(alice_txn.len(), 2);
8541
8542         // Steps (3) and (4):
8543         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8544         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8545         let mut force_closing_node = 0; // Alice force-closes
8546         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8547         nodes[force_closing_node].node.force_close_channel(&chan_ab.2);
8548         check_closed_broadcast!(nodes[force_closing_node], false);
8549         check_added_monitors!(nodes[force_closing_node], 1);
8550         if go_onchain_before_fulfill {
8551                 let txn_to_broadcast = match broadcast_alice {
8552                         true => alice_txn.clone(),
8553                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8554                 };
8555                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8556                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, 1);
8557                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8558                 if broadcast_alice {
8559                         check_closed_broadcast!(nodes[1], false);
8560                         check_added_monitors!(nodes[1], 1);
8561                 }
8562                 assert_eq!(bob_txn.len(), 1);
8563                 check_spends!(bob_txn[0], chan_ab.3);
8564         }
8565
8566         // Step (5):
8567         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8568         // process of removing the HTLC from their commitment transactions.
8569         assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8570         check_added_monitors!(nodes[2], 1);
8571         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8572         assert!(carol_updates.update_add_htlcs.is_empty());
8573         assert!(carol_updates.update_fail_htlcs.is_empty());
8574         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8575         assert!(carol_updates.update_fee.is_none());
8576         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8577
8578         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8579         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8580         if !go_onchain_before_fulfill && broadcast_alice {
8581                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8582                 assert_eq!(events.len(), 1);
8583                 match events[0] {
8584                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8585                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8586                         },
8587                         _ => panic!("Unexpected event"),
8588                 };
8589         }
8590         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8591         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8592         // Carol<->Bob's updated commitment transaction info.
8593         check_added_monitors!(nodes[1], 2);
8594
8595         let events = nodes[1].node.get_and_clear_pending_msg_events();
8596         assert_eq!(events.len(), 2);
8597         let bob_revocation = match events[0] {
8598                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8599                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8600                         (*msg).clone()
8601                 },
8602                 _ => panic!("Unexpected event"),
8603         };
8604         let bob_updates = match events[1] {
8605                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8606                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8607                         (*updates).clone()
8608                 },
8609                 _ => panic!("Unexpected event"),
8610         };
8611
8612         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8613         check_added_monitors!(nodes[2], 1);
8614         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8615         check_added_monitors!(nodes[2], 1);
8616
8617         let events = nodes[2].node.get_and_clear_pending_msg_events();
8618         assert_eq!(events.len(), 1);
8619         let carol_revocation = match events[0] {
8620                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8621                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8622                         (*msg).clone()
8623                 },
8624                 _ => panic!("Unexpected event"),
8625         };
8626         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8627         check_added_monitors!(nodes[1], 1);
8628
8629         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8630         // here's where we put said channel's commitment tx on-chain.
8631         let mut txn_to_broadcast = alice_txn.clone();
8632         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8633         if !go_onchain_before_fulfill {
8634                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8635                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, 1);
8636                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8637                 if broadcast_alice {
8638                         check_closed_broadcast!(nodes[1], false);
8639                         check_added_monitors!(nodes[1], 1);
8640                 }
8641                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8642                 if broadcast_alice {
8643                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8644                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8645                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8646                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8647                         // broadcasted.
8648                         assert_eq!(bob_txn.len(), 3);
8649                         check_spends!(bob_txn[1], chan_ab.3);
8650                 } else {
8651                         assert_eq!(bob_txn.len(), 2);
8652                         check_spends!(bob_txn[0], chan_ab.3);
8653                 }
8654         }
8655
8656         // Step (6):
8657         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8658         // broadcasted commitment transaction.
8659         {
8660                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8661                 if go_onchain_before_fulfill {
8662                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8663                         assert_eq!(bob_txn.len(), 2);
8664                 }
8665                 let script_weight = match broadcast_alice {
8666                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8667                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8668                 };
8669                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8670                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8671                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8672                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8673                 if broadcast_alice && !go_onchain_before_fulfill {
8674                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8675                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8676                 } else {
8677                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8678                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8679                 }
8680         }
8681 }
8682
8683 #[test]
8684 fn test_onchain_htlc_settlement_after_close() {
8685         do_test_onchain_htlc_settlement_after_close(true, true);
8686         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8687         do_test_onchain_htlc_settlement_after_close(true, false);
8688         do_test_onchain_htlc_settlement_after_close(false, false);
8689 }
8690
8691 #[test]
8692 fn test_duplicate_chan_id() {
8693         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8694         // already open we reject it and keep the old channel.
8695         //
8696         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8697         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8698         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8699         // updating logic for the existing channel.
8700         let chanmon_cfgs = create_chanmon_cfgs(2);
8701         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8702         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8703         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8704
8705         // Create an initial channel
8706         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8707         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8708         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8709         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()));
8710
8711         // Try to create a second channel with the same temporary_channel_id as the first and check
8712         // that it is rejected.
8713         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8714         {
8715                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8716                 assert_eq!(events.len(), 1);
8717                 match events[0] {
8718                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8719                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8720                                 // first (valid) and second (invalid) channels are closed, given they both have
8721                                 // the same non-temporary channel_id. However, currently we do not, so we just
8722                                 // move forward with it.
8723                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8724                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8725                         },
8726                         _ => panic!("Unexpected event"),
8727                 }
8728         }
8729
8730         // Move the first channel through the funding flow...
8731         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8732
8733         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8734         check_added_monitors!(nodes[0], 0);
8735
8736         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8737         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8738         {
8739                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8740                 assert_eq!(added_monitors.len(), 1);
8741                 assert_eq!(added_monitors[0].0, funding_output);
8742                 added_monitors.clear();
8743         }
8744         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8745
8746         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8747         let channel_id = funding_outpoint.to_channel_id();
8748
8749         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8750         // temporary one).
8751
8752         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8753         // Technically this is allowed by the spec, but we don't support it and there's little reason
8754         // to. Still, it shouldn't cause any other issues.
8755         open_chan_msg.temporary_channel_id = channel_id;
8756         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8757         {
8758                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8759                 assert_eq!(events.len(), 1);
8760                 match events[0] {
8761                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8762                                 // Technically, at this point, nodes[1] would be justified in thinking both
8763                                 // channels are closed, but currently we do not, so we just move forward with it.
8764                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8765                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8766                         },
8767                         _ => panic!("Unexpected event"),
8768                 }
8769         }
8770
8771         // Now try to create a second channel which has a duplicate funding output.
8772         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8773         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8774         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8775         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()));
8776         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8777
8778         let funding_created = {
8779                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8780                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8781                 let logger = test_utils::TestLogger::new();
8782                 as_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap()
8783         };
8784         check_added_monitors!(nodes[0], 0);
8785         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8786         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8787         // still needs to be cleared here.
8788         check_added_monitors!(nodes[1], 1);
8789
8790         // ...still, nodes[1] will reject the duplicate channel.
8791         {
8792                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8793                 assert_eq!(events.len(), 1);
8794                 match events[0] {
8795                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8796                                 // Technically, at this point, nodes[1] would be justified in thinking both
8797                                 // channels are closed, but currently we do not, so we just move forward with it.
8798                                 assert_eq!(msg.channel_id, channel_id);
8799                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8800                         },
8801                         _ => panic!("Unexpected event"),
8802                 }
8803         }
8804
8805         // finally, finish creating the original channel and send a payment over it to make sure
8806         // everything is functional.
8807         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8808         {
8809                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8810                 assert_eq!(added_monitors.len(), 1);
8811                 assert_eq!(added_monitors[0].0, funding_output);
8812                 added_monitors.clear();
8813         }
8814
8815         let events_4 = nodes[0].node.get_and_clear_pending_events();
8816         assert_eq!(events_4.len(), 1);
8817         match events_4[0] {
8818                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
8819                         assert_eq!(user_channel_id, 42);
8820                         assert_eq!(*funding_txo, funding_output);
8821                 },
8822                 _ => panic!("Unexpected event"),
8823         };
8824
8825         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8826         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8827         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8828         send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8829 }