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

   1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
   2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
   3 //! claim outputs on-chain.
   4
   5 use chain::transaction::OutPoint;
   6 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
   7 use chain::chaininterface;
   8 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  12 use ln::channelmonitor;
  13 use ln::channel::{Channel, ChannelError};
  14 use ln::{chan_utils, onion_utils};
  15 use routing::router::{Route, RouteHop, get_route};
  16 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  17 use ln::msgs;
  18 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction, OptionalField};
  19 use util::enforcing_trait_impls::EnforcingChannelKeys;
  20 use util::{byte_utils, test_utils};
  21 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  22 use util::errors::APIError;
  23 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
  24 use util::config::UserConfig;
  25
  26 use bitcoin::util::hash::BitcoinHash;
  27 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  28 use bitcoin::hashes::HashEngine;
  29 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  30 use bitcoin::util::bip143;
  31 use bitcoin::util::address::Address;
  32 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  33 use bitcoin::blockdata::block::{Block, BlockHeader};
  34 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  35 use bitcoin::blockdata::script::{Builder, Script};
  36 use bitcoin::blockdata::opcodes;
  37 use bitcoin::blockdata::constants::genesis_block;
  38 use bitcoin::network::constants::Network;
  39
  40 use bitcoin::hashes::sha256::Hash as Sha256;
  41 use bitcoin::hashes::Hash;
  42
  43 use bitcoin::secp256k1::{Secp256k1, Message};
  44 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  45
  46 use regex;
  47
  48 use std::collections::{BTreeSet, HashMap, HashSet};
  49 use std::default::Default;
  50 use std::sync::{Arc, Mutex};
  51 use std::sync::atomic::Ordering;
  52 use std::{mem, io};
  53
  54 use ln::functional_test_utils::*;
  55 use ln::chan_utils::PreCalculatedTxCreationKeys;
  56
  57 #[test]
  58 fn test_insane_channel_opens() {
  59         // Stand up a network of 2 nodes
  60         let chanmon_cfgs = create_chanmon_cfgs(2);
  61         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  62         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  63         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  64
  65         // Instantiate channel parameters where we push the maximum msats given our
  66         // funding satoshis
  67         let channel_value_sat = 31337; // same as funding satoshis
  68         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
  69         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  70
  71         // Have node0 initiate a channel to node1 with aforementioned parameters
  72         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  73
  74         // Extract the channel open message from node0 to node1
  75         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  76
  77         // Test helper that asserts we get the correct error string given a mutator
  78         // that supposedly makes the channel open message insane
  79         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  80                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  81                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  82                 assert_eq!(msg_events.len(), 1);
  83                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  84                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  85                         match action {
  86                                 &ErrorAction::SendErrorMessage { .. } => {
  87                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  88                                 },
  89                                 _ => panic!("unexpected event!"),
  90                         }
  91                 } else { assert!(false); }
  92         };
  93
  94         use ln::channel::MAX_FUNDING_SATOSHIS;
  95         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  96
  97         // Test all mutations that would make the channel open message insane
  98         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 });
  99
 100         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 101
 102         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 });
 103
 104         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 105
 106         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 });
 107
 108         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 });
 109
 110         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 });
 111
 112         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 113
 114         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 115 }
 116
 117 #[test]
 118 fn test_async_inbound_update_fee() {
 119         let chanmon_cfgs = create_chanmon_cfgs(2);
 120         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 121         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 122         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 123         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 124         let logger = test_utils::TestLogger::new();
 125         let channel_id = chan.2;
 126
 127         // balancing
 128         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 129
 130         // A                                        B
 131         // update_fee                            ->
 132         // send (1) commitment_signed            -.
 133         //                                       <- update_add_htlc/commitment_signed
 134         // send (2) RAA (awaiting remote revoke) -.
 135         // (1) commitment_signed is delivered    ->
 136         //                                       .- send (3) RAA (awaiting remote revoke)
 137         // (2) RAA is delivered                  ->
 138         //                                       .- send (4) commitment_signed
 139         //                                       <- (3) RAA is delivered
 140         // send (5) commitment_signed            -.
 141         //                                       <- (4) commitment_signed is delivered
 142         // send (6) RAA                          -.
 143         // (5) commitment_signed is delivered    ->
 144         //                                       <- RAA
 145         // (6) RAA is delivered                  ->
 146
 147         // First nodes[0] generates an update_fee
 148         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 149         check_added_monitors!(nodes[0], 1);
 150
 151         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 152         assert_eq!(events_0.len(), 1);
 153         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 154                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 155                         (update_fee.as_ref(), commitment_signed)
 156                 },
 157                 _ => panic!("Unexpected event"),
 158         };
 159
 160         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 161
 162         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 163         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 164         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 165         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();
 166         check_added_monitors!(nodes[1], 1);
 167
 168         let payment_event = {
 169                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 170                 assert_eq!(events_1.len(), 1);
 171                 SendEvent::from_event(events_1.remove(0))
 172         };
 173         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 174         assert_eq!(payment_event.msgs.len(), 1);
 175
 176         // ...now when the messages get delivered everyone should be happy
 177         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 178         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 179         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 180         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 181         check_added_monitors!(nodes[0], 1);
 182
 183         // deliver(1), generate (3):
 184         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 185         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 186         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 187         check_added_monitors!(nodes[1], 1);
 188
 189         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 190         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 191         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 192         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 193         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 194         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 195         assert!(bs_update.update_fee.is_none()); // (4)
 196         check_added_monitors!(nodes[1], 1);
 197
 198         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 199         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 200         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 201         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 202         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 203         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 204         assert!(as_update.update_fee.is_none()); // (5)
 205         check_added_monitors!(nodes[0], 1);
 206
 207         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 208         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 209         // only (6) so get_event_msg's assert(len == 1) passes
 210         check_added_monitors!(nodes[0], 1);
 211
 212         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 213         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 214         check_added_monitors!(nodes[1], 1);
 215
 216         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 217         check_added_monitors!(nodes[0], 1);
 218
 219         let events_2 = nodes[0].node.get_and_clear_pending_events();
 220         assert_eq!(events_2.len(), 1);
 221         match events_2[0] {
 222                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 223                 _ => panic!("Unexpected event"),
 224         }
 225
 226         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 227         check_added_monitors!(nodes[1], 1);
 228 }
 229
 230 #[test]
 231 fn test_update_fee_unordered_raa() {
 232         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 233         // crash in an earlier version of the update_fee patch)
 234         let chanmon_cfgs = create_chanmon_cfgs(2);
 235         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 236         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 237         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 238         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 239         let channel_id = chan.2;
 240         let logger = test_utils::TestLogger::new();
 241
 242         // balancing
 243         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 244
 245         // First nodes[0] generates an update_fee
 246         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 247         check_added_monitors!(nodes[0], 1);
 248
 249         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 250         assert_eq!(events_0.len(), 1);
 251         let update_msg = match events_0[0] { // (1)
 252                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 253                         update_fee.as_ref()
 254                 },
 255                 _ => panic!("Unexpected event"),
 256         };
 257
 258         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 259
 260         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 261         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 262         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 263         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();
 264         check_added_monitors!(nodes[1], 1);
 265
 266         let payment_event = {
 267                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 268                 assert_eq!(events_1.len(), 1);
 269                 SendEvent::from_event(events_1.remove(0))
 270         };
 271         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 272         assert_eq!(payment_event.msgs.len(), 1);
 273
 274         // ...now when the messages get delivered everyone should be happy
 275         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 276         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 277         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 278         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 279         check_added_monitors!(nodes[0], 1);
 280
 281         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 282         check_added_monitors!(nodes[1], 1);
 283
 284         // We can't continue, sadly, because our (1) now has a bogus signature
 285 }
 286
 287 #[test]
 288 fn test_multi_flight_update_fee() {
 289         let chanmon_cfgs = create_chanmon_cfgs(2);
 290         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 291         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 292         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 293         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 294         let channel_id = chan.2;
 295
 296         // A                                        B
 297         // update_fee/commitment_signed          ->
 298         //                                       .- send (1) RAA and (2) commitment_signed
 299         // update_fee (never committed)          ->
 300         // (3) update_fee                        ->
 301         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 302         // don't track which updates correspond to which revoke_and_ack responses so we're in
 303         // AwaitingRAA mode and will not generate the update_fee yet.
 304         //                                       <- (1) RAA delivered
 305         // (3) is generated and send (4) CS      -.
 306         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 307         // know the per_commitment_point to use for it.
 308         //                                       <- (2) commitment_signed delivered
 309         // revoke_and_ack                        ->
 310         //                                          B should send no response here
 311         // (4) commitment_signed delivered       ->
 312         //                                       <- RAA/commitment_signed delivered
 313         // revoke_and_ack                        ->
 314
 315         // First nodes[0] generates an update_fee
 316         let initial_feerate = get_feerate!(nodes[0], channel_id);
 317         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 318         check_added_monitors!(nodes[0], 1);
 319
 320         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 321         assert_eq!(events_0.len(), 1);
 322         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 323                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 324                         (update_fee.as_ref().unwrap(), commitment_signed)
 325                 },
 326                 _ => panic!("Unexpected event"),
 327         };
 328
 329         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 330         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 331         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 332         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 333         check_added_monitors!(nodes[1], 1);
 334
 335         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 336         // transaction:
 337         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 338         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 339         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 340
 341         // Create the (3) update_fee message that nodes[0] will generate before it does...
 342         let mut update_msg_2 = msgs::UpdateFee {
 343                 channel_id: update_msg_1.channel_id.clone(),
 344                 feerate_per_kw: (initial_feerate + 30) as u32,
 345         };
 346
 347         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 348
 349         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 350         // Deliver (3)
 351         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 352
 353         // Deliver (1), generating (3) and (4)
 354         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 355         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 356         check_added_monitors!(nodes[0], 1);
 357         assert!(as_second_update.update_add_htlcs.is_empty());
 358         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 359         assert!(as_second_update.update_fail_htlcs.is_empty());
 360         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 361         // Check that the update_fee newly generated matches what we delivered:
 362         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 363         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 364
 365         // Deliver (2) commitment_signed
 366         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 367         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 368         check_added_monitors!(nodes[0], 1);
 369         // No commitment_signed so get_event_msg's assert(len == 1) passes
 370
 371         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 372         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 373         check_added_monitors!(nodes[1], 1);
 374
 375         // Delever (4)
 376         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 377         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 378         check_added_monitors!(nodes[1], 1);
 379
 380         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 381         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 382         check_added_monitors!(nodes[0], 1);
 383
 384         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 385         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 386         // No commitment_signed so get_event_msg's assert(len == 1) passes
 387         check_added_monitors!(nodes[0], 1);
 388
 389         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 390         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 391         check_added_monitors!(nodes[1], 1);
 392 }
 393
 394 #[test]
 395 fn test_1_conf_open() {
 396         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 397         // tests that we properly send one in that case.
 398         let mut alice_config = UserConfig::default();
 399         alice_config.own_channel_config.minimum_depth = 1;
 400         alice_config.channel_options.announced_channel = true;
 401         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 402         let mut bob_config = UserConfig::default();
 403         bob_config.own_channel_config.minimum_depth = 1;
 404         bob_config.channel_options.announced_channel = true;
 405         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 406         let chanmon_cfgs = create_chanmon_cfgs(2);
 407         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 408         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 409         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 410
 411         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 412         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 413         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 414
 415         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 416         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 417         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()));
 418
 419         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 420         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 421         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 422
 423         for node in nodes {
 424                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 425                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 426                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 427         }
 428 }
 429
 430 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 431         // Previously, we had issues deserializing channels when we hadn't connected the first block
 432         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 433         // serialization round-trips and simply do steps towards opening a channel and then drop the
 434         // Node objects.
 435
 436         let chanmon_cfgs = create_chanmon_cfgs(2);
 437         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 438         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 439         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 440
 441         if steps & 0b1000_0000 != 0{
 442                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 443                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 444                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 445         }
 446
 447         if steps & 0x0f == 0 { return; }
 448         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 449         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 450
 451         if steps & 0x0f == 1 { return; }
 452         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 453         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 454
 455         if steps & 0x0f == 2 { return; }
 456         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 457
 458         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 459
 460         if steps & 0x0f == 3 { return; }
 461         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 462         check_added_monitors!(nodes[0], 0);
 463         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 464
 465         if steps & 0x0f == 4 { return; }
 466         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 467         {
 468                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 469                 assert_eq!(added_monitors.len(), 1);
 470                 assert_eq!(added_monitors[0].0, funding_output);
 471                 added_monitors.clear();
 472         }
 473         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 474
 475         if steps & 0x0f == 5 { return; }
 476         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 477         {
 478                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 479                 assert_eq!(added_monitors.len(), 1);
 480                 assert_eq!(added_monitors[0].0, funding_output);
 481                 added_monitors.clear();
 482         }
 483
 484         let events_4 = nodes[0].node.get_and_clear_pending_events();
 485         assert_eq!(events_4.len(), 1);
 486         match events_4[0] {
 487                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 488                         assert_eq!(user_channel_id, 42);
 489                         assert_eq!(*funding_txo, funding_output);
 490                 },
 491                 _ => panic!("Unexpected event"),
 492         };
 493
 494         if steps & 0x0f == 6 { return; }
 495         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 496
 497         if steps & 0x0f == 7 { return; }
 498         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 499         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 500 }
 501
 502 #[test]
 503 fn test_sanity_on_in_flight_opens() {
 504         do_test_sanity_on_in_flight_opens(0);
 505         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 506         do_test_sanity_on_in_flight_opens(1);
 507         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 508         do_test_sanity_on_in_flight_opens(2);
 509         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(3);
 511         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 512         do_test_sanity_on_in_flight_opens(4);
 513         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 514         do_test_sanity_on_in_flight_opens(5);
 515         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 516         do_test_sanity_on_in_flight_opens(6);
 517         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 518         do_test_sanity_on_in_flight_opens(7);
 519         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 520         do_test_sanity_on_in_flight_opens(8);
 521         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 522 }
 523
 524 #[test]
 525 fn test_update_fee_vanilla() {
 526         let chanmon_cfgs = create_chanmon_cfgs(2);
 527         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 528         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 529         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 530         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 531         let channel_id = chan.2;
 532
 533         let feerate = get_feerate!(nodes[0], channel_id);
 534         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 535         check_added_monitors!(nodes[0], 1);
 536
 537         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 538         assert_eq!(events_0.len(), 1);
 539         let (update_msg, commitment_signed) = match events_0[0] {
 540                         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 } } => {
 541                         (update_fee.as_ref(), commitment_signed)
 542                 },
 543                 _ => panic!("Unexpected event"),
 544         };
 545         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 546
 547         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 548         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 549         check_added_monitors!(nodes[1], 1);
 550
 551         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 552         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 553         check_added_monitors!(nodes[0], 1);
 554
 555         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 556         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 557         // No commitment_signed so get_event_msg's assert(len == 1) passes
 558         check_added_monitors!(nodes[0], 1);
 559
 560         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 561         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 562         check_added_monitors!(nodes[1], 1);
 563 }
 564
 565 #[test]
 566 fn test_update_fee_that_funder_cannot_afford() {
 567         let chanmon_cfgs = create_chanmon_cfgs(2);
 568         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 569         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 570         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 571         let channel_value = 1888;
 572         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 573         let channel_id = chan.2;
 574
 575         let feerate = 260;
 576         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 577         check_added_monitors!(nodes[0], 1);
 578         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 579
 580         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 581
 582         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 583
 584         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 585         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 586         {
 587                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 588
 589                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 590                 let num_htlcs = commitment_tx.output.len() - 2;
 591                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 592                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 593                 actual_fee = channel_value - actual_fee;
 594                 assert_eq!(total_fee, actual_fee);
 595         }
 596
 597         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 598         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 599         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 600         check_added_monitors!(nodes[0], 1);
 601
 602         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 603
 604         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 605
 606         //While producing the commitment_signed response after handling a received update_fee request the
 607         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 608         //Should produce and error.
 609         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 610         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 611         check_added_monitors!(nodes[1], 1);
 612         check_closed_broadcast!(nodes[1], true);
 613 }
 614
 615 #[test]
 616 fn test_update_fee_with_fundee_update_add_htlc() {
 617         let chanmon_cfgs = create_chanmon_cfgs(2);
 618         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 619         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 620         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 621         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 622         let channel_id = chan.2;
 623         let logger = test_utils::TestLogger::new();
 624
 625         // balancing
 626         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 627
 628         let feerate = get_feerate!(nodes[0], channel_id);
 629         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 630         check_added_monitors!(nodes[0], 1);
 631
 632         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 633         assert_eq!(events_0.len(), 1);
 634         let (update_msg, commitment_signed) = match events_0[0] {
 635                         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 } } => {
 636                         (update_fee.as_ref(), commitment_signed)
 637                 },
 638                 _ => panic!("Unexpected event"),
 639         };
 640         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 641         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 642         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 643         check_added_monitors!(nodes[1], 1);
 644
 645         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 646         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 647         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();
 648
 649         // nothing happens since node[1] is in AwaitingRemoteRevoke
 650         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 651         {
 652                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 653                 assert_eq!(added_monitors.len(), 0);
 654                 added_monitors.clear();
 655         }
 656         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 657         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 658         // node[1] has nothing to do
 659
 660         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 661         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 662         check_added_monitors!(nodes[0], 1);
 663
 664         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 665         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 666         // No commitment_signed so get_event_msg's assert(len == 1) passes
 667         check_added_monitors!(nodes[0], 1);
 668         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 669         check_added_monitors!(nodes[1], 1);
 670         // AwaitingRemoteRevoke ends here
 671
 672         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 673         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 674         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 675         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 676         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 677         assert_eq!(commitment_update.update_fee.is_none(), true);
 678
 679         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 680         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 681         check_added_monitors!(nodes[0], 1);
 682         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 683
 684         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 685         check_added_monitors!(nodes[1], 1);
 686         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 687
 688         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 689         check_added_monitors!(nodes[1], 1);
 690         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 691         // No commitment_signed so get_event_msg's assert(len == 1) passes
 692
 693         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 694         check_added_monitors!(nodes[0], 1);
 695         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 696
 697         expect_pending_htlcs_forwardable!(nodes[0]);
 698
 699         let events = nodes[0].node.get_and_clear_pending_events();
 700         assert_eq!(events.len(), 1);
 701         match events[0] {
 702                 Event::PaymentReceived { .. } => { },
 703                 _ => panic!("Unexpected event"),
 704         };
 705
 706         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 707
 708         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 709         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 710         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 711 }
 712
 713 #[test]
 714 fn test_update_fee() {
 715         let chanmon_cfgs = create_chanmon_cfgs(2);
 716         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 717         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 718         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 719         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 720         let channel_id = chan.2;
 721
 722         // A                                        B
 723         // (1) update_fee/commitment_signed      ->
 724         //                                       <- (2) revoke_and_ack
 725         //                                       .- send (3) commitment_signed
 726         // (4) update_fee/commitment_signed      ->
 727         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 728         //                                       <- (3) commitment_signed delivered
 729         // send (6) revoke_and_ack               -.
 730         //                                       <- (5) deliver revoke_and_ack
 731         // (6) deliver revoke_and_ack            ->
 732         //                                       .- send (7) commitment_signed in response to (4)
 733         //                                       <- (7) deliver commitment_signed
 734         // revoke_and_ack                        ->
 735
 736         // Create and deliver (1)...
 737         let feerate = get_feerate!(nodes[0], channel_id);
 738         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 739         check_added_monitors!(nodes[0], 1);
 740
 741         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 742         assert_eq!(events_0.len(), 1);
 743         let (update_msg, commitment_signed) = match events_0[0] {
 744                         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 } } => {
 745                         (update_fee.as_ref(), commitment_signed)
 746                 },
 747                 _ => panic!("Unexpected event"),
 748         };
 749         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 750
 751         // Generate (2) and (3):
 752         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 753         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 754         check_added_monitors!(nodes[1], 1);
 755
 756         // Deliver (2):
 757         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 758         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 759         check_added_monitors!(nodes[0], 1);
 760
 761         // Create and deliver (4)...
 762         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 763         check_added_monitors!(nodes[0], 1);
 764         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 765         assert_eq!(events_0.len(), 1);
 766         let (update_msg, commitment_signed) = match events_0[0] {
 767                         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 } } => {
 768                         (update_fee.as_ref(), commitment_signed)
 769                 },
 770                 _ => panic!("Unexpected event"),
 771         };
 772
 773         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 774         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 775         check_added_monitors!(nodes[1], 1);
 776         // ... creating (5)
 777         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 778         // No commitment_signed so get_event_msg's assert(len == 1) passes
 779
 780         // Handle (3), creating (6):
 781         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 782         check_added_monitors!(nodes[0], 1);
 783         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 784         // No commitment_signed so get_event_msg's assert(len == 1) passes
 785
 786         // Deliver (5):
 787         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 788         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 789         check_added_monitors!(nodes[0], 1);
 790
 791         // Deliver (6), creating (7):
 792         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 793         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 794         assert!(commitment_update.update_add_htlcs.is_empty());
 795         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 796         assert!(commitment_update.update_fail_htlcs.is_empty());
 797         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 798         assert!(commitment_update.update_fee.is_none());
 799         check_added_monitors!(nodes[1], 1);
 800
 801         // Deliver (7)
 802         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 803         check_added_monitors!(nodes[0], 1);
 804         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 805         // No commitment_signed so get_event_msg's assert(len == 1) passes
 806
 807         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 808         check_added_monitors!(nodes[1], 1);
 809         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 810
 811         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 812         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 813         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 814 }
 815
 816 #[test]
 817 fn pre_funding_lock_shutdown_test() {
 818         // Test sending a shutdown prior to funding_locked after funding generation
 819         let chanmon_cfgs = create_chanmon_cfgs(2);
 820         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 821         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 822         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 823         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 824         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 825         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 826         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 827
 828         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 829         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 830         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 831         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 832         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 833
 834         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 835         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 836         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 837         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 838         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 839         assert!(node_0_none.is_none());
 840
 841         assert!(nodes[0].node.list_channels().is_empty());
 842         assert!(nodes[1].node.list_channels().is_empty());
 843 }
 844
 845 #[test]
 846 fn updates_shutdown_wait() {
 847         // Test sending a shutdown with outstanding updates pending
 848         let chanmon_cfgs = create_chanmon_cfgs(3);
 849         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 850         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 851         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 852         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 853         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 854         let logger = test_utils::TestLogger::new();
 855
 856         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 857
 858         nodes[0].node.close_channel(&chan_1.2).unwrap();
 859         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 860         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 861         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 862         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 863
 864         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 865         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 866
 867         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 868
 869         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 870         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 871         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();
 872         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();
 873         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 874         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 875
 876         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 877         check_added_monitors!(nodes[2], 1);
 878         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 879         assert!(updates.update_add_htlcs.is_empty());
 880         assert!(updates.update_fail_htlcs.is_empty());
 881         assert!(updates.update_fail_malformed_htlcs.is_empty());
 882         assert!(updates.update_fee.is_none());
 883         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 884         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 885         check_added_monitors!(nodes[1], 1);
 886         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 887         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 888
 889         assert!(updates_2.update_add_htlcs.is_empty());
 890         assert!(updates_2.update_fail_htlcs.is_empty());
 891         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 892         assert!(updates_2.update_fee.is_none());
 893         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 894         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 895         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 896
 897         let events = nodes[0].node.get_and_clear_pending_events();
 898         assert_eq!(events.len(), 1);
 899         match events[0] {
 900                 Event::PaymentSent { ref payment_preimage } => {
 901                         assert_eq!(our_payment_preimage, *payment_preimage);
 902                 },
 903                 _ => panic!("Unexpected event"),
 904         }
 905
 906         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 907         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 908         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 909         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 910         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 911         assert!(node_0_none.is_none());
 912
 913         assert!(nodes[0].node.list_channels().is_empty());
 914
 915         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 916         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 917         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 918         assert!(nodes[1].node.list_channels().is_empty());
 919         assert!(nodes[2].node.list_channels().is_empty());
 920 }
 921
 922 #[test]
 923 fn htlc_fail_async_shutdown() {
 924         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 925         let chanmon_cfgs = create_chanmon_cfgs(3);
 926         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 927         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 928         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 929         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 930         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 931         let logger = test_utils::TestLogger::new();
 932
 933         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 934         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 935         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();
 936         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 937         check_added_monitors!(nodes[0], 1);
 938         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 939         assert_eq!(updates.update_add_htlcs.len(), 1);
 940         assert!(updates.update_fulfill_htlcs.is_empty());
 941         assert!(updates.update_fail_htlcs.is_empty());
 942         assert!(updates.update_fail_malformed_htlcs.is_empty());
 943         assert!(updates.update_fee.is_none());
 944
 945         nodes[1].node.close_channel(&chan_1.2).unwrap();
 946         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 947         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 948         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 949
 950         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 951         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 952         check_added_monitors!(nodes[1], 1);
 953         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 954         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 955
 956         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 957         assert!(updates_2.update_add_htlcs.is_empty());
 958         assert!(updates_2.update_fulfill_htlcs.is_empty());
 959         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 960         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 961         assert!(updates_2.update_fee.is_none());
 962
 963         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 964         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 965
 966         expect_payment_failed!(nodes[0], our_payment_hash, false);
 967
 968         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 969         assert_eq!(msg_events.len(), 2);
 970         let node_0_closing_signed = match msg_events[0] {
 971                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 972                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 973                         (*msg).clone()
 974                 },
 975                 _ => panic!("Unexpected event"),
 976         };
 977         match msg_events[1] {
 978                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 979                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 980                 },
 981                 _ => panic!("Unexpected event"),
 982         }
 983
 984         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 985         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 986         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 987         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 988         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 989         assert!(node_0_none.is_none());
 990
 991         assert!(nodes[0].node.list_channels().is_empty());
 992
 993         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 994         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 995         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 996         assert!(nodes[1].node.list_channels().is_empty());
 997         assert!(nodes[2].node.list_channels().is_empty());
 998 }
 999
1000 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1001         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1002         // messages delivered prior to disconnect
1003         let chanmon_cfgs = create_chanmon_cfgs(3);
1004         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1006         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1007         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1008         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1009
1010         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1011
1012         nodes[1].node.close_channel(&chan_1.2).unwrap();
1013         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1014         if recv_count > 0 {
1015                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1016                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1017                 if recv_count > 1 {
1018                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1019                 }
1020         }
1021
1022         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1023         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1024
1025         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1026         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1027         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1028         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1029
1030         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1031         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1032         assert!(node_1_shutdown == node_1_2nd_shutdown);
1033
1034         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1035         let node_0_2nd_shutdown = if recv_count > 0 {
1036                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1037                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1038                 node_0_2nd_shutdown
1039         } else {
1040                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1041                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1042                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1043         };
1044         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1045
1046         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1047         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1048
1049         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1050         check_added_monitors!(nodes[2], 1);
1051         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1052         assert!(updates.update_add_htlcs.is_empty());
1053         assert!(updates.update_fail_htlcs.is_empty());
1054         assert!(updates.update_fail_malformed_htlcs.is_empty());
1055         assert!(updates.update_fee.is_none());
1056         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1057         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1058         check_added_monitors!(nodes[1], 1);
1059         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1060         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1061
1062         assert!(updates_2.update_add_htlcs.is_empty());
1063         assert!(updates_2.update_fail_htlcs.is_empty());
1064         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1065         assert!(updates_2.update_fee.is_none());
1066         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1067         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1068         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1069
1070         let events = nodes[0].node.get_and_clear_pending_events();
1071         assert_eq!(events.len(), 1);
1072         match events[0] {
1073                 Event::PaymentSent { ref payment_preimage } => {
1074                         assert_eq!(our_payment_preimage, *payment_preimage);
1075                 },
1076                 _ => panic!("Unexpected event"),
1077         }
1078
1079         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1080         if recv_count > 0 {
1081                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1082                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1083                 assert!(node_1_closing_signed.is_some());
1084         }
1085
1086         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1087         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1088
1089         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1090         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1091         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1092         if recv_count == 0 {
1093                 // If all closing_signeds weren't delivered we can just resume where we left off...
1094                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1095
1096                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1097                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1098                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1099
1100                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1101                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1102                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1103
1104                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1105                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1106
1107                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1108                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1109                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1110
1111                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1112                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1113                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1114                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1115                 assert!(node_0_none.is_none());
1116         } else {
1117                 // If one node, however, received + responded with an identical closing_signed we end
1118                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1119                 // There isn't really anything better we can do simply, but in the future we might
1120                 // explore storing a set of recently-closed channels that got disconnected during
1121                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1122                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1123                 // transaction.
1124                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1125
1126                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1127                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1128                 assert_eq!(msg_events.len(), 1);
1129                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1130                         match action {
1131                                 &ErrorAction::SendErrorMessage { ref msg } => {
1132                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1133                                         assert_eq!(msg.channel_id, chan_1.2);
1134                                 },
1135                                 _ => panic!("Unexpected event!"),
1136                         }
1137                 } else { panic!("Needed SendErrorMessage close"); }
1138
1139                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1140                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1141                 // closing_signed so we do it ourselves
1142                 check_closed_broadcast!(nodes[0], false);
1143                 check_added_monitors!(nodes[0], 1);
1144         }
1145
1146         assert!(nodes[0].node.list_channels().is_empty());
1147
1148         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1149         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1150         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1151         assert!(nodes[1].node.list_channels().is_empty());
1152         assert!(nodes[2].node.list_channels().is_empty());
1153 }
1154
1155 #[test]
1156 fn test_shutdown_rebroadcast() {
1157         do_test_shutdown_rebroadcast(0);
1158         do_test_shutdown_rebroadcast(1);
1159         do_test_shutdown_rebroadcast(2);
1160 }
1161
1162 #[test]
1163 fn fake_network_test() {
1164         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1165         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1166         let chanmon_cfgs = create_chanmon_cfgs(4);
1167         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1168         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1169         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1170
1171         // Create some initial channels
1172         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1173         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1174         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1175
1176         // Rebalance the network a bit by relaying one payment through all the channels...
1177         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1181
1182         // Send some more payments
1183         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1184         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1185         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1186
1187         // Test failure packets
1188         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1189         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1190
1191         // Add a new channel that skips 3
1192         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1193
1194         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1195         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1196         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1201
1202         // Do some rebalance loop payments, simultaneously
1203         let mut hops = Vec::with_capacity(3);
1204         hops.push(RouteHop {
1205                 pubkey: nodes[2].node.get_our_node_id(),
1206                 node_features: NodeFeatures::empty(),
1207                 short_channel_id: chan_2.0.contents.short_channel_id,
1208                 channel_features: ChannelFeatures::empty(),
1209                 fee_msat: 0,
1210                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1211         });
1212         hops.push(RouteHop {
1213                 pubkey: nodes[3].node.get_our_node_id(),
1214                 node_features: NodeFeatures::empty(),
1215                 short_channel_id: chan_3.0.contents.short_channel_id,
1216                 channel_features: ChannelFeatures::empty(),
1217                 fee_msat: 0,
1218                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1219         });
1220         hops.push(RouteHop {
1221                 pubkey: nodes[1].node.get_our_node_id(),
1222                 node_features: NodeFeatures::empty(),
1223                 short_channel_id: chan_4.0.contents.short_channel_id,
1224                 channel_features: ChannelFeatures::empty(),
1225                 fee_msat: 1000000,
1226                 cltv_expiry_delta: TEST_FINAL_CLTV,
1227         });
1228         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;
1229         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;
1230         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1231
1232         let mut hops = Vec::with_capacity(3);
1233         hops.push(RouteHop {
1234                 pubkey: nodes[3].node.get_our_node_id(),
1235                 node_features: NodeFeatures::empty(),
1236                 short_channel_id: chan_4.0.contents.short_channel_id,
1237                 channel_features: ChannelFeatures::empty(),
1238                 fee_msat: 0,
1239                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1240         });
1241         hops.push(RouteHop {
1242                 pubkey: nodes[2].node.get_our_node_id(),
1243                 node_features: NodeFeatures::empty(),
1244                 short_channel_id: chan_3.0.contents.short_channel_id,
1245                 channel_features: ChannelFeatures::empty(),
1246                 fee_msat: 0,
1247                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1248         });
1249         hops.push(RouteHop {
1250                 pubkey: nodes[1].node.get_our_node_id(),
1251                 node_features: NodeFeatures::empty(),
1252                 short_channel_id: chan_2.0.contents.short_channel_id,
1253                 channel_features: ChannelFeatures::empty(),
1254                 fee_msat: 1000000,
1255                 cltv_expiry_delta: TEST_FINAL_CLTV,
1256         });
1257         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;
1258         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;
1259         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1260
1261         // Claim the rebalances...
1262         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1263         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1264
1265         // Add a duplicate new channel from 2 to 4
1266         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1267
1268         // Send some payments across both channels
1269         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1270         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272
1273
1274         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1275         let events = nodes[0].node.get_and_clear_pending_msg_events();
1276         assert_eq!(events.len(), 0);
1277         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);
1278
1279         //TODO: Test that routes work again here as we've been notified that the channel is full
1280
1281         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1283         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1284
1285         // Close down the channels...
1286         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1287         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1288         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1289         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1290         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1291 }
1292
1293 #[test]
1294 fn holding_cell_htlc_counting() {
1295         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1296         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1297         // commitment dance rounds.
1298         let chanmon_cfgs = create_chanmon_cfgs(3);
1299         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1300         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1301         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1302         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1303         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1304         let logger = test_utils::TestLogger::new();
1305
1306         let mut payments = Vec::new();
1307         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1308                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1309                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1310                 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();
1311                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1312                 payments.push((payment_preimage, payment_hash));
1313         }
1314         check_added_monitors!(nodes[1], 1);
1315
1316         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1317         assert_eq!(events.len(), 1);
1318         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1319         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1320
1321         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1322         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1323         // another HTLC.
1324         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1325         {
1326                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1327                 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();
1328                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1329                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1330                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1331                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1332         }
1333
1334         // This should also be true if we try to forward a payment.
1335         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1336         {
1337                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1338                 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();
1339                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1340                 check_added_monitors!(nodes[0], 1);
1341         }
1342
1343         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1344         assert_eq!(events.len(), 1);
1345         let payment_event = SendEvent::from_event(events.pop().unwrap());
1346         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1347
1348         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1349         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1350         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1351         // fails), the second will process the resulting failure and fail the HTLC backward.
1352         expect_pending_htlcs_forwardable!(nodes[1]);
1353         expect_pending_htlcs_forwardable!(nodes[1]);
1354         check_added_monitors!(nodes[1], 1);
1355
1356         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1357         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1358         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1359
1360         let events = nodes[0].node.get_and_clear_pending_msg_events();
1361         assert_eq!(events.len(), 1);
1362         match events[0] {
1363                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1364                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1365                 },
1366                 _ => panic!("Unexpected event"),
1367         }
1368
1369         expect_payment_failed!(nodes[0], payment_hash_2, false);
1370
1371         // Now forward all the pending HTLCs and claim them back
1372         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1373         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1374         check_added_monitors!(nodes[2], 1);
1375
1376         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1377         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1378         check_added_monitors!(nodes[1], 1);
1379         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1380
1381         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1382         check_added_monitors!(nodes[1], 1);
1383         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1384
1385         for ref update in as_updates.update_add_htlcs.iter() {
1386                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1387         }
1388         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1389         check_added_monitors!(nodes[2], 1);
1390         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1391         check_added_monitors!(nodes[2], 1);
1392         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1393
1394         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1395         check_added_monitors!(nodes[1], 1);
1396         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1397         check_added_monitors!(nodes[1], 1);
1398         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1399
1400         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1401         check_added_monitors!(nodes[2], 1);
1402
1403         expect_pending_htlcs_forwardable!(nodes[2]);
1404
1405         let events = nodes[2].node.get_and_clear_pending_events();
1406         assert_eq!(events.len(), payments.len());
1407         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1408                 match event {
1409                         &Event::PaymentReceived { ref payment_hash, .. } => {
1410                                 assert_eq!(*payment_hash, *hash);
1411                         },
1412                         _ => panic!("Unexpected event"),
1413                 };
1414         }
1415
1416         for (preimage, _) in payments.drain(..) {
1417                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1418         }
1419
1420         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1421 }
1422
1423 #[test]
1424 fn duplicate_htlc_test() {
1425         // Test that we accept duplicate payment_hash HTLCs across the network and that
1426         // claiming/failing them are all separate and don't affect each other
1427         let chanmon_cfgs = create_chanmon_cfgs(6);
1428         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1429         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1430         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1431
1432         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1433         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1434         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1435         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1437         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1438
1439         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1443
1444         *nodes[0].network_payment_count.borrow_mut() -= 1;
1445         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1446
1447         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1448         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1449         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1450 }
1451
1452 #[test]
1453 fn test_duplicate_htlc_different_direction_onchain() {
1454         // Test that ChannelMonitor doesn't generate 2 preimage txn
1455         // when we have 2 HTLCs with same preimage that go across a node
1456         // in opposite directions.
1457         let chanmon_cfgs = create_chanmon_cfgs(2);
1458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1461
1462         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1463         let logger = test_utils::TestLogger::new();
1464
1465         // balancing
1466         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1467
1468         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1469
1470         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1471         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();
1472         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1473
1474         // Provide preimage to node 0 by claiming payment
1475         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1476         check_added_monitors!(nodes[0], 1);
1477
1478         // Broadcast node 1 commitment txn
1479         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1480
1481         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1482         let mut has_both_htlcs = 0; // check htlcs match ones committed
1483         for outp in remote_txn[0].output.iter() {
1484                 if outp.value == 800_000 / 1000 {
1485                         has_both_htlcs += 1;
1486                 } else if outp.value == 900_000 / 1000 {
1487                         has_both_htlcs += 1;
1488                 }
1489         }
1490         assert_eq!(has_both_htlcs, 2);
1491
1492         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1493         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1494         check_added_monitors!(nodes[0], 1);
1495
1496         // Check we only broadcast 1 timeout tx
1497         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1498         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()) };
1499         assert_eq!(claim_txn.len(), 5);
1500         check_spends!(claim_txn[2], chan_1.3);
1501         check_spends!(claim_txn[3], claim_txn[2]);
1502         assert_eq!(htlc_pair.0.input.len(), 1);
1503         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1504         check_spends!(htlc_pair.0, remote_txn[0]);
1505         assert_eq!(htlc_pair.1.input.len(), 1);
1506         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1507         check_spends!(htlc_pair.1, remote_txn[0]);
1508
1509         let events = nodes[0].node.get_and_clear_pending_msg_events();
1510         assert_eq!(events.len(), 2);
1511         for e in events {
1512                 match e {
1513                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1514                         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, .. } } => {
1515                                 assert!(update_add_htlcs.is_empty());
1516                                 assert!(update_fail_htlcs.is_empty());
1517                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1518                                 assert!(update_fail_malformed_htlcs.is_empty());
1519                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1520                         },
1521                         _ => panic!("Unexpected event"),
1522                 }
1523         }
1524 }
1525
1526 #[test]
1527 fn test_basic_channel_reserve() {
1528         let chanmon_cfgs = create_chanmon_cfgs(2);
1529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1531         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1532         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1533         let logger = test_utils::TestLogger::new();
1534
1535         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1536         let channel_reserve = chan_stat.channel_reserve_msat;
1537
1538         // The 2* and +1 are for the fee spike reserve.
1539         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1540         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1541         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1542         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1543         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();
1544         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1545         match err {
1546                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1547                         match &fails[0] {
1548                                 &APIError::ChannelUnavailable{ref err} =>
1549                                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1550                                 _ => panic!("Unexpected error variant"),
1551                         }
1552                 },
1553                 _ => panic!("Unexpected error variant"),
1554         }
1555         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1556         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1557
1558         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1559 }
1560
1561 #[test]
1562 fn test_fee_spike_violation_fails_htlc() {
1563         let chanmon_cfgs = create_chanmon_cfgs(2);
1564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1566         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1567         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1568         let logger = test_utils::TestLogger::new();
1569
1570         macro_rules! get_route_and_payment_hash {
1571                 ($recv_value: expr) => {{
1572                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1573                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1574                         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();
1575                         (route, payment_hash, payment_preimage)
1576                 }}
1577         };
1578
1579         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1580         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1581         let secp_ctx = Secp256k1::new();
1582         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1583
1584         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1585
1586         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1587         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1588         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1589         let msg = msgs::UpdateAddHTLC {
1590                 channel_id: chan.2,
1591                 htlc_id: 0,
1592                 amount_msat: htlc_msat,
1593                 payment_hash: payment_hash,
1594                 cltv_expiry: htlc_cltv,
1595                 onion_routing_packet: onion_packet,
1596         };
1597
1598         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1599
1600         // Now manually create the commitment_signed message corresponding to the update_add
1601         // nodes[0] just sent. In the code for construction of this message, "local" refers
1602         // to the sender of the message, and "remote" refers to the receiver.
1603
1604         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1605
1606         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1607
1608         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1609         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1610         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1611                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1612                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1613                 let chan_keys = local_chan.get_local_keys();
1614                 let pubkeys = chan_keys.pubkeys();
1615                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1616                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1617         };
1618         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1619                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1620                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1621                 let chan_keys = remote_chan.get_local_keys();
1622                 let pubkeys = chan_keys.pubkeys();
1623                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1624                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1625         };
1626
1627         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1628         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1629         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1630         let commit_tx_keys = chan_utils::TxCreationKeys::new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1631                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1632
1633         // Build the remote commitment transaction so we can sign it, and then later use the
1634         // signature for the commitment_signed message.
1635         let local_chan_balance = 1313;
1636         let static_payment_pk = local_payment_point.serialize();
1637         let remote_commit_tx_output = TxOut {
1638                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1639                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1640                                                              .into_script(),
1641                 value: local_chan_balance as u64
1642         };
1643
1644         let local_commit_tx_output = TxOut {
1645                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1646                                                                                BREAKDOWN_TIMEOUT,
1647                                                                                &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1648                                 value: 95000,
1649         };
1650
1651         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1652                 offered: false,
1653                 amount_msat: 3460001,
1654                 cltv_expiry: htlc_cltv,
1655                 payment_hash: payment_hash,
1656                 transaction_output_index: Some(1),
1657         };
1658
1659         let htlc_output = TxOut {
1660                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1661                 value: 3460001 / 1000
1662         };
1663
1664         let commit_tx_obscure_factor = {
1665                 let mut sha = Sha256::engine();
1666                 let remote_payment_point = &remote_payment_point.serialize();
1667                 sha.input(&local_payment_point.serialize());
1668                 sha.input(remote_payment_point);
1669                 let res = Sha256::from_engine(sha).into_inner();
1670
1671                 ((res[26] as u64) << 5*8) |
1672                 ((res[27] as u64) << 4*8) |
1673                 ((res[28] as u64) << 3*8) |
1674                 ((res[29] as u64) << 2*8) |
1675                 ((res[30] as u64) << 1*8) |
1676                 ((res[31] as u64) << 0*8)
1677         };
1678         let commitment_number = 1;
1679         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1680         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1681         let input = TxIn {
1682                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1683                 script_sig: Script::new(),
1684                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1685                 witness: Vec::new(),
1686         };
1687
1688         let commit_tx = Transaction {
1689                 version: 2,
1690                 lock_time,
1691                 input: vec![input],
1692                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1693         };
1694         let res = {
1695                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1696                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1697                 let local_chan_keys = local_chan.get_local_keys();
1698                 let pre_commit_tx_keys = PreCalculatedTxCreationKeys::new(commit_tx_keys);
1699                 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &pre_commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1700         };
1701
1702         let commit_signed_msg = msgs::CommitmentSigned {
1703                 channel_id: chan.2,
1704                 signature: res.0,
1705                 htlc_signatures: res.1
1706         };
1707
1708         // Send the commitment_signed message to the nodes[1].
1709         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1710         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1711
1712         // Send the RAA to nodes[1].
1713         let per_commitment_secret = local_secret;
1714         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1715         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1716         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1717         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1718
1719         let events = nodes[1].node.get_and_clear_pending_msg_events();
1720         assert_eq!(events.len(), 1);
1721         // Make sure the HTLC failed in the way we expect.
1722         match events[0] {
1723                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1724                         assert_eq!(update_fail_htlcs.len(), 1);
1725                         update_fail_htlcs[0].clone()
1726                 },
1727                 _ => panic!("Unexpected event"),
1728         };
1729         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1730
1731         check_added_monitors!(nodes[1], 2);
1732 }
1733
1734 #[test]
1735 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1736         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1737         // Set the fee rate for the channel very high, to the point where the fundee
1738         // sending any amount would result in a channel reserve violation. In this test
1739         // we check that we would be prevented from sending an HTLC in this situation.
1740         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1741         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1742         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1743         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1744         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1745         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1746         let logger = test_utils::TestLogger::new();
1747
1748         macro_rules! get_route_and_payment_hash {
1749                 ($recv_value: expr) => {{
1750                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1751                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1752                         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();
1753                         (route, payment_hash, payment_preimage)
1754                 }}
1755         };
1756
1757         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1758         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1759                 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1760         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1761         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1762 }
1763
1764 #[test]
1765 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1766         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1767         // Set the fee rate for the channel very high, to the point where the funder
1768         // receiving 1 update_add_htlc would result in them closing the channel due
1769         // to channel reserve violation. This close could also happen if the fee went
1770         // up a more realistic amount, but many HTLCs were outstanding at the time of
1771         // the update_add_htlc.
1772         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1773         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1774         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1776         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1777         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1778         let logger = test_utils::TestLogger::new();
1779
1780         macro_rules! get_route_and_payment_hash {
1781                 ($recv_value: expr) => {{
1782                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1783                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1784                         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();
1785                         (route, payment_hash, payment_preimage)
1786                 }}
1787         };
1788
1789         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1790         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1791         let secp_ctx = Secp256k1::new();
1792         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1793         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1794         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1795         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1796         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1797         let msg = msgs::UpdateAddHTLC {
1798                 channel_id: chan.2,
1799                 htlc_id: 1,
1800                 amount_msat: htlc_msat + 1,
1801                 payment_hash: payment_hash,
1802                 cltv_expiry: htlc_cltv,
1803                 onion_routing_packet: onion_packet,
1804         };
1805
1806         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1807         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1808         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1809         assert_eq!(nodes[0].node.list_channels().len(), 0);
1810         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1811         assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1812         check_added_monitors!(nodes[0], 1);
1813 }
1814
1815 #[test]
1816 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1817         let chanmon_cfgs = create_chanmon_cfgs(3);
1818         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1819         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1820         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1821         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1822         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1823         let logger = test_utils::TestLogger::new();
1824
1825         macro_rules! get_route_and_payment_hash {
1826                 ($recv_value: expr) => {{
1827                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1828                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1829                         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();
1830                         (route, payment_hash, payment_preimage)
1831                 }}
1832         };
1833
1834         let feemsat = 239;
1835         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1836         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1837         let feerate = get_feerate!(nodes[0], chan.2);
1838
1839         // Add a 2* and +1 for the fee spike reserve.
1840         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1841         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;
1842         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1843
1844         // Add a pending HTLC.
1845         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1846         let payment_event_1 = {
1847                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1848                 check_added_monitors!(nodes[0], 1);
1849
1850                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1851                 assert_eq!(events.len(), 1);
1852                 SendEvent::from_event(events.remove(0))
1853         };
1854         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1855
1856         // Attempt to trigger a channel reserve violation --> payment failure.
1857         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1858         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;
1859         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1860         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1861
1862         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1863         let secp_ctx = Secp256k1::new();
1864         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1865         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1866         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1867         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1868         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1869         let msg = msgs::UpdateAddHTLC {
1870                 channel_id: chan.2,
1871                 htlc_id: 1,
1872                 amount_msat: htlc_msat + 1,
1873                 payment_hash: our_payment_hash_1,
1874                 cltv_expiry: htlc_cltv,
1875                 onion_routing_packet: onion_packet,
1876         };
1877
1878         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1879         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1880         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1881         assert_eq!(nodes[1].node.list_channels().len(), 1);
1882         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1883         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1884         check_added_monitors!(nodes[1], 1);
1885 }
1886
1887 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1888         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1889 }
1890
1891 #[test]
1892 fn test_channel_reserve_holding_cell_htlcs() {
1893         let chanmon_cfgs = create_chanmon_cfgs(3);
1894         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1895         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1896         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1897         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1898         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1899         let logger = test_utils::TestLogger::new();
1900
1901         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1902         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1903
1904         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1905         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1906
1907         macro_rules! get_route_and_payment_hash {
1908                 ($recv_value: expr) => {{
1909                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1910                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1911                         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();
1912                         (route, payment_hash, payment_preimage)
1913                 }}
1914         };
1915
1916         macro_rules! expect_forward {
1917                 ($node: expr) => {{
1918                         let mut events = $node.node.get_and_clear_pending_msg_events();
1919                         assert_eq!(events.len(), 1);
1920                         check_added_monitors!($node, 1);
1921                         let payment_event = SendEvent::from_event(events.remove(0));
1922                         payment_event
1923                 }}
1924         }
1925
1926         let feemsat = 239; // somehow we know?
1927         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1928         let feerate = get_feerate!(nodes[0], chan_1.2);
1929
1930         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1931
1932         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1933         {
1934                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1935                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1936                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1937                         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)));
1938                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1939                 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);
1940         }
1941
1942         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1943         // nodes[0]'s wealth
1944         loop {
1945                 let amt_msat = recv_value_0 + total_fee_msat;
1946                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1947                 // Also, ensure that each payment has enough to be over the dust limit to
1948                 // ensure it'll be included in each commit tx fee calculation.
1949                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1950                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1951                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1952                         break;
1953                 }
1954                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1955
1956                 let (stat01_, stat11_, stat12_, stat22_) = (
1957                         get_channel_value_stat!(nodes[0], chan_1.2),
1958                         get_channel_value_stat!(nodes[1], chan_1.2),
1959                         get_channel_value_stat!(nodes[1], chan_2.2),
1960                         get_channel_value_stat!(nodes[2], chan_2.2),
1961                 );
1962
1963                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1964                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1965                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1966                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1967                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1968         }
1969
1970         // adding pending output.
1971         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1972         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1973         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1974         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1975         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1976         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1977         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1978         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1979         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1980         // policy.
1981         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1982         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1983         let amt_msat_1 = recv_value_1 + total_fee_msat;
1984
1985         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1986         let payment_event_1 = {
1987                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1988                 check_added_monitors!(nodes[0], 1);
1989
1990                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1991                 assert_eq!(events.len(), 1);
1992                 SendEvent::from_event(events.remove(0))
1993         };
1994         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1995
1996         // channel reserve test with htlc pending output > 0
1997         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1998         {
1999                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2000                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2001                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2002                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2003         }
2004
2005         // split the rest to test holding cell
2006         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2007         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2008         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2009         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2010         {
2011                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2012                 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);
2013         }
2014
2015         // now see if they go through on both sides
2016         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2017         // but this will stuck in the holding cell
2018         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2019         check_added_monitors!(nodes[0], 0);
2020         let events = nodes[0].node.get_and_clear_pending_events();
2021         assert_eq!(events.len(), 0);
2022
2023         // test with outbound holding cell amount > 0
2024         {
2025                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2026                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2027                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2028                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2029                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
2030         }
2031
2032         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2033         // this will also stuck in the holding cell
2034         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2035         check_added_monitors!(nodes[0], 0);
2036         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2037         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2038
2039         // flush the pending htlc
2040         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2041         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2042         check_added_monitors!(nodes[1], 1);
2043
2044         // the pending htlc should be promoted to committed
2045         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2046         check_added_monitors!(nodes[0], 1);
2047         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2048
2049         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2050         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2051         // No commitment_signed so get_event_msg's assert(len == 1) passes
2052         check_added_monitors!(nodes[0], 1);
2053
2054         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2055         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2056         check_added_monitors!(nodes[1], 1);
2057
2058         expect_pending_htlcs_forwardable!(nodes[1]);
2059
2060         let ref payment_event_11 = expect_forward!(nodes[1]);
2061         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2062         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2063
2064         expect_pending_htlcs_forwardable!(nodes[2]);
2065         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2066
2067         // flush the htlcs in the holding cell
2068         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2069         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2070         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2071         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2072         expect_pending_htlcs_forwardable!(nodes[1]);
2073
2074         let ref payment_event_3 = expect_forward!(nodes[1]);
2075         assert_eq!(payment_event_3.msgs.len(), 2);
2076         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2077         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2078
2079         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2080         expect_pending_htlcs_forwardable!(nodes[2]);
2081
2082         let events = nodes[2].node.get_and_clear_pending_events();
2083         assert_eq!(events.len(), 2);
2084         match events[0] {
2085                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2086                         assert_eq!(our_payment_hash_21, *payment_hash);
2087                         assert_eq!(*payment_secret, None);
2088                         assert_eq!(recv_value_21, amt);
2089                 },
2090                 _ => panic!("Unexpected event"),
2091         }
2092         match events[1] {
2093                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2094                         assert_eq!(our_payment_hash_22, *payment_hash);
2095                         assert_eq!(None, *payment_secret);
2096                         assert_eq!(recv_value_22, amt);
2097                 },
2098                 _ => panic!("Unexpected event"),
2099         }
2100
2101         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2102         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2103         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2104
2105         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2106         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2107         {
2108                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2109                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2110                 match err {
2111                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2112                                 match &fails[0] {
2113                                         &APIError::ChannelUnavailable{ref err} =>
2114                                                 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
2115                                         _ => panic!("Unexpected error variant"),
2116                                 }
2117                         },
2118                         _ => panic!("Unexpected error variant"),
2119                 }
2120                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2121                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
2122         }
2123
2124         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2125
2126         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2127         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);
2128         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2129         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2130         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2131
2132         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2133         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2134 }
2135
2136 #[test]
2137 fn channel_reserve_in_flight_removes() {
2138         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2139         // can send to its counterparty, but due to update ordering, the other side may not yet have
2140         // considered those HTLCs fully removed.
2141         // This tests that we don't count HTLCs which will not be included in the next remote
2142         // commitment transaction towards the reserve value (as it implies no commitment transaction
2143         // will be generated which violates the remote reserve value).
2144         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2145         // To test this we:
2146         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2147         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2148         //    you only consider the value of the first HTLC, it may not),
2149         //  * start routing a third HTLC from A to B,
2150         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2151         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2152         //  * deliver the first fulfill from B
2153         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2154         //    claim,
2155         //  * deliver A's response CS and RAA.
2156         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2157         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2158         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2159         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2160         let chanmon_cfgs = create_chanmon_cfgs(2);
2161         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2162         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2163         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2164         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2165         let logger = test_utils::TestLogger::new();
2166
2167         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2168         // Route the first two HTLCs.
2169         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2170         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2171
2172         // Start routing the third HTLC (this is just used to get everyone in the right state).
2173         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2174         let send_1 = {
2175                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2176                 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();
2177                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2178                 check_added_monitors!(nodes[0], 1);
2179                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2180                 assert_eq!(events.len(), 1);
2181                 SendEvent::from_event(events.remove(0))
2182         };
2183
2184         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2185         // initial fulfill/CS.
2186         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2187         check_added_monitors!(nodes[1], 1);
2188         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2189
2190         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2191         // remove the second HTLC when we send the HTLC back from B to A.
2192         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2193         check_added_monitors!(nodes[1], 1);
2194         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2195
2196         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2197         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2198         check_added_monitors!(nodes[0], 1);
2199         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2200         expect_payment_sent!(nodes[0], payment_preimage_1);
2201
2202         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2203         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2204         check_added_monitors!(nodes[1], 1);
2205         // B is already AwaitingRAA, so cant generate a CS here
2206         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2207
2208         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2209         check_added_monitors!(nodes[1], 1);
2210         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2211
2212         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2213         check_added_monitors!(nodes[0], 1);
2214         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2215
2216         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2217         check_added_monitors!(nodes[1], 1);
2218         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2219
2220         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2221         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2222         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2223         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2224         // on-chain as necessary).
2225         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2226         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2227         check_added_monitors!(nodes[0], 1);
2228         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2229         expect_payment_sent!(nodes[0], payment_preimage_2);
2230
2231         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2232         check_added_monitors!(nodes[1], 1);
2233         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2234
2235         expect_pending_htlcs_forwardable!(nodes[1]);
2236         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2237
2238         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2239         // resolve the second HTLC from A's point of view.
2240         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2241         check_added_monitors!(nodes[0], 1);
2242         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2243
2244         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2245         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2246         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2247         let send_2 = {
2248                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2249                 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();
2250                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2251                 check_added_monitors!(nodes[1], 1);
2252                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2253                 assert_eq!(events.len(), 1);
2254                 SendEvent::from_event(events.remove(0))
2255         };
2256
2257         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2258         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2259         check_added_monitors!(nodes[0], 1);
2260         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2261
2262         // Now just resolve all the outstanding messages/HTLCs for completeness...
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[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2269         check_added_monitors!(nodes[1], 1);
2270
2271         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2272         check_added_monitors!(nodes[0], 1);
2273         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2274
2275         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2276         check_added_monitors!(nodes[1], 1);
2277         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2278
2279         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2280         check_added_monitors!(nodes[0], 1);
2281
2282         expect_pending_htlcs_forwardable!(nodes[0]);
2283         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2284
2285         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2286         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2287 }
2288
2289 #[test]
2290 fn channel_monitor_network_test() {
2291         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2292         // tests that ChannelMonitor is able to recover from various states.
2293         let chanmon_cfgs = create_chanmon_cfgs(5);
2294         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2295         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2296         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2297
2298         // Create some initial channels
2299         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2300         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2301         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2302         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2303
2304         // Rebalance the network a bit by relaying one payment through all the channels...
2305         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2306         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2307         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2308         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2309
2310         // Simple case with no pending HTLCs:
2311         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2312         check_added_monitors!(nodes[1], 1);
2313         {
2314                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2315                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2316                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2317                 check_added_monitors!(nodes[0], 1);
2318                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2319         }
2320         get_announce_close_broadcast_events(&nodes, 0, 1);
2321         assert_eq!(nodes[0].node.list_channels().len(), 0);
2322         assert_eq!(nodes[1].node.list_channels().len(), 1);
2323
2324         // One pending HTLC is discarded by the force-close:
2325         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2326
2327         // Simple case of one pending HTLC to HTLC-Timeout
2328         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2329         check_added_monitors!(nodes[1], 1);
2330         {
2331                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2332                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2333                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2334                 check_added_monitors!(nodes[2], 1);
2335                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2336         }
2337         get_announce_close_broadcast_events(&nodes, 1, 2);
2338         assert_eq!(nodes[1].node.list_channels().len(), 0);
2339         assert_eq!(nodes[2].node.list_channels().len(), 1);
2340
2341         macro_rules! claim_funds {
2342                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2343                         {
2344                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2345                                 check_added_monitors!($node, 1);
2346
2347                                 let events = $node.node.get_and_clear_pending_msg_events();
2348                                 assert_eq!(events.len(), 1);
2349                                 match events[0] {
2350                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2351                                                 assert!(update_add_htlcs.is_empty());
2352                                                 assert!(update_fail_htlcs.is_empty());
2353                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2354                                         },
2355                                         _ => panic!("Unexpected event"),
2356                                 };
2357                         }
2358                 }
2359         }
2360
2361         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2362         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2363         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2364         check_added_monitors!(nodes[2], 1);
2365         let node2_commitment_txid;
2366         {
2367                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2368                 node2_commitment_txid = node_txn[0].txid();
2369
2370                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2371                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2372
2373                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2374                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2375                 check_added_monitors!(nodes[3], 1);
2376
2377                 check_preimage_claim(&nodes[3], &node_txn);
2378         }
2379         get_announce_close_broadcast_events(&nodes, 2, 3);
2380         assert_eq!(nodes[2].node.list_channels().len(), 0);
2381         assert_eq!(nodes[3].node.list_channels().len(), 1);
2382
2383         { // Cheat and reset nodes[4]'s height to 1
2384                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2385                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2386         }
2387
2388         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2389         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2390         // One pending HTLC to time out:
2391         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2392         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2393         // buffer space).
2394
2395         {
2396                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2397                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2398                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2399                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2400                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2401                 }
2402                 check_added_monitors!(nodes[3], 1);
2403
2404                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2405                 {
2406                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2407                         node_txn.retain(|tx| {
2408                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2409                                         false
2410                                 } else { true }
2411                         });
2412                 }
2413
2414                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2415
2416                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2417                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2418
2419                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2420
2421                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2422                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2423                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2424                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2425                 }
2426
2427                 check_added_monitors!(nodes[4], 1);
2428                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2429
2430                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2431                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2432
2433                 check_preimage_claim(&nodes[4], &node_txn);
2434         }
2435         get_announce_close_broadcast_events(&nodes, 3, 4);
2436         assert_eq!(nodes[3].node.list_channels().len(), 0);
2437         assert_eq!(nodes[4].node.list_channels().len(), 0);
2438 }
2439
2440 #[test]
2441 fn test_justice_tx() {
2442         // Test justice txn built on revoked HTLC-Success tx, against both sides
2443         let mut alice_config = UserConfig::default();
2444         alice_config.channel_options.announced_channel = true;
2445         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2446         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2447         let mut bob_config = UserConfig::default();
2448         bob_config.channel_options.announced_channel = true;
2449         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2450         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2451         let user_cfgs = [Some(alice_config), Some(bob_config)];
2452         let chanmon_cfgs = create_chanmon_cfgs(2);
2453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2456         // Create some new channels:
2457         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2458
2459         // A pending HTLC which will be revoked:
2460         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2461         // Get the will-be-revoked local txn from nodes[0]
2462         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2463         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2464         assert_eq!(revoked_local_txn[0].input.len(), 1);
2465         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2466         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2467         assert_eq!(revoked_local_txn[1].input.len(), 1);
2468         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2469         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2470         // Revoke the old state
2471         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2472
2473         {
2474                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2475                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2476                 {
2477                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2478                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2479                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2480
2481                         check_spends!(node_txn[0], revoked_local_txn[0]);
2482                         node_txn.swap_remove(0);
2483                         node_txn.truncate(1);
2484                 }
2485                 check_added_monitors!(nodes[1], 1);
2486                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2487
2488                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2489                 // Verify broadcast of revoked HTLC-timeout
2490                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2491                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2492                 check_added_monitors!(nodes[0], 1);
2493                 // Broadcast revoked HTLC-timeout on node 1
2494                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2495                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2496         }
2497         get_announce_close_broadcast_events(&nodes, 0, 1);
2498
2499         assert_eq!(nodes[0].node.list_channels().len(), 0);
2500         assert_eq!(nodes[1].node.list_channels().len(), 0);
2501
2502         // We test justice_tx build by A on B's revoked HTLC-Success tx
2503         // Create some new channels:
2504         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2505         {
2506                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2507                 node_txn.clear();
2508         }
2509
2510         // A pending HTLC which will be revoked:
2511         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2512         // Get the will-be-revoked local txn from B
2513         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2514         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2515         assert_eq!(revoked_local_txn[0].input.len(), 1);
2516         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2517         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2518         // Revoke the old state
2519         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2520         {
2521                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2522                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2523                 {
2524                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2525                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2526                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2527
2528                         check_spends!(node_txn[0], revoked_local_txn[0]);
2529                         node_txn.swap_remove(0);
2530                 }
2531                 check_added_monitors!(nodes[0], 1);
2532                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2533
2534                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2535                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2536                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2537                 check_added_monitors!(nodes[1], 1);
2538                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2539                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2540         }
2541         get_announce_close_broadcast_events(&nodes, 0, 1);
2542         assert_eq!(nodes[0].node.list_channels().len(), 0);
2543         assert_eq!(nodes[1].node.list_channels().len(), 0);
2544 }
2545
2546 #[test]
2547 fn revoked_output_claim() {
2548         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2549         // transaction is broadcast by its counterparty
2550         let chanmon_cfgs = create_chanmon_cfgs(2);
2551         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2552         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2553         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2554         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2555         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2556         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2557         assert_eq!(revoked_local_txn.len(), 1);
2558         // Only output is the full channel value back to nodes[0]:
2559         assert_eq!(revoked_local_txn[0].output.len(), 1);
2560         // Send a payment through, updating everyone's latest commitment txn
2561         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2562
2563         // Inform nodes[1] that nodes[0] broadcast a stale tx
2564         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2565         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2566         check_added_monitors!(nodes[1], 1);
2567         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2568         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2569
2570         check_spends!(node_txn[0], revoked_local_txn[0]);
2571         check_spends!(node_txn[1], chan_1.3);
2572
2573         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2574         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2575         get_announce_close_broadcast_events(&nodes, 0, 1);
2576         check_added_monitors!(nodes[0], 1)
2577 }
2578
2579 #[test]
2580 fn claim_htlc_outputs_shared_tx() {
2581         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2582         let chanmon_cfgs = create_chanmon_cfgs(2);
2583         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2584         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2585         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2586
2587         // Create some new channel:
2588         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2589
2590         // Rebalance the network to generate htlc in the two directions
2591         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2592         // 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
2593         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2594         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2595
2596         // Get the will-be-revoked local txn from node[0]
2597         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2598         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2599         assert_eq!(revoked_local_txn[0].input.len(), 1);
2600         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2601         assert_eq!(revoked_local_txn[1].input.len(), 1);
2602         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2603         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2604         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2605
2606         //Revoke the old state
2607         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2608
2609         {
2610                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2611                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2612                 check_added_monitors!(nodes[0], 1);
2613                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2614                 check_added_monitors!(nodes[1], 1);
2615                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2616                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2617
2618                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2619                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2620
2621                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2622                 check_spends!(node_txn[0], revoked_local_txn[0]);
2623
2624                 let mut witness_lens = BTreeSet::new();
2625                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2626                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2627                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2628                 assert_eq!(witness_lens.len(), 3);
2629                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2630                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2631                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2632
2633                 // Next nodes[1] broadcasts its current local tx state:
2634                 assert_eq!(node_txn[1].input.len(), 1);
2635                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2636
2637                 assert_eq!(node_txn[2].input.len(), 1);
2638                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2639                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2640                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2641                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2642                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2643         }
2644         get_announce_close_broadcast_events(&nodes, 0, 1);
2645         assert_eq!(nodes[0].node.list_channels().len(), 0);
2646         assert_eq!(nodes[1].node.list_channels().len(), 0);
2647 }
2648
2649 #[test]
2650 fn claim_htlc_outputs_single_tx() {
2651         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2652         let chanmon_cfgs = create_chanmon_cfgs(2);
2653         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2654         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2655         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2656
2657         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2658
2659         // Rebalance the network to generate htlc in the two directions
2660         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2661         // 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
2662         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2663         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2664         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2665
2666         // Get the will-be-revoked local txn from node[0]
2667         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2668
2669         //Revoke the old state
2670         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2671
2672         {
2673                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2674                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2675                 check_added_monitors!(nodes[0], 1);
2676                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2677                 check_added_monitors!(nodes[1], 1);
2678                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2679
2680                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2681                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2682
2683                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2684                 assert_eq!(node_txn.len(), 9);
2685                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2686                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2687                 // 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)
2688                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2689
2690                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2691                 assert_eq!(node_txn[2].input.len(), 1);
2692                 check_spends!(node_txn[2], chan_1.3);
2693                 assert_eq!(node_txn[3].input.len(), 1);
2694                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2695                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2696                 check_spends!(node_txn[3], node_txn[2]);
2697
2698                 // Justice transactions are indices 1-2-4
2699                 assert_eq!(node_txn[0].input.len(), 1);
2700                 assert_eq!(node_txn[1].input.len(), 1);
2701                 assert_eq!(node_txn[4].input.len(), 1);
2702
2703                 check_spends!(node_txn[0], revoked_local_txn[0]);
2704                 check_spends!(node_txn[1], revoked_local_txn[0]);
2705                 check_spends!(node_txn[4], revoked_local_txn[0]);
2706
2707                 let mut witness_lens = BTreeSet::new();
2708                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2709                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2710                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2711                 assert_eq!(witness_lens.len(), 3);
2712                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2713                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2714                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2715         }
2716         get_announce_close_broadcast_events(&nodes, 0, 1);
2717         assert_eq!(nodes[0].node.list_channels().len(), 0);
2718         assert_eq!(nodes[1].node.list_channels().len(), 0);
2719 }
2720
2721 #[test]
2722 fn test_htlc_on_chain_success() {
2723         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2724         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2725         // broadcasting the right event to other nodes in payment path.
2726         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2727         // A --------------------> B ----------------------> C (preimage)
2728         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2729         // commitment transaction was broadcast.
2730         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2731         // towards B.
2732         // B should be able to claim via preimage if A then broadcasts its local tx.
2733         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2734         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2735         // PaymentSent event).
2736
2737         let chanmon_cfgs = create_chanmon_cfgs(3);
2738         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2739         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2740         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2741
2742         // Create some initial channels
2743         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2744         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2745
2746         // Rebalance the network a bit by relaying one payment through all the channels...
2747         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2748         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2749
2750         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2751         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2752         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2753
2754         // Broadcast legit commitment tx from C on B's chain
2755         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2756         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2757         assert_eq!(commitment_tx.len(), 1);
2758         check_spends!(commitment_tx[0], chan_2.3);
2759         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2760         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2761         check_added_monitors!(nodes[2], 2);
2762         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2763         assert!(updates.update_add_htlcs.is_empty());
2764         assert!(updates.update_fail_htlcs.is_empty());
2765         assert!(updates.update_fail_malformed_htlcs.is_empty());
2766         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2767
2768         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2769         check_closed_broadcast!(nodes[2], false);
2770         check_added_monitors!(nodes[2], 1);
2771         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2772         assert_eq!(node_txn.len(), 5);
2773         assert_eq!(node_txn[0], node_txn[3]);
2774         assert_eq!(node_txn[1], node_txn[4]);
2775         assert_eq!(node_txn[2], commitment_tx[0]);
2776         check_spends!(node_txn[0], commitment_tx[0]);
2777         check_spends!(node_txn[1], commitment_tx[0]);
2778         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2779         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2780         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2781         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2782         assert_eq!(node_txn[0].lock_time, 0);
2783         assert_eq!(node_txn[1].lock_time, 0);
2784
2785         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2786         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2787         {
2788                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2789                 assert_eq!(added_monitors.len(), 1);
2790                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2791                 added_monitors.clear();
2792         }
2793         let events = nodes[1].node.get_and_clear_pending_msg_events();
2794         {
2795                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2796                 assert_eq!(added_monitors.len(), 2);
2797                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2798                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2799                 added_monitors.clear();
2800         }
2801         assert_eq!(events.len(), 2);
2802         match events[0] {
2803                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2804                 _ => panic!("Unexpected event"),
2805         }
2806         match events[1] {
2807                 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, .. } } => {
2808                         assert!(update_add_htlcs.is_empty());
2809                         assert!(update_fail_htlcs.is_empty());
2810                         assert_eq!(update_fulfill_htlcs.len(), 1);
2811                         assert!(update_fail_malformed_htlcs.is_empty());
2812                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2813                 },
2814                 _ => panic!("Unexpected event"),
2815         };
2816         macro_rules! check_tx_local_broadcast {
2817                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2818                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2819                         assert_eq!(node_txn.len(), 5);
2820                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2821                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2822                         check_spends!(node_txn[0], $commitment_tx);
2823                         check_spends!(node_txn[1], $commitment_tx);
2824                         assert_ne!(node_txn[0].lock_time, 0);
2825                         assert_ne!(node_txn[1].lock_time, 0);
2826                         if $htlc_offered {
2827                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2828                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2829                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2830                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2831                         } else {
2832                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2833                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2834                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2835                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2836                         }
2837                         check_spends!(node_txn[2], $chan_tx);
2838                         check_spends!(node_txn[3], node_txn[2]);
2839                         check_spends!(node_txn[4], node_txn[2]);
2840                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2841                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2842                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2844                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845                         assert_ne!(node_txn[3].lock_time, 0);
2846                         assert_ne!(node_txn[4].lock_time, 0);
2847                         node_txn.clear();
2848                 } }
2849         }
2850         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2851         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2852         // timeout-claim of the output that nodes[2] just claimed via success.
2853         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2854
2855         // Broadcast legit commitment tx from A on B's chain
2856         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2857         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2858         check_spends!(commitment_tx[0], chan_1.3);
2859         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2860         check_closed_broadcast!(nodes[1], false);
2861         check_added_monitors!(nodes[1], 1);
2862         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2863         assert_eq!(node_txn.len(), 4);
2864         check_spends!(node_txn[0], commitment_tx[0]);
2865         assert_eq!(node_txn[0].input.len(), 2);
2866         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2867         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2868         assert_eq!(node_txn[0].lock_time, 0);
2869         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2870         check_spends!(node_txn[1], chan_1.3);
2871         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2872         check_spends!(node_txn[2], node_txn[1]);
2873         check_spends!(node_txn[3], node_txn[1]);
2874         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2875         // we already checked the same situation with A.
2876
2877         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2878         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2879         check_closed_broadcast!(nodes[0], false);
2880         check_added_monitors!(nodes[0], 1);
2881         let events = nodes[0].node.get_and_clear_pending_events();
2882         assert_eq!(events.len(), 2);
2883         let mut first_claimed = false;
2884         for event in events {
2885                 match event {
2886                         Event::PaymentSent { payment_preimage } => {
2887                                 if payment_preimage == our_payment_preimage {
2888                                         assert!(!first_claimed);
2889                                         first_claimed = true;
2890                                 } else {
2891                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2892                                 }
2893                         },
2894                         _ => panic!("Unexpected event"),
2895                 }
2896         }
2897         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2898 }
2899
2900 #[test]
2901 fn test_htlc_on_chain_timeout() {
2902         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2903         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2904         // broadcasting the right event to other nodes in payment path.
2905         // A ------------------> B ----------------------> C (timeout)
2906         //    B's commitment tx                 C's commitment tx
2907         //            \                                  \
2908         //         B's HTLC timeout tx               B's timeout tx
2909
2910         let chanmon_cfgs = create_chanmon_cfgs(3);
2911         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2912         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2913         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2914
2915         // Create some intial channels
2916         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2917         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2918
2919         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2920         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2921         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2922
2923         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2924         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2925
2926         // Broadcast legit commitment tx from C on B's chain
2927         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2928         check_spends!(commitment_tx[0], chan_2.3);
2929         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2930         check_added_monitors!(nodes[2], 0);
2931         expect_pending_htlcs_forwardable!(nodes[2]);
2932         check_added_monitors!(nodes[2], 1);
2933
2934         let events = nodes[2].node.get_and_clear_pending_msg_events();
2935         assert_eq!(events.len(), 1);
2936         match events[0] {
2937                 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, .. } } => {
2938                         assert!(update_add_htlcs.is_empty());
2939                         assert!(!update_fail_htlcs.is_empty());
2940                         assert!(update_fulfill_htlcs.is_empty());
2941                         assert!(update_fail_malformed_htlcs.is_empty());
2942                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2943                 },
2944                 _ => panic!("Unexpected event"),
2945         };
2946         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2947         check_closed_broadcast!(nodes[2], false);
2948         check_added_monitors!(nodes[2], 1);
2949         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2950         assert_eq!(node_txn.len(), 1);
2951         check_spends!(node_txn[0], chan_2.3);
2952         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2953
2954         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2955         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2956         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2957         let timeout_tx;
2958         {
2959                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2960                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2961                 assert_eq!(node_txn[1], node_txn[3]);
2962                 assert_eq!(node_txn[2], node_txn[4]);
2963
2964                 check_spends!(node_txn[0], commitment_tx[0]);
2965                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2966
2967                 check_spends!(node_txn[1], chan_2.3);
2968                 check_spends!(node_txn[2], node_txn[1]);
2969                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2970                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2971
2972                 timeout_tx = node_txn[0].clone();
2973                 node_txn.clear();
2974         }
2975
2976         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2977         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2978         check_added_monitors!(nodes[1], 1);
2979         check_closed_broadcast!(nodes[1], false);
2980
2981         expect_pending_htlcs_forwardable!(nodes[1]);
2982         check_added_monitors!(nodes[1], 1);
2983         let events = nodes[1].node.get_and_clear_pending_msg_events();
2984         assert_eq!(events.len(), 1);
2985         match events[0] {
2986                 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, .. } } => {
2987                         assert!(update_add_htlcs.is_empty());
2988                         assert!(!update_fail_htlcs.is_empty());
2989                         assert!(update_fulfill_htlcs.is_empty());
2990                         assert!(update_fail_malformed_htlcs.is_empty());
2991                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2992                 },
2993                 _ => panic!("Unexpected event"),
2994         };
2995         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
2996         assert_eq!(node_txn.len(), 0);
2997
2998         // Broadcast legit commitment tx from B on A's chain
2999         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3000         check_spends!(commitment_tx[0], chan_1.3);
3001
3002         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3003         check_closed_broadcast!(nodes[0], false);
3004         check_added_monitors!(nodes[0], 1);
3005         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3006         assert_eq!(node_txn.len(), 3);
3007         check_spends!(node_txn[0], commitment_tx[0]);
3008         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3009         check_spends!(node_txn[1], chan_1.3);
3010         check_spends!(node_txn[2], node_txn[1]);
3011         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3012         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3013 }
3014
3015 #[test]
3016 fn test_simple_commitment_revoked_fail_backward() {
3017         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3018         // and fail backward accordingly.
3019
3020         let chanmon_cfgs = create_chanmon_cfgs(3);
3021         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3022         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3023         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3024
3025         // Create some initial channels
3026         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3027         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3028
3029         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3030         // Get the will-be-revoked local txn from nodes[2]
3031         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3032         // Revoke the old state
3033         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3034
3035         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3036
3037         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3038         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3039         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3040         check_added_monitors!(nodes[1], 1);
3041         check_closed_broadcast!(nodes[1], false);
3042
3043         expect_pending_htlcs_forwardable!(nodes[1]);
3044         check_added_monitors!(nodes[1], 1);
3045         let events = nodes[1].node.get_and_clear_pending_msg_events();
3046         assert_eq!(events.len(), 1);
3047         match events[0] {
3048                 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, .. } } => {
3049                         assert!(update_add_htlcs.is_empty());
3050                         assert_eq!(update_fail_htlcs.len(), 1);
3051                         assert!(update_fulfill_htlcs.is_empty());
3052                         assert!(update_fail_malformed_htlcs.is_empty());
3053                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3054
3055                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3056                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3057
3058                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3059                         assert_eq!(events.len(), 1);
3060                         match events[0] {
3061                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3062                                 _ => panic!("Unexpected event"),
3063                         }
3064                         expect_payment_failed!(nodes[0], payment_hash, false);
3065                 },
3066                 _ => panic!("Unexpected event"),
3067         }
3068 }
3069
3070 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3071         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3072         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3073         // commitment transaction anymore.
3074         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3075         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3076         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3077         // technically disallowed and we should probably handle it reasonably.
3078         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3079         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3080         // transactions:
3081         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3082         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3083         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3084         //   and once they revoke the previous commitment transaction (allowing us to send a new
3085         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3086         let chanmon_cfgs = create_chanmon_cfgs(3);
3087         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3088         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3089         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3090
3091         // Create some initial channels
3092         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3093         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3094
3095         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3096         // Get the will-be-revoked local txn from nodes[2]
3097         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3098         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3099         // Revoke the old state
3100         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3101
3102         let value = if use_dust {
3103                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3104                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3105                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3106         } else { 3000000 };
3107
3108         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3109         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3110         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3111
3112         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3113         expect_pending_htlcs_forwardable!(nodes[2]);
3114         check_added_monitors!(nodes[2], 1);
3115         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3116         assert!(updates.update_add_htlcs.is_empty());
3117         assert!(updates.update_fulfill_htlcs.is_empty());
3118         assert!(updates.update_fail_malformed_htlcs.is_empty());
3119         assert_eq!(updates.update_fail_htlcs.len(), 1);
3120         assert!(updates.update_fee.is_none());
3121         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3122         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3123         // Drop the last RAA from 3 -> 2
3124
3125         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3126         expect_pending_htlcs_forwardable!(nodes[2]);
3127         check_added_monitors!(nodes[2], 1);
3128         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3129         assert!(updates.update_add_htlcs.is_empty());
3130         assert!(updates.update_fulfill_htlcs.is_empty());
3131         assert!(updates.update_fail_malformed_htlcs.is_empty());
3132         assert_eq!(updates.update_fail_htlcs.len(), 1);
3133         assert!(updates.update_fee.is_none());
3134         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3135         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3136         check_added_monitors!(nodes[1], 1);
3137         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3138         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3139         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3140         check_added_monitors!(nodes[2], 1);
3141
3142         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3143         expect_pending_htlcs_forwardable!(nodes[2]);
3144         check_added_monitors!(nodes[2], 1);
3145         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3146         assert!(updates.update_add_htlcs.is_empty());
3147         assert!(updates.update_fulfill_htlcs.is_empty());
3148         assert!(updates.update_fail_malformed_htlcs.is_empty());
3149         assert_eq!(updates.update_fail_htlcs.len(), 1);
3150         assert!(updates.update_fee.is_none());
3151         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3152         // At this point first_payment_hash has dropped out of the latest two commitment
3153         // transactions that nodes[1] is tracking...
3154         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3155         check_added_monitors!(nodes[1], 1);
3156         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3157         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3158         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3159         check_added_monitors!(nodes[2], 1);
3160
3161         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3162         // on nodes[2]'s RAA.
3163         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3164         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3165         let logger = test_utils::TestLogger::new();
3166         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();
3167         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3168         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3169         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3170         check_added_monitors!(nodes[1], 0);
3171
3172         if deliver_bs_raa {
3173                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3174                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3175                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3176                 check_added_monitors!(nodes[1], 1);
3177                 let events = nodes[1].node.get_and_clear_pending_events();
3178                 assert_eq!(events.len(), 1);
3179                 match events[0] {
3180                         Event::PendingHTLCsForwardable { .. } => { },
3181                         _ => panic!("Unexpected event"),
3182                 };
3183                 // Deliberately don't process the pending fail-back so they all fail back at once after
3184                 // block connection just like the !deliver_bs_raa case
3185         }
3186
3187         let mut failed_htlcs = HashSet::new();
3188         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3189
3190         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3191         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3192         check_added_monitors!(nodes[1], 1);
3193         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3194
3195         let events = nodes[1].node.get_and_clear_pending_events();
3196         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3197         match events[0] {
3198                 Event::PaymentFailed { ref payment_hash, .. } => {
3199                         assert_eq!(*payment_hash, fourth_payment_hash);
3200                 },
3201                 _ => panic!("Unexpected event"),
3202         }
3203         if !deliver_bs_raa {
3204                 match events[1] {
3205                         Event::PendingHTLCsForwardable { .. } => { },
3206                         _ => panic!("Unexpected event"),
3207                 };
3208         }
3209         nodes[1].node.process_pending_htlc_forwards();
3210         check_added_monitors!(nodes[1], 1);
3211
3212         let events = nodes[1].node.get_and_clear_pending_msg_events();
3213         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3214         match events[if deliver_bs_raa { 1 } else { 0 }] {
3215                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3216                 _ => panic!("Unexpected event"),
3217         }
3218         if deliver_bs_raa {
3219                 match events[0] {
3220                         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, .. } } => {
3221                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3222                                 assert_eq!(update_add_htlcs.len(), 1);
3223                                 assert!(update_fulfill_htlcs.is_empty());
3224                                 assert!(update_fail_htlcs.is_empty());
3225                                 assert!(update_fail_malformed_htlcs.is_empty());
3226                         },
3227                         _ => panic!("Unexpected event"),
3228                 }
3229         }
3230         match events[if deliver_bs_raa { 2 } else { 1 }] {
3231                 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, .. } } => {
3232                         assert!(update_add_htlcs.is_empty());
3233                         assert_eq!(update_fail_htlcs.len(), 3);
3234                         assert!(update_fulfill_htlcs.is_empty());
3235                         assert!(update_fail_malformed_htlcs.is_empty());
3236                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3237
3238                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3239                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3240                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3241
3242                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3243
3244                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3245                         // If we delivered B's RAA we got an unknown preimage error, not something
3246                         // that we should update our routing table for.
3247                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3248                         for event in events {
3249                                 match event {
3250                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3251                                         _ => panic!("Unexpected event"),
3252                                 }
3253                         }
3254                         let events = nodes[0].node.get_and_clear_pending_events();
3255                         assert_eq!(events.len(), 3);
3256                         match events[0] {
3257                                 Event::PaymentFailed { ref payment_hash, .. } => {
3258                                         assert!(failed_htlcs.insert(payment_hash.0));
3259                                 },
3260                                 _ => panic!("Unexpected event"),
3261                         }
3262                         match events[1] {
3263                                 Event::PaymentFailed { ref payment_hash, .. } => {
3264                                         assert!(failed_htlcs.insert(payment_hash.0));
3265                                 },
3266                                 _ => panic!("Unexpected event"),
3267                         }
3268                         match events[2] {
3269                                 Event::PaymentFailed { ref payment_hash, .. } => {
3270                                         assert!(failed_htlcs.insert(payment_hash.0));
3271                                 },
3272                                 _ => panic!("Unexpected event"),
3273                         }
3274                 },
3275                 _ => panic!("Unexpected event"),
3276         }
3277
3278         assert!(failed_htlcs.contains(&first_payment_hash.0));
3279         assert!(failed_htlcs.contains(&second_payment_hash.0));
3280         assert!(failed_htlcs.contains(&third_payment_hash.0));
3281 }
3282
3283 #[test]
3284 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3285         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3286         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3287         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3288         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3289 }
3290
3291 #[test]
3292 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3293         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3294         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3295         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3296         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3297 }
3298
3299 #[test]
3300 fn fail_backward_pending_htlc_upon_channel_failure() {
3301         let chanmon_cfgs = create_chanmon_cfgs(2);
3302         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3303         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3304         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3305         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3306         let logger = test_utils::TestLogger::new();
3307
3308         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3309         {
3310                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3311                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3312                 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();
3313                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3314                 check_added_monitors!(nodes[0], 1);
3315
3316                 let payment_event = {
3317                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3318                         assert_eq!(events.len(), 1);
3319                         SendEvent::from_event(events.remove(0))
3320                 };
3321                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3322                 assert_eq!(payment_event.msgs.len(), 1);
3323         }
3324
3325         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3326         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3327         {
3328                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3329                 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();
3330                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3331                 check_added_monitors!(nodes[0], 0);
3332
3333                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3334         }
3335
3336         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3337         {
3338                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3339
3340                 let secp_ctx = Secp256k1::new();
3341                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3342                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3343                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3344                 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();
3345                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3346                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3347                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3348
3349                 // Send a 0-msat update_add_htlc to fail the channel.
3350                 let update_add_htlc = msgs::UpdateAddHTLC {
3351                         channel_id: chan.2,
3352                         htlc_id: 0,
3353                         amount_msat: 0,
3354                         payment_hash,
3355                         cltv_expiry,
3356                         onion_routing_packet,
3357                 };
3358                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3359         }
3360
3361         // Check that Alice fails backward the pending HTLC from the second payment.
3362         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3363         check_closed_broadcast!(nodes[0], true);
3364         check_added_monitors!(nodes[0], 1);
3365 }
3366
3367 #[test]
3368 fn test_htlc_ignore_latest_remote_commitment() {
3369         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3370         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3371         let chanmon_cfgs = create_chanmon_cfgs(2);
3372         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3373         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3374         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3375         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3376
3377         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3378         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3379         check_closed_broadcast!(nodes[0], false);
3380         check_added_monitors!(nodes[0], 1);
3381
3382         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3383         assert_eq!(node_txn.len(), 2);
3384
3385         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3386         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3387         check_closed_broadcast!(nodes[1], false);
3388         check_added_monitors!(nodes[1], 1);
3389
3390         // Duplicate the block_connected call since this may happen due to other listeners
3391         // registering new transactions
3392         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3393 }
3394
3395 #[test]
3396 fn test_force_close_fail_back() {
3397         // Check which HTLCs are failed-backwards on channel force-closure
3398         let chanmon_cfgs = create_chanmon_cfgs(3);
3399         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3400         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3401         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3402         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3403         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3404         let logger = test_utils::TestLogger::new();
3405
3406         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3407
3408         let mut payment_event = {
3409                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3410                 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();
3411                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3412                 check_added_monitors!(nodes[0], 1);
3413
3414                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3415                 assert_eq!(events.len(), 1);
3416                 SendEvent::from_event(events.remove(0))
3417         };
3418
3419         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3420         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3421
3422         expect_pending_htlcs_forwardable!(nodes[1]);
3423
3424         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3425         assert_eq!(events_2.len(), 1);
3426         payment_event = SendEvent::from_event(events_2.remove(0));
3427         assert_eq!(payment_event.msgs.len(), 1);
3428
3429         check_added_monitors!(nodes[1], 1);
3430         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3431         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3432         check_added_monitors!(nodes[2], 1);
3433         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3434
3435         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3436         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3437         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3438
3439         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3440         check_closed_broadcast!(nodes[2], false);
3441         check_added_monitors!(nodes[2], 1);
3442         let tx = {
3443                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3444                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3445                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3446                 // back to nodes[1] upon timeout otherwise.
3447                 assert_eq!(node_txn.len(), 1);
3448                 node_txn.remove(0)
3449         };
3450
3451         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3452         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3453
3454         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3455         check_closed_broadcast!(nodes[1], false);
3456         check_added_monitors!(nodes[1], 1);
3457
3458         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3459         {
3460                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3461                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3462                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3463         }
3464         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3465         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3466         assert_eq!(node_txn.len(), 1);
3467         assert_eq!(node_txn[0].input.len(), 1);
3468         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3469         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3470         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3471
3472         check_spends!(node_txn[0], tx);
3473 }
3474
3475 #[test]
3476 fn test_unconf_chan() {
3477         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3478         let chanmon_cfgs = create_chanmon_cfgs(2);
3479         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3480         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3481         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3482         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3483
3484         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3485         assert_eq!(channel_state.by_id.len(), 1);
3486         assert_eq!(channel_state.short_to_id.len(), 1);
3487         mem::drop(channel_state);
3488
3489         let mut headers = Vec::new();
3490         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3491         headers.push(header.clone());
3492         for _i in 2..100 {
3493                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3494                 headers.push(header.clone());
3495         }
3496         let mut height = 99;
3497         while !headers.is_empty() {
3498                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3499                 height -= 1;
3500         }
3501         check_closed_broadcast!(nodes[0], false);
3502         check_added_monitors!(nodes[0], 1);
3503         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3504         assert_eq!(channel_state.by_id.len(), 0);
3505         assert_eq!(channel_state.short_to_id.len(), 0);
3506 }
3507
3508 #[test]
3509 fn test_simple_peer_disconnect() {
3510         // Test that we can reconnect when there are no lost messages
3511         let chanmon_cfgs = create_chanmon_cfgs(3);
3512         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3513         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3514         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3515         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3516         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3517
3518         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3519         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3520         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3521
3522         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3523         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3524         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3525         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3526
3527         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3528         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3529         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3530
3531         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3532         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3533         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3534         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3535
3536         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3537         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3538
3539         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3540         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3541
3542         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3543         {
3544                 let events = nodes[0].node.get_and_clear_pending_events();
3545                 assert_eq!(events.len(), 2);
3546                 match events[0] {
3547                         Event::PaymentSent { payment_preimage } => {
3548                                 assert_eq!(payment_preimage, payment_preimage_3);
3549                         },
3550                         _ => panic!("Unexpected event"),
3551                 }
3552                 match events[1] {
3553                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3554                                 assert_eq!(payment_hash, payment_hash_5);
3555                                 assert!(rejected_by_dest);
3556                         },
3557                         _ => panic!("Unexpected event"),
3558                 }
3559         }
3560
3561         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3562         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3563 }
3564
3565 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3566         // Test that we can reconnect when in-flight HTLC updates get dropped
3567         let chanmon_cfgs = create_chanmon_cfgs(2);
3568         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3569         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3570         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3571         if messages_delivered == 0 {
3572                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3573                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3574         } else {
3575                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3576         }
3577
3578         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3579
3580         let logger = test_utils::TestLogger::new();
3581         let payment_event = {
3582                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3583                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3584                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3585                 check_added_monitors!(nodes[0], 1);
3586
3587                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3588                 assert_eq!(events.len(), 1);
3589                 SendEvent::from_event(events.remove(0))
3590         };
3591         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3592
3593         if messages_delivered < 2 {
3594                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3595         } else {
3596                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3597                 if messages_delivered >= 3 {
3598                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3599                         check_added_monitors!(nodes[1], 1);
3600                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3601
3602                         if messages_delivered >= 4 {
3603                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3604                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3605                                 check_added_monitors!(nodes[0], 1);
3606
3607                                 if messages_delivered >= 5 {
3608                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3609                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3610                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3611                                         check_added_monitors!(nodes[0], 1);
3612
3613                                         if messages_delivered >= 6 {
3614                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3615                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3616                                                 check_added_monitors!(nodes[1], 1);
3617                                         }
3618                                 }
3619                         }
3620                 }
3621         }
3622
3623         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3624         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3625         if messages_delivered < 3 {
3626                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3627                 // received on either side, both sides will need to resend them.
3628                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3629         } else if messages_delivered == 3 {
3630                 // nodes[0] still wants its RAA + commitment_signed
3631                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3632         } else if messages_delivered == 4 {
3633                 // nodes[0] still wants its commitment_signed
3634                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3635         } else if messages_delivered == 5 {
3636                 // nodes[1] still wants its final RAA
3637                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3638         } else if messages_delivered == 6 {
3639                 // Everything was delivered...
3640                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3641         }
3642
3643         let events_1 = nodes[1].node.get_and_clear_pending_events();
3644         assert_eq!(events_1.len(), 1);
3645         match events_1[0] {
3646                 Event::PendingHTLCsForwardable { .. } => { },
3647                 _ => panic!("Unexpected event"),
3648         };
3649
3650         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3651         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3652         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3653
3654         nodes[1].node.process_pending_htlc_forwards();
3655
3656         let events_2 = nodes[1].node.get_and_clear_pending_events();
3657         assert_eq!(events_2.len(), 1);
3658         match events_2[0] {
3659                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3660                         assert_eq!(payment_hash_1, *payment_hash);
3661                         assert_eq!(*payment_secret, None);
3662                         assert_eq!(amt, 1000000);
3663                 },
3664                 _ => panic!("Unexpected event"),
3665         }
3666
3667         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3668         check_added_monitors!(nodes[1], 1);
3669
3670         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3671         assert_eq!(events_3.len(), 1);
3672         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3673                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3674                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3675                         assert!(updates.update_add_htlcs.is_empty());
3676                         assert!(updates.update_fail_htlcs.is_empty());
3677                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3678                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3679                         assert!(updates.update_fee.is_none());
3680                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3681                 },
3682                 _ => panic!("Unexpected event"),
3683         };
3684
3685         if messages_delivered >= 1 {
3686                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3687
3688                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3689                 assert_eq!(events_4.len(), 1);
3690                 match events_4[0] {
3691                         Event::PaymentSent { ref payment_preimage } => {
3692                                 assert_eq!(payment_preimage_1, *payment_preimage);
3693                         },
3694                         _ => panic!("Unexpected event"),
3695                 }
3696
3697                 if messages_delivered >= 2 {
3698                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3699                         check_added_monitors!(nodes[0], 1);
3700                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3701
3702                         if messages_delivered >= 3 {
3703                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3704                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3705                                 check_added_monitors!(nodes[1], 1);
3706
3707                                 if messages_delivered >= 4 {
3708                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3709                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3710                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3711                                         check_added_monitors!(nodes[1], 1);
3712
3713                                         if messages_delivered >= 5 {
3714                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3715                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3716                                                 check_added_monitors!(nodes[0], 1);
3717                                         }
3718                                 }
3719                         }
3720                 }
3721         }
3722
3723         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3724         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3725         if messages_delivered < 2 {
3726                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3727                 //TODO: Deduplicate PaymentSent events, then enable this if:
3728                 //if messages_delivered < 1 {
3729                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3730                         assert_eq!(events_4.len(), 1);
3731                         match events_4[0] {
3732                                 Event::PaymentSent { ref payment_preimage } => {
3733                                         assert_eq!(payment_preimage_1, *payment_preimage);
3734                                 },
3735                                 _ => panic!("Unexpected event"),
3736                         }
3737                 //}
3738         } else if messages_delivered == 2 {
3739                 // nodes[0] still wants its RAA + commitment_signed
3740                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3741         } else if messages_delivered == 3 {
3742                 // nodes[0] still wants its commitment_signed
3743                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3744         } else if messages_delivered == 4 {
3745                 // nodes[1] still wants its final RAA
3746                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3747         } else if messages_delivered == 5 {
3748                 // Everything was delivered...
3749                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3750         }
3751
3752         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3753         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3754         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3755
3756         // Channel should still work fine...
3757         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3758         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3759         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3760         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3761 }
3762
3763 #[test]
3764 fn test_drop_messages_peer_disconnect_a() {
3765         do_test_drop_messages_peer_disconnect(0);
3766         do_test_drop_messages_peer_disconnect(1);
3767         do_test_drop_messages_peer_disconnect(2);
3768         do_test_drop_messages_peer_disconnect(3);
3769 }
3770
3771 #[test]
3772 fn test_drop_messages_peer_disconnect_b() {
3773         do_test_drop_messages_peer_disconnect(4);
3774         do_test_drop_messages_peer_disconnect(5);
3775         do_test_drop_messages_peer_disconnect(6);
3776 }
3777
3778 #[test]
3779 fn test_funding_peer_disconnect() {
3780         // Test that we can lock in our funding tx while disconnected
3781         let chanmon_cfgs = create_chanmon_cfgs(2);
3782         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3783         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3784         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3785         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3786
3787         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3788         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3789
3790         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3791         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3792         assert_eq!(events_1.len(), 1);
3793         match events_1[0] {
3794                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3795                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3796                 },
3797                 _ => panic!("Unexpected event"),
3798         }
3799
3800         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3801
3802         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3803         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3804
3805         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3806         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3807         assert_eq!(events_2.len(), 2);
3808         let funding_locked = match events_2[0] {
3809                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3810                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3811                         msg.clone()
3812                 },
3813                 _ => panic!("Unexpected event"),
3814         };
3815         let bs_announcement_sigs = match events_2[1] {
3816                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3817                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3818                         msg.clone()
3819                 },
3820                 _ => panic!("Unexpected event"),
3821         };
3822
3823         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3824
3825         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3826         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3827         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3828         assert_eq!(events_3.len(), 2);
3829         let as_announcement_sigs = match events_3[0] {
3830                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3831                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3832                         msg.clone()
3833                 },
3834                 _ => panic!("Unexpected event"),
3835         };
3836         let (as_announcement, as_update) = match events_3[1] {
3837                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3838                         (msg.clone(), update_msg.clone())
3839                 },
3840                 _ => panic!("Unexpected event"),
3841         };
3842
3843         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3844         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3845         assert_eq!(events_4.len(), 1);
3846         let (_, bs_update) = match events_4[0] {
3847                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3848                         (msg.clone(), update_msg.clone())
3849                 },
3850                 _ => panic!("Unexpected event"),
3851         };
3852
3853         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3854         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3855         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3856
3857         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3858         let logger = test_utils::TestLogger::new();
3859         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();
3860         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3861         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3862 }
3863
3864 #[test]
3865 fn test_drop_messages_peer_disconnect_dual_htlc() {
3866         // Test that we can handle reconnecting when both sides of a channel have pending
3867         // commitment_updates when we disconnect.
3868         let chanmon_cfgs = create_chanmon_cfgs(2);
3869         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3870         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3871         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3872         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3873         let logger = test_utils::TestLogger::new();
3874
3875         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3876
3877         // Now try to send a second payment which will fail to send
3878         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3879         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3880         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();
3881         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3882         check_added_monitors!(nodes[0], 1);
3883
3884         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3885         assert_eq!(events_1.len(), 1);
3886         match events_1[0] {
3887                 MessageSendEvent::UpdateHTLCs { .. } => {},
3888                 _ => panic!("Unexpected event"),
3889         }
3890
3891         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3892         check_added_monitors!(nodes[1], 1);
3893
3894         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3895         assert_eq!(events_2.len(), 1);
3896         match events_2[0] {
3897                 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 } } => {
3898                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3899                         assert!(update_add_htlcs.is_empty());
3900                         assert_eq!(update_fulfill_htlcs.len(), 1);
3901                         assert!(update_fail_htlcs.is_empty());
3902                         assert!(update_fail_malformed_htlcs.is_empty());
3903                         assert!(update_fee.is_none());
3904
3905                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3906                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3907                         assert_eq!(events_3.len(), 1);
3908                         match events_3[0] {
3909                                 Event::PaymentSent { ref payment_preimage } => {
3910                                         assert_eq!(*payment_preimage, payment_preimage_1);
3911                                 },
3912                                 _ => panic!("Unexpected event"),
3913                         }
3914
3915                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3916                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3917                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3918                         check_added_monitors!(nodes[0], 1);
3919                 },
3920                 _ => panic!("Unexpected event"),
3921         }
3922
3923         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3924         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3925
3926         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3927         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3928         assert_eq!(reestablish_1.len(), 1);
3929         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3930         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3931         assert_eq!(reestablish_2.len(), 1);
3932
3933         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3934         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3935         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3936         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3937
3938         assert!(as_resp.0.is_none());
3939         assert!(bs_resp.0.is_none());
3940
3941         assert!(bs_resp.1.is_none());
3942         assert!(bs_resp.2.is_none());
3943
3944         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3945
3946         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3947         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3948         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3949         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3950         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3951         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3952         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3953         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3954         // No commitment_signed so get_event_msg's assert(len == 1) passes
3955         check_added_monitors!(nodes[1], 1);
3956
3957         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3958         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3959         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3960         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3961         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3962         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3963         assert!(bs_second_commitment_signed.update_fee.is_none());
3964         check_added_monitors!(nodes[1], 1);
3965
3966         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3967         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3968         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3969         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3970         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3971         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3972         assert!(as_commitment_signed.update_fee.is_none());
3973         check_added_monitors!(nodes[0], 1);
3974
3975         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3976         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3977         // No commitment_signed so get_event_msg's assert(len == 1) passes
3978         check_added_monitors!(nodes[0], 1);
3979
3980         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3981         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3982         // No commitment_signed so get_event_msg's assert(len == 1) passes
3983         check_added_monitors!(nodes[1], 1);
3984
3985         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3986         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3987         check_added_monitors!(nodes[1], 1);
3988
3989         expect_pending_htlcs_forwardable!(nodes[1]);
3990
3991         let events_5 = nodes[1].node.get_and_clear_pending_events();
3992         assert_eq!(events_5.len(), 1);
3993         match events_5[0] {
3994                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3995                         assert_eq!(payment_hash_2, *payment_hash);
3996                         assert_eq!(*payment_secret, None);
3997                 },
3998                 _ => panic!("Unexpected event"),
3999         }
4000
4001         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4002         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4003         check_added_monitors!(nodes[0], 1);
4004
4005         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4006 }
4007
4008 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4009         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4010         // to avoid our counterparty failing the channel.
4011         let chanmon_cfgs = create_chanmon_cfgs(2);
4012         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4013         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4014         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4015
4016         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4017         let logger = test_utils::TestLogger::new();
4018
4019         let our_payment_hash = if send_partial_mpp {
4020                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4021                 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();
4022                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4023                 let payment_secret = PaymentSecret([0xdb; 32]);
4024                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4025                 // indicates there are more HTLCs coming.
4026                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4027                 check_added_monitors!(nodes[0], 1);
4028                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4029                 assert_eq!(events.len(), 1);
4030                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4031                 // hop should *not* yet generate any PaymentReceived event(s).
4032                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4033                 our_payment_hash
4034         } else {
4035                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4036         };
4037
4038         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4039         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4040         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4041         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4042                 header.prev_blockhash = header.bitcoin_hash();
4043                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
4044                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4045         }
4046
4047         expect_pending_htlcs_forwardable!(nodes[1]);
4048
4049         check_added_monitors!(nodes[1], 1);
4050         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4051         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4052         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4053         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4054         assert!(htlc_timeout_updates.update_fee.is_none());
4055
4056         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4057         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4058         // 100_000 msat as u64, followed by a height of 123 as u32
4059         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4060         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4061         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4062 }
4063
4064 #[test]
4065 fn test_htlc_timeout() {
4066         do_test_htlc_timeout(true);
4067         do_test_htlc_timeout(false);
4068 }
4069
4070 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4071         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4072         let chanmon_cfgs = create_chanmon_cfgs(3);
4073         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4074         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4075         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4076         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4077         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4078         let logger = test_utils::TestLogger::new();
4079
4080         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4081         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4082         {
4083                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4084                 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();
4085                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4086         }
4087         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4088         check_added_monitors!(nodes[1], 1);
4089
4090         // Now attempt to route a second payment, which should be placed in the holding cell
4091         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4092         if forwarded_htlc {
4093                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4094                 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();
4095                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4096                 check_added_monitors!(nodes[0], 1);
4097                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4098                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4099                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4100                 expect_pending_htlcs_forwardable!(nodes[1]);
4101                 check_added_monitors!(nodes[1], 0);
4102         } else {
4103                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4104                 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();
4105                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4106                 check_added_monitors!(nodes[1], 0);
4107         }
4108
4109         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4110         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4111         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4112                 header.prev_blockhash = header.bitcoin_hash();
4113                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4114         }
4115
4116         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4117         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4118
4119         header.prev_blockhash = header.bitcoin_hash();
4120         nodes[1].block_notifier.block_connected_checked(&header, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, &[], &[]);
4121
4122         if forwarded_htlc {
4123                 expect_pending_htlcs_forwardable!(nodes[1]);
4124                 check_added_monitors!(nodes[1], 1);
4125                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4126                 assert_eq!(fail_commit.len(), 1);
4127                 match fail_commit[0] {
4128                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4129                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4130                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4131                         },
4132                         _ => unreachable!(),
4133                 }
4134                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4135                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4136                         match update {
4137                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4138                                 _ => panic!("Unexpected event"),
4139                         }
4140                 } else {
4141                         panic!("Unexpected event");
4142                 }
4143         } else {
4144                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4145         }
4146 }
4147
4148 #[test]
4149 fn test_holding_cell_htlc_add_timeouts() {
4150         do_test_holding_cell_htlc_add_timeouts(false);
4151         do_test_holding_cell_htlc_add_timeouts(true);
4152 }
4153
4154 #[test]
4155 fn test_invalid_channel_announcement() {
4156         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4157         let secp_ctx = Secp256k1::new();
4158         let chanmon_cfgs = create_chanmon_cfgs(2);
4159         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4160         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4161         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4162
4163         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4164
4165         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4166         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4167         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4168         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4169
4170         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 } );
4171
4172         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4173         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4174
4175         let as_network_key = nodes[0].node.get_our_node_id();
4176         let bs_network_key = nodes[1].node.get_our_node_id();
4177
4178         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4179
4180         let mut chan_announcement;
4181
4182         macro_rules! dummy_unsigned_msg {
4183                 () => {
4184                         msgs::UnsignedChannelAnnouncement {
4185                                 features: ChannelFeatures::known(),
4186                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4187                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4188                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4189                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4190                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4191                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4192                                 excess_data: Vec::new(),
4193                         };
4194                 }
4195         }
4196
4197         macro_rules! sign_msg {
4198                 ($unsigned_msg: expr) => {
4199                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4200                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4201                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4202                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4203                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4204                         chan_announcement = msgs::ChannelAnnouncement {
4205                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4206                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4207                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4208                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4209                                 contents: $unsigned_msg
4210                         }
4211                 }
4212         }
4213
4214         let unsigned_msg = dummy_unsigned_msg!();
4215         sign_msg!(unsigned_msg);
4216         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4217         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 } );
4218
4219         // Configured with Network::Testnet
4220         let mut unsigned_msg = dummy_unsigned_msg!();
4221         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4222         sign_msg!(unsigned_msg);
4223         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4224
4225         let mut unsigned_msg = dummy_unsigned_msg!();
4226         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4227         sign_msg!(unsigned_msg);
4228         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4229 }
4230
4231 #[test]
4232 fn test_no_txn_manager_serialize_deserialize() {
4233         let chanmon_cfgs = create_chanmon_cfgs(2);
4234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4236         let logger: test_utils::TestLogger;
4237         let fee_estimator: test_utils::TestFeeEstimator;
4238         let new_chan_monitor: test_utils::TestChannelMonitor;
4239         let keys_manager: test_utils::TestKeysInterface;
4240         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4241         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4242
4243         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4244
4245         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4246
4247         let nodes_0_serialized = nodes[0].node.encode();
4248         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4249         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4250
4251         logger = test_utils::TestLogger::new();
4252         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4253         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4254         nodes[0].chan_monitor = &new_chan_monitor;
4255         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4256         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4257         assert!(chan_0_monitor_read.is_empty());
4258
4259         let mut nodes_0_read = &nodes_0_serialized[..];
4260         let config = UserConfig::default();
4261         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4262         let (_, nodes_0_deserialized_tmp) = {
4263                 let mut channel_monitors = HashMap::new();
4264                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4265                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4266                         default_config: config,
4267                         keys_manager: &keys_manager,
4268                         fee_estimator: &fee_estimator,
4269                         monitor: nodes[0].chan_monitor,
4270                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4271                         logger: &logger,
4272                         channel_monitors: &mut channel_monitors,
4273                 }).unwrap()
4274         };
4275         nodes_0_deserialized = nodes_0_deserialized_tmp;
4276         assert!(nodes_0_read.is_empty());
4277
4278         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4279         nodes[0].node = &nodes_0_deserialized;
4280         nodes[0].block_notifier.register_listener(nodes[0].node);
4281         assert_eq!(nodes[0].node.list_channels().len(), 1);
4282         check_added_monitors!(nodes[0], 1);
4283
4284         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4285         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4286         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4287         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4288
4289         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4290         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4291         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4292         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4293
4294         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4295         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4296         for node in nodes.iter() {
4297                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4298                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4299                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4300         }
4301
4302         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4303 }
4304
4305 #[test]
4306 fn test_manager_serialize_deserialize_events() {
4307         // This test makes sure the events field in ChannelManager survives de/serialization
4308         let chanmon_cfgs = create_chanmon_cfgs(2);
4309         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4310         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4311         let fee_estimator: test_utils::TestFeeEstimator;
4312         let logger: test_utils::TestLogger;
4313         let new_chan_monitor: test_utils::TestChannelMonitor;
4314         let keys_manager: test_utils::TestKeysInterface;
4315         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4316         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4317
4318         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4319         let channel_value = 100000;
4320         let push_msat = 10001;
4321         let a_flags = InitFeatures::known();
4322         let b_flags = InitFeatures::known();
4323         let node_a = nodes.pop().unwrap();
4324         let node_b = nodes.pop().unwrap();
4325         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4326         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()));
4327         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()));
4328
4329         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4330
4331         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4332         check_added_monitors!(node_a, 0);
4333
4334         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()));
4335         {
4336                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4337                 assert_eq!(added_monitors.len(), 1);
4338                 assert_eq!(added_monitors[0].0, funding_output);
4339                 added_monitors.clear();
4340         }
4341
4342         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()));
4343         {
4344                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4345                 assert_eq!(added_monitors.len(), 1);
4346                 assert_eq!(added_monitors[0].0, funding_output);
4347                 added_monitors.clear();
4348         }
4349         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4350
4351         nodes.push(node_a);
4352         nodes.push(node_b);
4353
4354         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4355         let nodes_0_serialized = nodes[0].node.encode();
4356         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4357         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4358
4359         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4360         logger = test_utils::TestLogger::new();
4361         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4362         nodes[0].chan_monitor = &new_chan_monitor;
4363         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4364         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4365         assert!(chan_0_monitor_read.is_empty());
4366
4367         let mut nodes_0_read = &nodes_0_serialized[..];
4368         let config = UserConfig::default();
4369         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4370         let (_, nodes_0_deserialized_tmp) = {
4371                 let mut channel_monitors = HashMap::new();
4372                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4373                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4374                         default_config: config,
4375                         keys_manager: &keys_manager,
4376                         fee_estimator: &fee_estimator,
4377                         monitor: nodes[0].chan_monitor,
4378                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4379                         logger: &logger,
4380                         channel_monitors: &mut channel_monitors,
4381                 }).unwrap()
4382         };
4383         nodes_0_deserialized = nodes_0_deserialized_tmp;
4384         assert!(nodes_0_read.is_empty());
4385
4386         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4387
4388         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4389         nodes[0].node = &nodes_0_deserialized;
4390
4391         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4392         let events_4 = nodes[0].node.get_and_clear_pending_events();
4393         assert_eq!(events_4.len(), 1);
4394         match events_4[0] {
4395                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4396                         assert_eq!(user_channel_id, 42);
4397                         assert_eq!(*funding_txo, funding_output);
4398                 },
4399                 _ => panic!("Unexpected event"),
4400         };
4401
4402         // Make sure the channel is functioning as though the de/serialization never happened
4403         nodes[0].block_notifier.register_listener(nodes[0].node);
4404         assert_eq!(nodes[0].node.list_channels().len(), 1);
4405         check_added_monitors!(nodes[0], 1);
4406
4407         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4408         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4409         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4410         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4411
4412         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4413         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4414         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4415         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4416
4417         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4418         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4419         for node in nodes.iter() {
4420                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4421                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4422                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4423         }
4424
4425         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4426 }
4427
4428 #[test]
4429 fn test_simple_manager_serialize_deserialize() {
4430         let chanmon_cfgs = create_chanmon_cfgs(2);
4431         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4432         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4433         let logger: test_utils::TestLogger;
4434         let fee_estimator: test_utils::TestFeeEstimator;
4435         let new_chan_monitor: test_utils::TestChannelMonitor;
4436         let keys_manager: test_utils::TestKeysInterface;
4437         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4438         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4439         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4440
4441         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4442         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4443
4444         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4445
4446         let nodes_0_serialized = nodes[0].node.encode();
4447         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4448         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4449
4450         logger = test_utils::TestLogger::new();
4451         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4452         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4453         nodes[0].chan_monitor = &new_chan_monitor;
4454         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4455         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4456         assert!(chan_0_monitor_read.is_empty());
4457
4458         let mut nodes_0_read = &nodes_0_serialized[..];
4459         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4460         let (_, nodes_0_deserialized_tmp) = {
4461                 let mut channel_monitors = HashMap::new();
4462                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4463                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4464                         default_config: UserConfig::default(),
4465                         keys_manager: &keys_manager,
4466                         fee_estimator: &fee_estimator,
4467                         monitor: nodes[0].chan_monitor,
4468                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4469                         logger: &logger,
4470                         channel_monitors: &mut channel_monitors,
4471                 }).unwrap()
4472         };
4473         nodes_0_deserialized = nodes_0_deserialized_tmp;
4474         assert!(nodes_0_read.is_empty());
4475
4476         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4477         nodes[0].node = &nodes_0_deserialized;
4478         check_added_monitors!(nodes[0], 1);
4479
4480         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4481
4482         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4483         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4484 }
4485
4486 #[test]
4487 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4488         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4489         let chanmon_cfgs = create_chanmon_cfgs(4);
4490         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4491         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4492         let logger: test_utils::TestLogger;
4493         let fee_estimator: test_utils::TestFeeEstimator;
4494         let new_chan_monitor: test_utils::TestChannelMonitor;
4495         let keys_manager: test_utils::TestKeysInterface;
4496         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4497         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4498         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4499         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4500         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4501
4502         let mut node_0_stale_monitors_serialized = Vec::new();
4503         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4504                 let mut writer = test_utils::TestVecWriter(Vec::new());
4505                 monitor.1.write_for_disk(&mut writer).unwrap();
4506                 node_0_stale_monitors_serialized.push(writer.0);
4507         }
4508
4509         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4510
4511         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4512         let nodes_0_serialized = nodes[0].node.encode();
4513
4514         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4515         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4516         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4517         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4518
4519         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4520         // nodes[3])
4521         let mut node_0_monitors_serialized = Vec::new();
4522         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4523                 let mut writer = test_utils::TestVecWriter(Vec::new());
4524                 monitor.1.write_for_disk(&mut writer).unwrap();
4525                 node_0_monitors_serialized.push(writer.0);
4526         }
4527
4528         logger = test_utils::TestLogger::new();
4529         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4530         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4531         nodes[0].chan_monitor = &new_chan_monitor;
4532
4533         let mut node_0_stale_monitors = Vec::new();
4534         for serialized in node_0_stale_monitors_serialized.iter() {
4535                 let mut read = &serialized[..];
4536                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4537                 assert!(read.is_empty());
4538                 node_0_stale_monitors.push(monitor);
4539         }
4540
4541         let mut node_0_monitors = Vec::new();
4542         for serialized in node_0_monitors_serialized.iter() {
4543                 let mut read = &serialized[..];
4544                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4545                 assert!(read.is_empty());
4546                 node_0_monitors.push(monitor);
4547         }
4548
4549         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4550
4551         let mut nodes_0_read = &nodes_0_serialized[..];
4552         if let Err(msgs::DecodeError::InvalidValue) =
4553                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4554                 default_config: UserConfig::default(),
4555                 keys_manager: &keys_manager,
4556                 fee_estimator: &fee_estimator,
4557                 monitor: nodes[0].chan_monitor,
4558                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4559                 logger: &logger,
4560                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4561         }) { } else {
4562                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4563         };
4564
4565         let mut nodes_0_read = &nodes_0_serialized[..];
4566         let (_, nodes_0_deserialized_tmp) =
4567                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4568                 default_config: UserConfig::default(),
4569                 keys_manager: &keys_manager,
4570                 fee_estimator: &fee_estimator,
4571                 monitor: nodes[0].chan_monitor,
4572                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4573                 logger: &logger,
4574                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4575         }).unwrap();
4576         nodes_0_deserialized = nodes_0_deserialized_tmp;
4577         assert!(nodes_0_read.is_empty());
4578
4579         { // Channel close should result in a commitment tx and an HTLC tx
4580                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4581                 assert_eq!(txn.len(), 2);
4582                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4583                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4584         }
4585
4586         for monitor in node_0_monitors.drain(..) {
4587                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().0, monitor).is_ok());
4588                 check_added_monitors!(nodes[0], 1);
4589         }
4590         nodes[0].node = &nodes_0_deserialized;
4591
4592         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4593         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4594         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4595         //... and we can even still claim the payment!
4596         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4597
4598         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4599         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4600         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4601         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4602         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4603         assert_eq!(msg_events.len(), 1);
4604         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4605                 match action {
4606                         &ErrorAction::SendErrorMessage { ref msg } => {
4607                                 assert_eq!(msg.channel_id, channel_id);
4608                         },
4609                         _ => panic!("Unexpected event!"),
4610                 }
4611         }
4612 }
4613
4614 macro_rules! check_spendable_outputs {
4615         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4616                 {
4617                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4618                         let mut txn = Vec::new();
4619                         for event in events {
4620                                 match event {
4621                                         Event::SpendableOutputs { ref outputs } => {
4622                                                 for outp in outputs {
4623                                                         match *outp {
4624                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4625                                                                         let input = TxIn {
4626                                                                                 previous_output: outpoint.clone(),
4627                                                                                 script_sig: Script::new(),
4628                                                                                 sequence: 0,
4629                                                                                 witness: Vec::new(),
4630                                                                         };
4631                                                                         let outp = TxOut {
4632                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4633                                                                                 value: output.value,
4634                                                                         };
4635                                                                         let mut spend_tx = Transaction {
4636                                                                                 version: 2,
4637                                                                                 lock_time: 0,
4638                                                                                 input: vec![input],
4639                                                                                 output: vec![outp],
4640                                                                         };
4641                                                                         let secp_ctx = Secp256k1::new();
4642                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4643                                                                         let remotepubkey = keys.pubkeys().payment_point;
4644                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4645                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4646                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4647                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4648                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4649                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4650                                                                         txn.push(spend_tx);
4651                                                                 },
4652                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4653                                                                         let input = TxIn {
4654                                                                                 previous_output: outpoint.clone(),
4655                                                                                 script_sig: Script::new(),
4656                                                                                 sequence: *to_self_delay as u32,
4657                                                                                 witness: Vec::new(),
4658                                                                         };
4659                                                                         let outp = TxOut {
4660                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4661                                                                                 value: output.value,
4662                                                                         };
4663                                                                         let mut spend_tx = Transaction {
4664                                                                                 version: 2,
4665                                                                                 lock_time: 0,
4666                                                                                 input: vec![input],
4667                                                                                 output: vec![outp],
4668                                                                         };
4669                                                                         let secp_ctx = Secp256k1::new();
4670                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4671                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4672
4673                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4674                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4675                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4676                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4677                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4678                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4679                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4680                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4681                                                                         } else { panic!() }
4682                                                                         txn.push(spend_tx);
4683                                                                 },
4684                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4685                                                                         let secp_ctx = Secp256k1::new();
4686                                                                         let input = TxIn {
4687                                                                                 previous_output: outpoint.clone(),
4688                                                                                 script_sig: Script::new(),
4689                                                                                 sequence: 0,
4690                                                                                 witness: Vec::new(),
4691                                                                         };
4692                                                                         let outp = TxOut {
4693                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4694                                                                                 value: output.value,
4695                                                                         };
4696                                                                         let mut spend_tx = Transaction {
4697                                                                                 version: 2,
4698                                                                                 lock_time: 0,
4699                                                                                 input: vec![input],
4700                                                                                 output: vec![outp.clone()],
4701                                                                         };
4702                                                                         let secret = {
4703                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4704                                                                                         Ok(master_key) => {
4705                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4706                                                                                                         Ok(key) => key,
4707                                                                                                         Err(_) => panic!("Your RNG is busted"),
4708                                                                                                 }
4709                                                                                         }
4710                                                                                         Err(_) => panic!("Your rng is busted"),
4711                                                                                 }
4712                                                                         };
4713                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4714                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4715                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4716                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4717                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4718                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4719                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4720                                                                         txn.push(spend_tx);
4721                                                                 },
4722                                                         }
4723                                                 }
4724                                         },
4725                                         _ => panic!("Unexpected event"),
4726                                 };
4727                         }
4728                         txn
4729                 }
4730         }
4731 }
4732
4733 #[test]
4734 fn test_claim_sizeable_push_msat() {
4735         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4736         let chanmon_cfgs = create_chanmon_cfgs(2);
4737         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4738         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4739         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4740
4741         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4742         nodes[1].node.force_close_channel(&chan.2);
4743         check_closed_broadcast!(nodes[1], false);
4744         check_added_monitors!(nodes[1], 1);
4745         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4746         assert_eq!(node_txn.len(), 1);
4747         check_spends!(node_txn[0], chan.3);
4748         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
4749
4750         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4751         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4752         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4753
4754         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4755         assert_eq!(spend_txn.len(), 1);
4756         check_spends!(spend_txn[0], node_txn[0]);
4757 }
4758
4759 #[test]
4760 fn test_claim_on_remote_sizeable_push_msat() {
4761         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4762         // to_remote output is encumbered by a P2WPKH
4763         let chanmon_cfgs = create_chanmon_cfgs(2);
4764         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4765         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4766         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4767
4768         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4769         nodes[0].node.force_close_channel(&chan.2);
4770         check_closed_broadcast!(nodes[0], false);
4771         check_added_monitors!(nodes[0], 1);
4772
4773         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4774         assert_eq!(node_txn.len(), 1);
4775         check_spends!(node_txn[0], chan.3);
4776         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
4777
4778         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4779         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4780         check_closed_broadcast!(nodes[1], false);
4781         check_added_monitors!(nodes[1], 1);
4782         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4783
4784         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4785         assert_eq!(spend_txn.len(), 2);
4786         assert_eq!(spend_txn[0], spend_txn[1]);
4787         check_spends!(spend_txn[0], node_txn[0]);
4788 }
4789
4790 #[test]
4791 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4792         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4793         // to_remote output is encumbered by a P2WPKH
4794
4795         let chanmon_cfgs = create_chanmon_cfgs(2);
4796         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4797         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4798         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4799
4800         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4801         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4802         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4803         assert_eq!(revoked_local_txn[0].input.len(), 1);
4804         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4805
4806         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4807         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4808         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4809         check_closed_broadcast!(nodes[1], false);
4810         check_added_monitors!(nodes[1], 1);
4811
4812         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4813         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4814         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4815         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4816
4817         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4818         assert_eq!(spend_txn.len(), 3);
4819         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4820         check_spends!(spend_txn[0], revoked_local_txn[0]);
4821         check_spends!(spend_txn[2], node_txn[0]);
4822 }
4823
4824 #[test]
4825 fn test_static_spendable_outputs_preimage_tx() {
4826         let chanmon_cfgs = create_chanmon_cfgs(2);
4827         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4828         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4829         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4830
4831         // Create some initial channels
4832         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4833
4834         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4835
4836         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4837         assert_eq!(commitment_tx[0].input.len(), 1);
4838         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4839
4840         // Settle A's commitment tx on B's chain
4841         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4842         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4843         check_added_monitors!(nodes[1], 1);
4844         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4845         check_added_monitors!(nodes[1], 1);
4846         let events = nodes[1].node.get_and_clear_pending_msg_events();
4847         match events[0] {
4848                 MessageSendEvent::UpdateHTLCs { .. } => {},
4849                 _ => panic!("Unexpected event"),
4850         }
4851         match events[1] {
4852                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4853                 _ => panic!("Unexepected event"),
4854         }
4855
4856         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4857         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4858         assert_eq!(node_txn.len(), 3);
4859         check_spends!(node_txn[0], commitment_tx[0]);
4860         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4861         check_spends!(node_txn[1], chan_1.3);
4862         check_spends!(node_txn[2], node_txn[1]);
4863
4864         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4865         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4866         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4867
4868         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4869         assert_eq!(spend_txn.len(), 1);
4870         check_spends!(spend_txn[0], node_txn[0]);
4871 }
4872
4873 #[test]
4874 fn test_static_spendable_outputs_timeout_tx() {
4875         let chanmon_cfgs = create_chanmon_cfgs(2);
4876         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4877         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4878         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4879
4880         // Create some initial channels
4881         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4882
4883         // Rebalance the network a bit by relaying one payment through all the channels ...
4884         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4885
4886         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4887
4888         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4889         assert_eq!(commitment_tx[0].input.len(), 1);
4890         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4891
4892         // Settle A's commitment tx on B' chain
4893         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4894         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4895         check_added_monitors!(nodes[1], 1);
4896         let events = nodes[1].node.get_and_clear_pending_msg_events();
4897         match events[0] {
4898                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4899                 _ => panic!("Unexpected event"),
4900         }
4901
4902         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4903         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4904         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4905         check_spends!(node_txn[0],  commitment_tx[0].clone());
4906         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4907         check_spends!(node_txn[1], chan_1.3.clone());
4908         check_spends!(node_txn[2], node_txn[1]);
4909
4910         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4911         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4912         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4913         expect_payment_failed!(nodes[1], our_payment_hash, true);
4914
4915         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4916         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4917         check_spends!(spend_txn[2], node_txn[0].clone());
4918 }
4919
4920 #[test]
4921 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4922         let chanmon_cfgs = create_chanmon_cfgs(2);
4923         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4924         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4925         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4926
4927         // Create some initial channels
4928         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4929
4930         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4931         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4932         assert_eq!(revoked_local_txn[0].input.len(), 1);
4933         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4934
4935         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4936
4937         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4938         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4939         check_closed_broadcast!(nodes[1], false);
4940         check_added_monitors!(nodes[1], 1);
4941
4942         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4943         assert_eq!(node_txn.len(), 2);
4944         assert_eq!(node_txn[0].input.len(), 2);
4945         check_spends!(node_txn[0], revoked_local_txn[0]);
4946
4947         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4948         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4949         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4950
4951         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4952         assert_eq!(spend_txn.len(), 1);
4953         check_spends!(spend_txn[0], node_txn[0]);
4954 }
4955
4956 #[test]
4957 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4958         let chanmon_cfgs = create_chanmon_cfgs(2);
4959         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4960         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4961         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4962
4963         // Create some initial channels
4964         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4965
4966         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4967         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4968         assert_eq!(revoked_local_txn[0].input.len(), 1);
4969         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4970
4971         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4972
4973         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4974         // A will generate HTLC-Timeout from revoked commitment tx
4975         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4976         check_closed_broadcast!(nodes[0], false);
4977         check_added_monitors!(nodes[0], 1);
4978
4979         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4980         assert_eq!(revoked_htlc_txn.len(), 2);
4981         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4982         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4983         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4984         check_spends!(revoked_htlc_txn[1], chan_1.3);
4985
4986         // B will generate justice tx from A's revoked commitment/HTLC tx
4987         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4988         check_closed_broadcast!(nodes[1], false);
4989         check_added_monitors!(nodes[1], 1);
4990
4991         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4992         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4993         assert_eq!(node_txn[0].input.len(), 2);
4994         check_spends!(node_txn[0], revoked_local_txn[0]);
4995         check_spends!(node_txn[1], chan_1.3);
4996         assert_eq!(node_txn[2].input.len(), 1);
4997         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4998         assert_eq!(node_txn[3].input.len(), 1);
4999         check_spends!(node_txn[3], revoked_local_txn[0]);
5000
5001         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5002         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5003         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5004
5005         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5006         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5007         assert_eq!(spend_txn.len(), 2);
5008         check_spends!(spend_txn[0], node_txn[0]);
5009         check_spends!(spend_txn[1], node_txn[2]);
5010 }
5011
5012 #[test]
5013 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5014         let chanmon_cfgs = create_chanmon_cfgs(2);
5015         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5017         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5018
5019         // Create some initial channels
5020         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5021
5022         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5023         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5024         assert_eq!(revoked_local_txn[0].input.len(), 1);
5025         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5026
5027         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5028
5029         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5030         // B will generate HTLC-Success from revoked commitment tx
5031         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5032         check_closed_broadcast!(nodes[1], false);
5033         check_added_monitors!(nodes[1], 1);
5034         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5035
5036         assert_eq!(revoked_htlc_txn.len(), 2);
5037         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5038         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5039         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5040
5041         // A will generate justice tx from B's revoked commitment/HTLC tx
5042         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5043         check_closed_broadcast!(nodes[0], false);
5044         check_added_monitors!(nodes[0], 1);
5045
5046         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5047         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5048         assert_eq!(node_txn[2].input.len(), 1);
5049         check_spends!(node_txn[2], revoked_htlc_txn[0]);
5050
5051         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5052         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5053         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5054
5055         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5056         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5057         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5058         assert_eq!(spend_txn[0], spend_txn[1]);
5059         assert_eq!(spend_txn[0], spend_txn[2]);
5060         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5061         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5062         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5063 }
5064
5065 #[test]
5066 fn test_onchain_to_onchain_claim() {
5067         // Test that in case of channel closure, we detect the state of output thanks to
5068         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5069         // First, have C claim an HTLC against its own latest commitment transaction.
5070         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5071         // channel.
5072         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5073         // gets broadcast.
5074
5075         let chanmon_cfgs = create_chanmon_cfgs(3);
5076         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5077         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5078         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5079
5080         // Create some initial channels
5081         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5082         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5083
5084         // Rebalance the network a bit by relaying one payment through all the channels ...
5085         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5086         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5087
5088         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5089         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5090         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5091         check_spends!(commitment_tx[0], chan_2.3);
5092         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5093         check_added_monitors!(nodes[2], 1);
5094         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5095         assert!(updates.update_add_htlcs.is_empty());
5096         assert!(updates.update_fail_htlcs.is_empty());
5097         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5098         assert!(updates.update_fail_malformed_htlcs.is_empty());
5099
5100         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5101         check_closed_broadcast!(nodes[2], false);
5102         check_added_monitors!(nodes[2], 1);
5103
5104         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5105         assert_eq!(c_txn.len(), 3);
5106         assert_eq!(c_txn[0], c_txn[2]);
5107         assert_eq!(commitment_tx[0], c_txn[1]);
5108         check_spends!(c_txn[1], chan_2.3);
5109         check_spends!(c_txn[2], c_txn[1]);
5110         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5111         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5112         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5113         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5114
5115         // 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
5116         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5117         {
5118                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5119                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5120                 assert_eq!(b_txn.len(), 3);
5121                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5122                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5123                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5124                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5125                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5126                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5127                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5128                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5129                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5130                 b_txn.clear();
5131         }
5132         check_added_monitors!(nodes[1], 1);
5133         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5134         check_added_monitors!(nodes[1], 1);
5135         match msg_events[0] {
5136                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5137                 _ => panic!("Unexpected event"),
5138         }
5139         match msg_events[1] {
5140                 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, .. } } => {
5141                         assert!(update_add_htlcs.is_empty());
5142                         assert!(update_fail_htlcs.is_empty());
5143                         assert_eq!(update_fulfill_htlcs.len(), 1);
5144                         assert!(update_fail_malformed_htlcs.is_empty());
5145                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5146                 },
5147                 _ => panic!("Unexpected event"),
5148         };
5149         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5150         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5151         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5152         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5153         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5154         assert_eq!(b_txn.len(), 3);
5155         check_spends!(b_txn[1], chan_1.3);
5156         check_spends!(b_txn[2], b_txn[1]);
5157         check_spends!(b_txn[0], commitment_tx[0]);
5158         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5159         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5160         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5161
5162         check_closed_broadcast!(nodes[1], false);
5163         check_added_monitors!(nodes[1], 1);
5164 }
5165
5166 #[test]
5167 fn test_duplicate_payment_hash_one_failure_one_success() {
5168         // Topology : A --> B --> C
5169         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5170         let chanmon_cfgs = create_chanmon_cfgs(3);
5171         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5172         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5173         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5174
5175         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5176         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5177
5178         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5179         *nodes[0].network_payment_count.borrow_mut() -= 1;
5180         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5181
5182         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5183         assert_eq!(commitment_txn[0].input.len(), 1);
5184         check_spends!(commitment_txn[0], chan_2.3);
5185
5186         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5187         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5188         check_closed_broadcast!(nodes[1], false);
5189         check_added_monitors!(nodes[1], 1);
5190
5191         let htlc_timeout_tx;
5192         { // Extract one of the two HTLC-Timeout transaction
5193                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5194                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5195                 assert_eq!(node_txn.len(), 5);
5196                 check_spends!(node_txn[0], commitment_txn[0]);
5197                 assert_eq!(node_txn[0].input.len(), 1);
5198                 check_spends!(node_txn[1], commitment_txn[0]);
5199                 assert_eq!(node_txn[1].input.len(), 1);
5200                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5201                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5202                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5203                 check_spends!(node_txn[2], chan_2.3);
5204                 check_spends!(node_txn[3], node_txn[2]);
5205                 check_spends!(node_txn[4], node_txn[2]);
5206                 htlc_timeout_tx = node_txn[1].clone();
5207         }
5208
5209         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5210         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5211         check_added_monitors!(nodes[2], 3);
5212         let events = nodes[2].node.get_and_clear_pending_msg_events();
5213         match events[0] {
5214                 MessageSendEvent::UpdateHTLCs { .. } => {},
5215                 _ => panic!("Unexpected event"),
5216         }
5217         match events[1] {
5218                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5219                 _ => panic!("Unexepected event"),
5220         }
5221         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5222         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)
5223         check_spends!(htlc_success_txn[2], chan_2.3);
5224         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5225         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5226         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5227         assert_eq!(htlc_success_txn[0].input.len(), 1);
5228         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5229         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5230         assert_eq!(htlc_success_txn[1].input.len(), 1);
5231         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5232         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5233         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5234         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5235
5236         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5237         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5238         expect_pending_htlcs_forwardable!(nodes[1]);
5239         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5240         assert!(htlc_updates.update_add_htlcs.is_empty());
5241         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5242         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5243         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5244         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5245         check_added_monitors!(nodes[1], 1);
5246
5247         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5248         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5249         {
5250                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5251                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5252                 assert_eq!(events.len(), 1);
5253                 match events[0] {
5254                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5255                         },
5256                         _ => { panic!("Unexpected event"); }
5257                 }
5258         }
5259         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5260
5261         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5262         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5263         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5264         assert!(updates.update_add_htlcs.is_empty());
5265         assert!(updates.update_fail_htlcs.is_empty());
5266         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5267         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5268         assert!(updates.update_fail_malformed_htlcs.is_empty());
5269         check_added_monitors!(nodes[1], 1);
5270
5271         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5272         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5273
5274         let events = nodes[0].node.get_and_clear_pending_events();
5275         match events[0] {
5276                 Event::PaymentSent { ref payment_preimage } => {
5277                         assert_eq!(*payment_preimage, our_payment_preimage);
5278                 }
5279                 _ => panic!("Unexpected event"),
5280         }
5281 }
5282
5283 #[test]
5284 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5285         let chanmon_cfgs = create_chanmon_cfgs(2);
5286         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5287         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5288         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5289
5290         // Create some initial channels
5291         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5292
5293         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5294         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5295         assert_eq!(local_txn[0].input.len(), 1);
5296         check_spends!(local_txn[0], chan_1.3);
5297
5298         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5299         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5300         check_added_monitors!(nodes[1], 1);
5301         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5302         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5303         check_added_monitors!(nodes[1], 1);
5304         let events = nodes[1].node.get_and_clear_pending_msg_events();
5305         match events[0] {
5306                 MessageSendEvent::UpdateHTLCs { .. } => {},
5307                 _ => panic!("Unexpected event"),
5308         }
5309         match events[1] {
5310                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5311                 _ => panic!("Unexepected event"),
5312         }
5313         let node_txn = {
5314                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5315                 assert_eq!(node_txn[0].input.len(), 1);
5316                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5317                 check_spends!(node_txn[0], local_txn[0]);
5318                 vec![node_txn[0].clone(), node_txn[2].clone()]
5319         };
5320
5321         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5322         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5323         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5324
5325         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5326         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5327         assert_eq!(spend_txn.len(), 2);
5328         check_spends!(spend_txn[0], node_txn[0]);
5329         check_spends!(spend_txn[1], node_txn[1]);
5330 }
5331
5332 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5333         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5334         // unrevoked commitment transaction.
5335         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5336         // a remote RAA before they could be failed backwards (and combinations thereof).
5337         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5338         // use the same payment hashes.
5339         // Thus, we use a six-node network:
5340         //
5341         // A \         / E
5342         //    - C - D -
5343         // B /         \ F
5344         // And test where C fails back to A/B when D announces its latest commitment transaction
5345         let chanmon_cfgs = create_chanmon_cfgs(6);
5346         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5347         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5348         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5349         let logger = test_utils::TestLogger::new();
5350
5351         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5352         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5353         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5354         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5355         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5356
5357         // Rebalance and check output sanity...
5358         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5359         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5360         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5361
5362         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5363         // 0th HTLC:
5364         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
5365         // 1st HTLC:
5366         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
5367         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5368         let our_node_id = &nodes[1].node.get_our_node_id();
5369         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();
5370         // 2nd HTLC:
5371         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
5372         // 3rd HTLC:
5373         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
5374         // 4th HTLC:
5375         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5376         // 5th HTLC:
5377         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5378         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();
5379         // 6th HTLC:
5380         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5381         // 7th HTLC:
5382         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5383
5384         // 8th HTLC:
5385         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5386         // 9th HTLC:
5387         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();
5388         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
5389
5390         // 10th HTLC:
5391         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
5392         // 11th HTLC:
5393         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();
5394         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5395
5396         // Double-check that six of the new HTLC were added
5397         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5398         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5399         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5400         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5401
5402         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5403         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5404         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5405         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5406         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5407         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5408         check_added_monitors!(nodes[4], 0);
5409         expect_pending_htlcs_forwardable!(nodes[4]);
5410         check_added_monitors!(nodes[4], 1);
5411
5412         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5413         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5414         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5415         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5416         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5417         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5418
5419         // Fail 3rd below-dust and 7th above-dust HTLCs
5420         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5421         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5422         check_added_monitors!(nodes[5], 0);
5423         expect_pending_htlcs_forwardable!(nodes[5]);
5424         check_added_monitors!(nodes[5], 1);
5425
5426         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5427         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5428         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5429         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5430
5431         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5432
5433         expect_pending_htlcs_forwardable!(nodes[3]);
5434         check_added_monitors!(nodes[3], 1);
5435         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5436         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5437         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5438         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5439         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5440         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5441         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5442         if deliver_last_raa {
5443                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5444         } else {
5445                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5446         }
5447
5448         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5449         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5450         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5451         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5452         //
5453         // We now broadcast the latest commitment transaction, which *should* result in failures for
5454         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5455         // the non-broadcast above-dust HTLCs.
5456         //
5457         // Alternatively, we may broadcast the previous commitment transaction, which should only
5458         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5459         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5460
5461         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5462         if announce_latest {
5463                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5464         } else {
5465                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5466         }
5467         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5468         check_closed_broadcast!(nodes[2], false);
5469         expect_pending_htlcs_forwardable!(nodes[2]);
5470         check_added_monitors!(nodes[2], 3);
5471
5472         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5473         assert_eq!(cs_msgs.len(), 2);
5474         let mut a_done = false;
5475         for msg in cs_msgs {
5476                 match msg {
5477                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5478                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5479                                 // should be failed-backwards here.
5480                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5481                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5482                                         for htlc in &updates.update_fail_htlcs {
5483                                                 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 });
5484                                         }
5485                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5486                                         assert!(!a_done);
5487                                         a_done = true;
5488                                         &nodes[0]
5489                                 } else {
5490                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5491                                         for htlc in &updates.update_fail_htlcs {
5492                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5493                                         }
5494                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5495                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5496                                         &nodes[1]
5497                                 };
5498                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5499                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5500                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5501                                 if announce_latest {
5502                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5503                                         if *node_id == nodes[0].node.get_our_node_id() {
5504                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5505                                         }
5506                                 }
5507                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5508                         },
5509                         _ => panic!("Unexpected event"),
5510                 }
5511         }
5512
5513         let as_events = nodes[0].node.get_and_clear_pending_events();
5514         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5515         let mut as_failds = HashSet::new();
5516         for event in as_events.iter() {
5517                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5518                         assert!(as_failds.insert(*payment_hash));
5519                         if *payment_hash != payment_hash_2 {
5520                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5521                         } else {
5522                                 assert!(!rejected_by_dest);
5523                         }
5524                 } else { panic!("Unexpected event"); }
5525         }
5526         assert!(as_failds.contains(&payment_hash_1));
5527         assert!(as_failds.contains(&payment_hash_2));
5528         if announce_latest {
5529                 assert!(as_failds.contains(&payment_hash_3));
5530                 assert!(as_failds.contains(&payment_hash_5));
5531         }
5532         assert!(as_failds.contains(&payment_hash_6));
5533
5534         let bs_events = nodes[1].node.get_and_clear_pending_events();
5535         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5536         let mut bs_failds = HashSet::new();
5537         for event in bs_events.iter() {
5538                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5539                         assert!(bs_failds.insert(*payment_hash));
5540                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5541                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5542                         } else {
5543                                 assert!(!rejected_by_dest);
5544                         }
5545                 } else { panic!("Unexpected event"); }
5546         }
5547         assert!(bs_failds.contains(&payment_hash_1));
5548         assert!(bs_failds.contains(&payment_hash_2));
5549         if announce_latest {
5550                 assert!(bs_failds.contains(&payment_hash_4));
5551         }
5552         assert!(bs_failds.contains(&payment_hash_5));
5553
5554         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5555         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5556         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5557         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5558         // PaymentFailureNetworkUpdates.
5559         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5560         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5561         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5562         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5563         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5564                 match event {
5565                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5566                         _ => panic!("Unexpected event"),
5567                 }
5568         }
5569 }
5570
5571 #[test]
5572 fn test_fail_backwards_latest_remote_announce_a() {
5573         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5574 }
5575
5576 #[test]
5577 fn test_fail_backwards_latest_remote_announce_b() {
5578         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5579 }
5580
5581 #[test]
5582 fn test_fail_backwards_previous_remote_announce() {
5583         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5584         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5585         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5586 }
5587
5588 #[test]
5589 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5590         let chanmon_cfgs = create_chanmon_cfgs(2);
5591         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5592         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5593         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5594
5595         // Create some initial channels
5596         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5597
5598         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5599         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5600         assert_eq!(local_txn[0].input.len(), 1);
5601         check_spends!(local_txn[0], chan_1.3);
5602
5603         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5604         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5605         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5606         check_closed_broadcast!(nodes[0], false);
5607         check_added_monitors!(nodes[0], 1);
5608
5609         let htlc_timeout = {
5610                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5611                 assert_eq!(node_txn[0].input.len(), 1);
5612                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5613                 check_spends!(node_txn[0], local_txn[0]);
5614                 node_txn[0].clone()
5615         };
5616
5617         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5618         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5619         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5620         expect_payment_failed!(nodes[0], our_payment_hash, true);
5621
5622         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5623         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5624         assert_eq!(spend_txn.len(), 3);
5625         assert_eq!(spend_txn[0], spend_txn[1]);
5626         check_spends!(spend_txn[0], local_txn[0]);
5627         check_spends!(spend_txn[2], htlc_timeout);
5628 }
5629
5630 #[test]
5631 fn test_key_derivation_params() {
5632         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5633         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5634         // let us re-derive the channel key set to then derive a delayed_payment_key.
5635
5636         let chanmon_cfgs = create_chanmon_cfgs(3);
5637
5638         // We manually create the node configuration to backup the seed.
5639         let seed = [42; 32];
5640         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5641         let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5642         let node = NodeCfg { chain_monitor: &chanmon_cfgs[0].chain_monitor, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chan_monitor, keys_manager, node_seed: seed };
5643         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5644         node_cfgs.remove(0);
5645         node_cfgs.insert(0, node);
5646
5647         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5648         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5649
5650         // Create some initial channels
5651         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5652         // for node 0
5653         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5654         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5655         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5656
5657         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5658         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5659         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5660         assert_eq!(local_txn_1[0].input.len(), 1);
5661         check_spends!(local_txn_1[0], chan_1.3);
5662
5663         // We check funding pubkey are unique
5664         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]));
5665         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]));
5666         if from_0_funding_key_0 == from_1_funding_key_0
5667             || from_0_funding_key_0 == from_1_funding_key_1
5668             || from_0_funding_key_1 == from_1_funding_key_0
5669             || from_0_funding_key_1 == from_1_funding_key_1 {
5670                 panic!("Funding pubkeys aren't unique");
5671         }
5672
5673         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5674         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5675         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5676         check_closed_broadcast!(nodes[0], false);
5677         check_added_monitors!(nodes[0], 1);
5678
5679         let htlc_timeout = {
5680                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5681                 assert_eq!(node_txn[0].input.len(), 1);
5682                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5683                 check_spends!(node_txn[0], local_txn_1[0]);
5684                 node_txn[0].clone()
5685         };
5686
5687         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5688         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5689         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5690         expect_payment_failed!(nodes[0], our_payment_hash, true);
5691
5692         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5693         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5694         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5695         assert_eq!(spend_txn.len(), 3);
5696         assert_eq!(spend_txn[0], spend_txn[1]);
5697         check_spends!(spend_txn[0], local_txn_1[0]);
5698         check_spends!(spend_txn[2], htlc_timeout);
5699 }
5700
5701 #[test]
5702 fn test_static_output_closing_tx() {
5703         let chanmon_cfgs = create_chanmon_cfgs(2);
5704         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5706         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5707
5708         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5709
5710         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5711         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5712
5713         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5714         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5715         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5716
5717         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5718         assert_eq!(spend_txn.len(), 1);
5719         check_spends!(spend_txn[0], closing_tx);
5720
5721         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5722         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5723
5724         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5725         assert_eq!(spend_txn.len(), 1);
5726         check_spends!(spend_txn[0], closing_tx);
5727 }
5728
5729 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5730         let chanmon_cfgs = create_chanmon_cfgs(2);
5731         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5732         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5733         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5734         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5735
5736         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5737
5738         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5739         // present in B's local commitment transaction, but none of A's commitment transactions.
5740         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5741         check_added_monitors!(nodes[1], 1);
5742
5743         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5744         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5745         let events = nodes[0].node.get_and_clear_pending_events();
5746         assert_eq!(events.len(), 1);
5747         match events[0] {
5748                 Event::PaymentSent { payment_preimage } => {
5749                         assert_eq!(payment_preimage, our_payment_preimage);
5750                 },
5751                 _ => panic!("Unexpected event"),
5752         }
5753
5754         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5755         check_added_monitors!(nodes[0], 1);
5756         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5757         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5758         check_added_monitors!(nodes[1], 1);
5759
5760         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5761         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5762                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5763                 header.prev_blockhash = header.bitcoin_hash();
5764         }
5765         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5766         check_closed_broadcast!(nodes[1], false);
5767         check_added_monitors!(nodes[1], 1);
5768 }
5769
5770 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5771         let chanmon_cfgs = create_chanmon_cfgs(2);
5772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5774         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5775         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5776         let logger = test_utils::TestLogger::new();
5777
5778         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5779         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5780         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();
5781         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5782         check_added_monitors!(nodes[0], 1);
5783
5784         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5785
5786         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5787         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5788         // to "time out" the HTLC.
5789
5790         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5791
5792         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5793                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5794                 header.prev_blockhash = header.bitcoin_hash();
5795         }
5796         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5797         check_closed_broadcast!(nodes[0], false);
5798         check_added_monitors!(nodes[0], 1);
5799 }
5800
5801 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5802         let chanmon_cfgs = create_chanmon_cfgs(3);
5803         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5804         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5805         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5806         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5807
5808         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5809         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5810         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5811         // actually revoked.
5812         let htlc_value = if use_dust { 50000 } else { 3000000 };
5813         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5814         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5815         expect_pending_htlcs_forwardable!(nodes[1]);
5816         check_added_monitors!(nodes[1], 1);
5817
5818         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5819         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5820         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5821         check_added_monitors!(nodes[0], 1);
5822         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5823         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5824         check_added_monitors!(nodes[1], 1);
5825         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5826         check_added_monitors!(nodes[1], 1);
5827         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5828
5829         if check_revoke_no_close {
5830                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5831                 check_added_monitors!(nodes[0], 1);
5832         }
5833
5834         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5835         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5836                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5837                 header.prev_blockhash = header.bitcoin_hash();
5838         }
5839         if !check_revoke_no_close {
5840                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5841                 check_closed_broadcast!(nodes[0], false);
5842                 check_added_monitors!(nodes[0], 1);
5843         } else {
5844                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5845         }
5846 }
5847
5848 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5849 // There are only a few cases to test here:
5850 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5851 //    broadcastable commitment transactions result in channel closure,
5852 //  * its included in an unrevoked-but-previous remote commitment transaction,
5853 //  * its included in the latest remote or local commitment transactions.
5854 // We test each of the three possible commitment transactions individually and use both dust and
5855 // non-dust HTLCs.
5856 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5857 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5858 // tested for at least one of the cases in other tests.
5859 #[test]
5860 fn htlc_claim_single_commitment_only_a() {
5861         do_htlc_claim_local_commitment_only(true);
5862         do_htlc_claim_local_commitment_only(false);
5863
5864         do_htlc_claim_current_remote_commitment_only(true);
5865         do_htlc_claim_current_remote_commitment_only(false);
5866 }
5867
5868 #[test]
5869 fn htlc_claim_single_commitment_only_b() {
5870         do_htlc_claim_previous_remote_commitment_only(true, false);
5871         do_htlc_claim_previous_remote_commitment_only(false, false);
5872         do_htlc_claim_previous_remote_commitment_only(true, true);
5873         do_htlc_claim_previous_remote_commitment_only(false, true);
5874 }
5875
5876 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5877         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5878                                 F2: FnMut(),
5879 {
5880         run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
5881 }
5882
5883 // test_case
5884 // 0: node1 fails backward
5885 // 1: final node fails backward
5886 // 2: payment completed but the user rejects the payment
5887 // 3: final node fails backward (but tamper onion payloads from node0)
5888 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5889 // 200: trigger error in the final node and tamper returning fail_htlc
5890 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5891         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5892                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5893                                 F3: FnMut(),
5894 {
5895
5896         // reset block height
5897         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5898         for ix in 0..nodes.len() {
5899                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5900         }
5901
5902         macro_rules! expect_event {
5903                 ($node: expr, $event_type: path) => {{
5904                         let events = $node.node.get_and_clear_pending_events();
5905                         assert_eq!(events.len(), 1);
5906                         match events[0] {
5907                                 $event_type { .. } => {},
5908                                 _ => panic!("Unexpected event"),
5909                         }
5910                 }}
5911         }
5912
5913         macro_rules! expect_htlc_forward {
5914                 ($node: expr) => {{
5915                         expect_event!($node, Event::PendingHTLCsForwardable);
5916                         $node.node.process_pending_htlc_forwards();
5917                 }}
5918         }
5919
5920         // 0 ~~> 2 send payment
5921         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5922         check_added_monitors!(nodes[0], 1);
5923         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5924         // temper update_add (0 => 1)
5925         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5926         if test_case == 0 || test_case == 3 || test_case == 100 {
5927                 callback_msg(&mut update_add_0);
5928                 callback_node();
5929         }
5930         // 0 => 1 update_add & CS
5931         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5932         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5933
5934         let update_1_0 = match test_case {
5935                 0|100 => { // intermediate node failure; fail backward to 0
5936                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5937                         assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
5938                         update_1_0
5939                 },
5940                 1|2|3|200 => { // final node failure; forwarding to 2
5941                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5942                         // forwarding on 1
5943                         if test_case != 200 {
5944                                 callback_node();
5945                         }
5946                         expect_htlc_forward!(&nodes[1]);
5947
5948                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5949                         check_added_monitors!(&nodes[1], 1);
5950                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5951                         // tamper update_add (1 => 2)
5952                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5953                         if test_case != 3 && test_case != 200 {
5954                                 callback_msg(&mut update_add_1);
5955                         }
5956
5957                         // 1 => 2
5958                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5959                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5960
5961                         if test_case == 2 || test_case == 200 {
5962                                 expect_htlc_forward!(&nodes[2]);
5963                                 expect_event!(&nodes[2], Event::PaymentReceived);
5964                                 callback_node();
5965                                 expect_pending_htlcs_forwardable!(nodes[2]);
5966                         }
5967
5968                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5969                         if test_case == 2 || test_case == 200 {
5970                                 check_added_monitors!(&nodes[2], 1);
5971                         }
5972                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5973
5974                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5975                         if test_case == 200 {
5976                                 callback_fail(&mut fail_msg);
5977                         }
5978
5979                         // 2 => 1
5980                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5981                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5982
5983                         // backward fail on 1
5984                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5985                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5986                         update_1_0
5987                 },
5988                 _ => unreachable!(),
5989         };
5990
5991         // 1 => 0 commitment_signed_dance
5992         if update_1_0.update_fail_htlcs.len() > 0 {
5993                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5994                 if test_case == 100 {
5995                         callback_fail(&mut fail_msg);
5996                 }
5997                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5998         } else {
5999                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
6000         };
6001
6002         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6003
6004         let events = nodes[0].node.get_and_clear_pending_events();
6005         assert_eq!(events.len(), 1);
6006         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6007                 assert_eq!(*rejected_by_dest, !expected_retryable);
6008                 assert_eq!(*error_code, expected_error_code);
6009         } else {
6010                 panic!("Uexpected event");
6011         }
6012
6013         let events = nodes[0].node.get_and_clear_pending_msg_events();
6014         if expected_channel_update.is_some() {
6015                 assert_eq!(events.len(), 1);
6016                 match events[0] {
6017                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6018                                 match update {
6019                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6020                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6021                                                         panic!("channel_update not found!");
6022                                                 }
6023                                         },
6024                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6025                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6026                                                         assert!(*short_channel_id == *expected_short_channel_id);
6027                                                         assert!(*is_permanent == *expected_is_permanent);
6028                                                 } else {
6029                                                         panic!("Unexpected message event");
6030                                                 }
6031                                         },
6032                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6033                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6034                                                         assert!(*node_id == *expected_node_id);
6035                                                         assert!(*is_permanent == *expected_is_permanent);
6036                                                 } else {
6037                                                         panic!("Unexpected message event");
6038                                                 }
6039                                         },
6040                                 }
6041                         },
6042                         _ => panic!("Unexpected message event"),
6043                 }
6044         } else {
6045                 assert_eq!(events.len(), 0);
6046         }
6047 }
6048
6049 impl msgs::ChannelUpdate {
6050         fn dummy() -> msgs::ChannelUpdate {
6051                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6052                 use bitcoin::secp256k1::Signature;
6053                 msgs::ChannelUpdate {
6054                         signature: Signature::from(FFISignature::new()),
6055                         contents: msgs::UnsignedChannelUpdate {
6056                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
6057                                 short_channel_id: 0,
6058                                 timestamp: 0,
6059                                 flags: 0,
6060                                 cltv_expiry_delta: 0,
6061                                 htlc_minimum_msat: 0,
6062                                 htlc_maximum_msat: OptionalField::Absent,
6063                                 fee_base_msat: 0,
6064                                 fee_proportional_millionths: 0,
6065                                 excess_data: vec![],
6066                         }
6067                 }
6068         }
6069 }
6070
6071 struct BogusOnionHopData {
6072         data: Vec<u8>
6073 }
6074 impl BogusOnionHopData {
6075         fn new(orig: msgs::OnionHopData) -> Self {
6076                 Self { data: orig.encode() }
6077         }
6078 }
6079 impl Writeable for BogusOnionHopData {
6080         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6081                 writer.write_all(&self.data[..])
6082         }
6083 }
6084
6085 #[test]
6086 fn test_onion_failure() {
6087         use ln::msgs::ChannelUpdate;
6088         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6089         use bitcoin::secp256k1;
6090
6091         const BADONION: u16 = 0x8000;
6092         const PERM: u16 = 0x4000;
6093         const NODE: u16 = 0x2000;
6094         const UPDATE: u16 = 0x1000;
6095
6096         let chanmon_cfgs = create_chanmon_cfgs(3);
6097         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6098         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6099         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6100         for node in nodes.iter() {
6101                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
6102         }
6103         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
6104         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6105         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6106         let logger = test_utils::TestLogger::new();
6107         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(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
6108         // positve case
6109         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6110
6111         // intermediate node failure
6112         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6113                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6114                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6115                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6116                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6117                 let mut new_payloads = Vec::new();
6118                 for payload in onion_payloads.drain(..) {
6119                         new_payloads.push(BogusOnionHopData::new(payload));
6120                 }
6121                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6122                 // describing a length-1 TLV payload, which is obviously bogus.
6123                 new_payloads[0].data[0] = 1;
6124                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6125         }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
6126
6127         // final node failure
6128         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6129                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6130                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6131                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6132                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6133                 let mut new_payloads = Vec::new();
6134                 for payload in onion_payloads.drain(..) {
6135                         new_payloads.push(BogusOnionHopData::new(payload));
6136                 }
6137                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6138                 // length-1 TLV payload, which is obviously bogus.
6139                 new_payloads[1].data[0] = 1;
6140                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6141         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6142
6143         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6144         // receiving simulated fail messages
6145         // intermediate node failure
6146         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6147                 // trigger error
6148                 msg.amount_msat -= 1;
6149         }, |msg| {
6150                 // and tamper returning error message
6151                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6152                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6153                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6154         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6155
6156         // final node failure
6157         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6158                 // and tamper returning error message
6159                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6160                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6161                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6162         }, ||{
6163                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6164         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6165
6166         // intermediate node failure
6167         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6168                 msg.amount_msat -= 1;
6169         }, |msg| {
6170                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6171                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6172                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6173         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6174
6175         // final node failure
6176         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6177                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6178                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6179                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6180         }, ||{
6181                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6182         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6183
6184         // intermediate node failure
6185         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6186                 msg.amount_msat -= 1;
6187         }, |msg| {
6188                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6189                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6190                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6191         }, ||{
6192                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6193         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6194
6195         // final node failure
6196         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6197                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6198                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6199                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6200         }, ||{
6201                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6202         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6203
6204         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6205                 Some(BADONION|PERM|4), None);
6206
6207         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6208                 Some(BADONION|PERM|5), None);
6209
6210         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6211                 Some(BADONION|PERM|6), None);
6212
6213         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6214                 msg.amount_msat -= 1;
6215         }, |msg| {
6216                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6217                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6218                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6219         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6220
6221         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6222                 msg.amount_msat -= 1;
6223         }, |msg| {
6224                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6225                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6226                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6227                 // short_channel_id from the processing node
6228         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6229
6230         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6231                 msg.amount_msat -= 1;
6232         }, |msg| {
6233                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6234                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6235                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6236                 // short_channel_id from the processing node
6237         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6238
6239         let mut bogus_route = route.clone();
6240         bogus_route.paths[0][1].short_channel_id -= 1;
6241         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6242           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6243
6244         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6245         let mut bogus_route = route.clone();
6246         let route_len = bogus_route.paths[0].len();
6247         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6248         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6249
6250         //TODO: with new config API, we will be able to generate both valid and
6251         //invalid channel_update cases.
6252         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6253                 msg.amount_msat -= 1;
6254         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6255
6256         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6257                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6258                 msg.cltv_expiry -= 1;
6259         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6260
6261         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6262                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6263                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6264
6265                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
6266         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6267
6268         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6269                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6270         }, false, Some(PERM|15), None);
6271
6272         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6273                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6274                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6275
6276                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
6277         }, || {}, true, Some(17), None);
6278
6279         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6280                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6281                         for f in pending_forwards.iter_mut() {
6282                                 match f {
6283                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6284                                                 forward_info.outgoing_cltv_value += 1,
6285                                         _ => {},
6286                                 }
6287                         }
6288                 }
6289         }, true, Some(18), None);
6290
6291         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6292                 // violate amt_to_forward > msg.amount_msat
6293                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6294                         for f in pending_forwards.iter_mut() {
6295                                 match f {
6296                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6297                                                 forward_info.amt_to_forward -= 1,
6298                                         _ => {},
6299                                 }
6300                         }
6301                 }
6302         }, true, Some(19), None);
6303
6304         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6305                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6306                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6307                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6308         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6309         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6310
6311         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6312                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6313                 let mut route = route.clone();
6314                 let height = 1;
6315                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6316                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6317                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6318                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6319                 msg.cltv_expiry = htlc_cltv;
6320                 msg.onion_routing_packet = onion_packet;
6321         }, ||{}, true, Some(21), None);
6322 }
6323
6324 #[test]
6325 #[should_panic]
6326 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6327         let chanmon_cfgs = create_chanmon_cfgs(2);
6328         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6329         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6330         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6331         //Force duplicate channel ids
6332         for node in nodes.iter() {
6333                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6334         }
6335
6336         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6337         let channel_value_satoshis=10000;
6338         let push_msat=10001;
6339         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6340         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6341         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6342
6343         //Create a second channel with a channel_id collision
6344         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6345 }
6346
6347 #[test]
6348 fn bolt2_open_channel_sending_node_checks_part2() {
6349         let chanmon_cfgs = create_chanmon_cfgs(2);
6350         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6351         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6352         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6353
6354         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6355         let channel_value_satoshis=2^24;
6356         let push_msat=10001;
6357         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6358
6359         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6360         let channel_value_satoshis=10000;
6361         // Test when push_msat is equal to 1000 * funding_satoshis.
6362         let push_msat=1000*channel_value_satoshis+1;
6363         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6364
6365         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6366         let channel_value_satoshis=10000;
6367         let push_msat=10001;
6368         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
6369         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6370         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6371
6372         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6373         // 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
6374         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6375
6376         // 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.
6377         assert!(BREAKDOWN_TIMEOUT>0);
6378         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6379
6380         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6381         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6382         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6383
6384         // 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.
6385         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6386         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6387         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6388         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6389         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6390 }
6391
6392 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6393 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6394 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6395 // is no longer affordable once it's freed.
6396 #[test]
6397 fn test_fail_holding_cell_htlc_upon_free() {
6398         let chanmon_cfgs = create_chanmon_cfgs(2);
6399         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6400         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6401         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6402         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6403         let logger = test_utils::TestLogger::new();
6404
6405         // First nodes[0] generates an update_fee, setting the channel's
6406         // pending_update_fee.
6407         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6408         check_added_monitors!(nodes[0], 1);
6409
6410         let events = nodes[0].node.get_and_clear_pending_msg_events();
6411         assert_eq!(events.len(), 1);
6412         let (update_msg, commitment_signed) = match events[0] {
6413                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6414                         (update_fee.as_ref(), commitment_signed)
6415                 },
6416                 _ => panic!("Unexpected event"),
6417         };
6418
6419         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6420
6421         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6422         let channel_reserve = chan_stat.channel_reserve_msat;
6423         let feerate = get_feerate!(nodes[0], chan.2);
6424
6425         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6426         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6427         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6428         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6429         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();
6430
6431         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6432         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6433         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6434         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6435
6436         // Flush the pending fee update.
6437         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6438         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6439         check_added_monitors!(nodes[1], 1);
6440         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6441         check_added_monitors!(nodes[0], 1);
6442
6443         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6444         // HTLC, but now that the fee has been raised the payment will now fail, causing
6445         // us to surface its failure to the user.
6446         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6447         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6448         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6449         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6450         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6451
6452         // Check that the payment failed to be sent out.
6453         let events = nodes[0].node.get_and_clear_pending_events();
6454         assert_eq!(events.len(), 1);
6455         match &events[0] {
6456                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6457                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6458                         assert_eq!(*rejected_by_dest, false);
6459                         assert_eq!(*error_code, None);
6460                         assert_eq!(*error_data, None);
6461                 },
6462                 _ => panic!("Unexpected event"),
6463         }
6464 }
6465
6466 // Test that if multiple HTLCs are released from the holding cell and one is
6467 // valid but the other is no longer valid upon release, the valid HTLC can be
6468 // successfully completed while the other one fails as expected.
6469 #[test]
6470 fn test_free_and_fail_holding_cell_htlcs() {
6471         let chanmon_cfgs = create_chanmon_cfgs(2);
6472         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6473         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6474         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6475         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6476         let logger = test_utils::TestLogger::new();
6477
6478         // First nodes[0] generates an update_fee, setting the channel's
6479         // pending_update_fee.
6480         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6481         check_added_monitors!(nodes[0], 1);
6482
6483         let events = nodes[0].node.get_and_clear_pending_msg_events();
6484         assert_eq!(events.len(), 1);
6485         let (update_msg, commitment_signed) = match events[0] {
6486                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6487                         (update_fee.as_ref(), commitment_signed)
6488                 },
6489                 _ => panic!("Unexpected event"),
6490         };
6491
6492         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6493
6494         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6495         let channel_reserve = chan_stat.channel_reserve_msat;
6496         let feerate = get_feerate!(nodes[0], chan.2);
6497
6498         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6499         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6500         let amt_1 = 20000;
6501         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6502         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6503         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6504         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();
6505         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();
6506
6507         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6508         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6509         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6510         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6511         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6512         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6513         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6514
6515         // Flush the pending fee update.
6516         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6517         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6518         check_added_monitors!(nodes[1], 1);
6519         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6520         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6521         check_added_monitors!(nodes[0], 2);
6522
6523         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6524         // but now that the fee has been raised the second payment will now fail, causing us
6525         // to surface its failure to the user. The first payment should succeed.
6526         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6527         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6528         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6529         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6530         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6531
6532         // Check that the second payment failed to be sent out.
6533         let events = nodes[0].node.get_and_clear_pending_events();
6534         assert_eq!(events.len(), 1);
6535         match &events[0] {
6536                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6537                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6538                         assert_eq!(*rejected_by_dest, false);
6539                         assert_eq!(*error_code, None);
6540                         assert_eq!(*error_data, None);
6541                 },
6542                 _ => panic!("Unexpected event"),
6543         }
6544
6545         // Complete the first payment and the RAA from the fee update.
6546         let (payment_event, send_raa_event) = {
6547                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6548                 assert_eq!(msgs.len(), 2);
6549                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6550         };
6551         let raa = match send_raa_event {
6552                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6553                 _ => panic!("Unexpected event"),
6554         };
6555         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6556         check_added_monitors!(nodes[1], 1);
6557         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6558         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6559         let events = nodes[1].node.get_and_clear_pending_events();
6560         assert_eq!(events.len(), 1);
6561         match events[0] {
6562                 Event::PendingHTLCsForwardable { .. } => {},
6563                 _ => panic!("Unexpected event"),
6564         }
6565         nodes[1].node.process_pending_htlc_forwards();
6566         let events = nodes[1].node.get_and_clear_pending_events();
6567         assert_eq!(events.len(), 1);
6568         match events[0] {
6569                 Event::PaymentReceived { .. } => {},
6570                 _ => panic!("Unexpected event"),
6571         }
6572         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6573         check_added_monitors!(nodes[1], 1);
6574         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6575         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6576         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6577         let events = nodes[0].node.get_and_clear_pending_events();
6578         assert_eq!(events.len(), 1);
6579         match events[0] {
6580                 Event::PaymentSent { ref payment_preimage } => {
6581                         assert_eq!(*payment_preimage, payment_preimage_1);
6582                 }
6583                 _ => panic!("Unexpected event"),
6584         }
6585 }
6586
6587 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6588 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6589 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6590 // once it's freed.
6591 #[test]
6592 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6593         let chanmon_cfgs = create_chanmon_cfgs(3);
6594         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6595         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6596         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6597         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6598         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6599         let logger = test_utils::TestLogger::new();
6600
6601         // First nodes[1] generates an update_fee, setting the channel's
6602         // pending_update_fee.
6603         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6604         check_added_monitors!(nodes[1], 1);
6605
6606         let events = nodes[1].node.get_and_clear_pending_msg_events();
6607         assert_eq!(events.len(), 1);
6608         let (update_msg, commitment_signed) = match events[0] {
6609                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6610                         (update_fee.as_ref(), commitment_signed)
6611                 },
6612                 _ => panic!("Unexpected event"),
6613         };
6614
6615         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6616
6617         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6618         let channel_reserve = chan_stat.channel_reserve_msat;
6619         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6620
6621         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6622         let feemsat = 239;
6623         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6624         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6625         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6626         let payment_event = {
6627                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6628                 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();
6629                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6630                 check_added_monitors!(nodes[0], 1);
6631
6632                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6633                 assert_eq!(events.len(), 1);
6634
6635                 SendEvent::from_event(events.remove(0))
6636         };
6637         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6638         check_added_monitors!(nodes[1], 0);
6639         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6640         expect_pending_htlcs_forwardable!(nodes[1]);
6641
6642         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6643         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6644
6645         // Flush the pending fee update.
6646         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6647         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6648         check_added_monitors!(nodes[2], 1);
6649         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6650         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6651         check_added_monitors!(nodes[1], 2);
6652
6653         // A final RAA message is generated to finalize the fee update.
6654         let events = nodes[1].node.get_and_clear_pending_msg_events();
6655         assert_eq!(events.len(), 1);
6656
6657         let raa_msg = match &events[0] {
6658                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6659                         msg.clone()
6660                 },
6661                 _ => panic!("Unexpected event"),
6662         };
6663
6664         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6665         check_added_monitors!(nodes[2], 1);
6666         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6667
6668         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6669         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6670         assert_eq!(process_htlc_forwards_event.len(), 1);
6671         match &process_htlc_forwards_event[0] {
6672                 &Event::PendingHTLCsForwardable { .. } => {},
6673                 _ => panic!("Unexpected event"),
6674         }
6675
6676         // In response, we call ChannelManager's process_pending_htlc_forwards
6677         nodes[1].node.process_pending_htlc_forwards();
6678         check_added_monitors!(nodes[1], 1);
6679
6680         // This causes the HTLC to be failed backwards.
6681         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6682         assert_eq!(fail_event.len(), 1);
6683         let (fail_msg, commitment_signed) = match &fail_event[0] {
6684                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6685                         assert_eq!(updates.update_add_htlcs.len(), 0);
6686                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6687                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6688                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6689                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6690                 },
6691                 _ => panic!("Unexpected event"),
6692         };
6693
6694         // Pass the failure messages back to nodes[0].
6695         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6696         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6697
6698         // Complete the HTLC failure+removal process.
6699         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6700         check_added_monitors!(nodes[0], 1);
6701         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6702         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6703         check_added_monitors!(nodes[1], 2);
6704         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6705         assert_eq!(final_raa_event.len(), 1);
6706         let raa = match &final_raa_event[0] {
6707                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6708                 _ => panic!("Unexpected event"),
6709         };
6710         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6711         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6712         assert_eq!(fail_msg_event.len(), 1);
6713         match &fail_msg_event[0] {
6714                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6715                 _ => panic!("Unexpected event"),
6716         }
6717         let failure_event = nodes[0].node.get_and_clear_pending_events();
6718         assert_eq!(failure_event.len(), 1);
6719         match &failure_event[0] {
6720                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6721                         assert!(!rejected_by_dest);
6722                 },
6723                 _ => panic!("Unexpected event"),
6724         }
6725         check_added_monitors!(nodes[0], 1);
6726 }
6727
6728 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6729 // 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.
6730 //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.
6731
6732 #[test]
6733 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6734         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6735         let chanmon_cfgs = create_chanmon_cfgs(2);
6736         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6737         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6738         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6739         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6740
6741         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6742         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6743         let logger = test_utils::TestLogger::new();
6744         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();
6745         route.paths[0][0].fee_msat = 100;
6746
6747         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6748                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6749         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6750         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6751 }
6752
6753 #[test]
6754 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6755         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6756         let chanmon_cfgs = create_chanmon_cfgs(2);
6757         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6758         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6759         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6760         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6761         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6762
6763         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6764         let logger = test_utils::TestLogger::new();
6765         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();
6766         route.paths[0][0].fee_msat = 0;
6767         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6768                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6769
6770         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6771         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6772 }
6773
6774 #[test]
6775 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6776         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6777         let chanmon_cfgs = create_chanmon_cfgs(2);
6778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6780         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6781         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6782
6783         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6784         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6785         let logger = test_utils::TestLogger::new();
6786         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6787         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6788         check_added_monitors!(nodes[0], 1);
6789         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6790         updates.update_add_htlcs[0].amount_msat = 0;
6791
6792         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6793         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6794         check_closed_broadcast!(nodes[1], true).unwrap();
6795         check_added_monitors!(nodes[1], 1);
6796 }
6797
6798 #[test]
6799 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6800         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6801         //It is enforced when constructing a route.
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_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6807         let logger = test_utils::TestLogger::new();
6808
6809         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6810
6811         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6812         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001, &logger).unwrap();
6813         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6814                 assert_eq!(err, &"Channel CLTV overflowed?"));
6815 }
6816
6817 #[test]
6818 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6819         //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.
6820         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6821         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6822         let chanmon_cfgs = create_chanmon_cfgs(2);
6823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6825         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6826         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6827         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6828
6829         let logger = test_utils::TestLogger::new();
6830         for i in 0..max_accepted_htlcs {
6831                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6832                 let payment_event = {
6833                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6834                         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();
6835                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6836                         check_added_monitors!(nodes[0], 1);
6837
6838                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6839                         assert_eq!(events.len(), 1);
6840                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6841                                 assert_eq!(htlcs[0].htlc_id, i);
6842                         } else {
6843                                 assert!(false);
6844                         }
6845                         SendEvent::from_event(events.remove(0))
6846                 };
6847                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6848                 check_added_monitors!(nodes[1], 0);
6849                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6850
6851                 expect_pending_htlcs_forwardable!(nodes[1]);
6852                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6853         }
6854         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6855         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6856         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();
6857         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6858                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6859
6860         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6861         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6862 }
6863
6864 #[test]
6865 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6866         //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.
6867         let chanmon_cfgs = create_chanmon_cfgs(2);
6868         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6869         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6870         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6871         let channel_value = 100000;
6872         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6873         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6874
6875         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6876
6877         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6878         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6879         let logger = test_utils::TestLogger::new();
6880         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();
6881         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6882                 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)));
6883
6884         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6885         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);
6886
6887         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6888 }
6889
6890 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6891 #[test]
6892 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6893         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6894         let chanmon_cfgs = create_chanmon_cfgs(2);
6895         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6896         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6897         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6898         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6899         let htlc_minimum_msat: u64;
6900         {
6901                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6902                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6903                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6904         }
6905
6906         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6907         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6908         let logger = test_utils::TestLogger::new();
6909         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6910         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6911         check_added_monitors!(nodes[0], 1);
6912         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6913         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6914         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6915         assert!(nodes[1].node.list_channels().is_empty());
6916         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6917         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()));
6918         check_added_monitors!(nodes[1], 1);
6919 }
6920
6921 #[test]
6922 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6923         //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
6924         let chanmon_cfgs = create_chanmon_cfgs(2);
6925         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6926         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6927         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6928         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6929         let logger = test_utils::TestLogger::new();
6930
6931         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6932         let channel_reserve = chan_stat.channel_reserve_msat;
6933         let feerate = get_feerate!(nodes[0], chan.2);
6934         // The 2* and +1 are for the fee spike reserve.
6935         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6936
6937         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6938         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6939         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6940         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();
6941         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6942         check_added_monitors!(nodes[0], 1);
6943         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6944
6945         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6946         // at this time channel-initiatee receivers are not required to enforce that senders
6947         // respect the fee_spike_reserve.
6948         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6949         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6950
6951         assert!(nodes[1].node.list_channels().is_empty());
6952         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6953         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6954         check_added_monitors!(nodes[1], 1);
6955 }
6956
6957 #[test]
6958 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6959         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6960         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6961         let chanmon_cfgs = create_chanmon_cfgs(2);
6962         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6963         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6964         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6965         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6966         let logger = test_utils::TestLogger::new();
6967
6968         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6969         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6970
6971         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6972         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();
6973
6974         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6975         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6976         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6977         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6978
6979         let mut msg = msgs::UpdateAddHTLC {
6980                 channel_id: chan.2,
6981                 htlc_id: 0,
6982                 amount_msat: 1000,
6983                 payment_hash: our_payment_hash,
6984                 cltv_expiry: htlc_cltv,
6985                 onion_routing_packet: onion_packet.clone(),
6986         };
6987
6988         for i in 0..super::channel::OUR_MAX_HTLCS {
6989                 msg.htlc_id = i as u64;
6990                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6991         }
6992         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6993         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6994
6995         assert!(nodes[1].node.list_channels().is_empty());
6996         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6997         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6998         check_added_monitors!(nodes[1], 1);
6999 }
7000
7001 #[test]
7002 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
7003         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
7004         let chanmon_cfgs = create_chanmon_cfgs(2);
7005         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7006         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7007         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7008         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7009         let logger = test_utils::TestLogger::new();
7010
7011         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7012         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7013         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();
7014         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7015         check_added_monitors!(nodes[0], 1);
7016         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7017         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
7018         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7019
7020         assert!(nodes[1].node.list_channels().is_empty());
7021         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7022         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
7023         check_added_monitors!(nodes[1], 1);
7024 }
7025
7026 #[test]
7027 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
7028         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
7029         let chanmon_cfgs = create_chanmon_cfgs(2);
7030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7032         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7033         let logger = test_utils::TestLogger::new();
7034
7035         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
7036         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7037         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7038         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();
7039         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7040         check_added_monitors!(nodes[0], 1);
7041         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7042         updates.update_add_htlcs[0].cltv_expiry = 500000000;
7043         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7044
7045         assert!(nodes[1].node.list_channels().is_empty());
7046         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7047         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
7048         check_added_monitors!(nodes[1], 1);
7049 }
7050
7051 #[test]
7052 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
7053         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
7054         // We test this by first testing that that repeated HTLCs pass commitment signature checks
7055         // after disconnect and that non-sequential htlc_ids result in a channel failure.
7056         let chanmon_cfgs = create_chanmon_cfgs(2);
7057         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7058         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7059         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7060         let logger = test_utils::TestLogger::new();
7061
7062         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7063         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7064         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7065         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();
7066         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7067         check_added_monitors!(nodes[0], 1);
7068         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7069         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7070
7071         //Disconnect and Reconnect
7072         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7073         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7074         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7075         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7076         assert_eq!(reestablish_1.len(), 1);
7077         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7078         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7079         assert_eq!(reestablish_2.len(), 1);
7080         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7081         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7082         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7083         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7084
7085         //Resend HTLC
7086         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7087         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
7088         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
7089         check_added_monitors!(nodes[1], 1);
7090         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7091
7092         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7093
7094         assert!(nodes[1].node.list_channels().is_empty());
7095         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7096         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
7097         check_added_monitors!(nodes[1], 1);
7098 }
7099
7100 #[test]
7101 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
7102         //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.
7103
7104         let chanmon_cfgs = create_chanmon_cfgs(2);
7105         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7106         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7107         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7108         let logger = test_utils::TestLogger::new();
7109         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7110         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7111         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7112         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();
7113         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7114
7115         check_added_monitors!(nodes[0], 1);
7116         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7117         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7118
7119         let update_msg = msgs::UpdateFulfillHTLC{
7120                 channel_id: chan.2,
7121                 htlc_id: 0,
7122                 payment_preimage: our_payment_preimage,
7123         };
7124
7125         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7126
7127         assert!(nodes[0].node.list_channels().is_empty());
7128         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7129         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()));
7130         check_added_monitors!(nodes[0], 1);
7131 }
7132
7133 #[test]
7134 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
7135         //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.
7136
7137         let chanmon_cfgs = create_chanmon_cfgs(2);
7138         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7139         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7140         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7141         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7142         let logger = test_utils::TestLogger::new();
7143
7144         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7145         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7146         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();
7147         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7148         check_added_monitors!(nodes[0], 1);
7149         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7150         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7151
7152         let update_msg = msgs::UpdateFailHTLC{
7153                 channel_id: chan.2,
7154                 htlc_id: 0,
7155                 reason: msgs::OnionErrorPacket { data: Vec::new()},
7156         };
7157
7158         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7159
7160         assert!(nodes[0].node.list_channels().is_empty());
7161         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7162         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()));
7163         check_added_monitors!(nodes[0], 1);
7164 }
7165
7166 #[test]
7167 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7168         //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.
7169
7170         let chanmon_cfgs = create_chanmon_cfgs(2);
7171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7173         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7174         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7175         let logger = test_utils::TestLogger::new();
7176
7177         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7178         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7179         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();
7180         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7181         check_added_monitors!(nodes[0], 1);
7182         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7183         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7184
7185         let update_msg = msgs::UpdateFailMalformedHTLC{
7186                 channel_id: chan.2,
7187                 htlc_id: 0,
7188                 sha256_of_onion: [1; 32],
7189                 failure_code: 0x8000,
7190         };
7191
7192         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7193
7194         assert!(nodes[0].node.list_channels().is_empty());
7195         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7196         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()));
7197         check_added_monitors!(nodes[0], 1);
7198 }
7199
7200 #[test]
7201 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7202         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7203
7204         let chanmon_cfgs = create_chanmon_cfgs(2);
7205         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7206         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7207         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7208         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7209
7210         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7211
7212         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7213         check_added_monitors!(nodes[1], 1);
7214
7215         let events = nodes[1].node.get_and_clear_pending_msg_events();
7216         assert_eq!(events.len(), 1);
7217         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7218                 match events[0] {
7219                         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, .. } } => {
7220                                 assert!(update_add_htlcs.is_empty());
7221                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7222                                 assert!(update_fail_htlcs.is_empty());
7223                                 assert!(update_fail_malformed_htlcs.is_empty());
7224                                 assert!(update_fee.is_none());
7225                                 update_fulfill_htlcs[0].clone()
7226                         },
7227                         _ => panic!("Unexpected event"),
7228                 }
7229         };
7230
7231         update_fulfill_msg.htlc_id = 1;
7232
7233         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7234
7235         assert!(nodes[0].node.list_channels().is_empty());
7236         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7237         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7238         check_added_monitors!(nodes[0], 1);
7239 }
7240
7241 #[test]
7242 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7243         //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.
7244
7245         let chanmon_cfgs = create_chanmon_cfgs(2);
7246         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7247         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7248         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7249         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7250
7251         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7252
7253         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7254         check_added_monitors!(nodes[1], 1);
7255
7256         let events = nodes[1].node.get_and_clear_pending_msg_events();
7257         assert_eq!(events.len(), 1);
7258         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7259                 match events[0] {
7260                         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, .. } } => {
7261                                 assert!(update_add_htlcs.is_empty());
7262                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7263                                 assert!(update_fail_htlcs.is_empty());
7264                                 assert!(update_fail_malformed_htlcs.is_empty());
7265                                 assert!(update_fee.is_none());
7266                                 update_fulfill_htlcs[0].clone()
7267                         },
7268                         _ => panic!("Unexpected event"),
7269                 }
7270         };
7271
7272         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7273
7274         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7275
7276         assert!(nodes[0].node.list_channels().is_empty());
7277         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7278         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7279         check_added_monitors!(nodes[0], 1);
7280 }
7281
7282 #[test]
7283 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7284         //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.
7285
7286         let chanmon_cfgs = create_chanmon_cfgs(2);
7287         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7288         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7289         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7290         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7291         let logger = test_utils::TestLogger::new();
7292
7293         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7294         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7295         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();
7296         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7297         check_added_monitors!(nodes[0], 1);
7298
7299         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7300         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7301
7302         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7303         check_added_monitors!(nodes[1], 0);
7304         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7305
7306         let events = nodes[1].node.get_and_clear_pending_msg_events();
7307
7308         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7309                 match events[0] {
7310                         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, .. } } => {
7311                                 assert!(update_add_htlcs.is_empty());
7312                                 assert!(update_fulfill_htlcs.is_empty());
7313                                 assert!(update_fail_htlcs.is_empty());
7314                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7315                                 assert!(update_fee.is_none());
7316                                 update_fail_malformed_htlcs[0].clone()
7317                         },
7318                         _ => panic!("Unexpected event"),
7319                 }
7320         };
7321         update_msg.failure_code &= !0x8000;
7322         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7323
7324         assert!(nodes[0].node.list_channels().is_empty());
7325         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7326         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7327         check_added_monitors!(nodes[0], 1);
7328 }
7329
7330 #[test]
7331 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7332         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7333         //    * 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.
7334
7335         let chanmon_cfgs = create_chanmon_cfgs(3);
7336         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7337         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7338         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7339         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7340         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7341         let logger = test_utils::TestLogger::new();
7342
7343         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7344
7345         //First hop
7346         let mut payment_event = {
7347                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7348                 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();
7349                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7350                 check_added_monitors!(nodes[0], 1);
7351                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7352                 assert_eq!(events.len(), 1);
7353                 SendEvent::from_event(events.remove(0))
7354         };
7355         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7356         check_added_monitors!(nodes[1], 0);
7357         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7358         expect_pending_htlcs_forwardable!(nodes[1]);
7359         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7360         assert_eq!(events_2.len(), 1);
7361         check_added_monitors!(nodes[1], 1);
7362         payment_event = SendEvent::from_event(events_2.remove(0));
7363         assert_eq!(payment_event.msgs.len(), 1);
7364
7365         //Second Hop
7366         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7367         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7368         check_added_monitors!(nodes[2], 0);
7369         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7370
7371         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7372         assert_eq!(events_3.len(), 1);
7373         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7374                 match events_3[0] {
7375                         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 } } => {
7376                                 assert!(update_add_htlcs.is_empty());
7377                                 assert!(update_fulfill_htlcs.is_empty());
7378                                 assert!(update_fail_htlcs.is_empty());
7379                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7380                                 assert!(update_fee.is_none());
7381                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7382                         },
7383                         _ => panic!("Unexpected event"),
7384                 }
7385         };
7386
7387         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7388
7389         check_added_monitors!(nodes[1], 0);
7390         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7391         expect_pending_htlcs_forwardable!(nodes[1]);
7392         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7393         assert_eq!(events_4.len(), 1);
7394
7395         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7396         match events_4[0] {
7397                 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, .. } } => {
7398                         assert!(update_add_htlcs.is_empty());
7399                         assert!(update_fulfill_htlcs.is_empty());
7400                         assert_eq!(update_fail_htlcs.len(), 1);
7401                         assert!(update_fail_malformed_htlcs.is_empty());
7402                         assert!(update_fee.is_none());
7403                 },
7404                 _ => panic!("Unexpected event"),
7405         };
7406
7407         check_added_monitors!(nodes[1], 1);
7408 }
7409
7410 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7411         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7412         // 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
7413         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7414
7415         let chanmon_cfgs = create_chanmon_cfgs(2);
7416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7419         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7420
7421         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7422
7423         // We route 2 dust-HTLCs between A and B
7424         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7425         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7426         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7427
7428         // Cache one local commitment tx as previous
7429         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7430
7431         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7432         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7433         check_added_monitors!(nodes[1], 0);
7434         expect_pending_htlcs_forwardable!(nodes[1]);
7435         check_added_monitors!(nodes[1], 1);
7436
7437         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7438         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7439         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7440         check_added_monitors!(nodes[0], 1);
7441
7442         // Cache one local commitment tx as lastest
7443         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7444
7445         let events = nodes[0].node.get_and_clear_pending_msg_events();
7446         match events[0] {
7447                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7448                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7449                 },
7450                 _ => panic!("Unexpected event"),
7451         }
7452         match events[1] {
7453                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7454                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7455                 },
7456                 _ => panic!("Unexpected event"),
7457         }
7458
7459         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7460         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7461         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7462
7463         if announce_latest {
7464                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7465         } else {
7466                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7467         }
7468
7469         check_closed_broadcast!(nodes[0], false);
7470         check_added_monitors!(nodes[0], 1);
7471
7472         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7473         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
7474         let events = nodes[0].node.get_and_clear_pending_events();
7475         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7476         assert_eq!(events.len(), 2);
7477         let mut first_failed = false;
7478         for event in events {
7479                 match event {
7480                         Event::PaymentFailed { payment_hash, .. } => {
7481                                 if payment_hash == payment_hash_1 {
7482                                         assert!(!first_failed);
7483                                         first_failed = true;
7484                                 } else {
7485                                         assert_eq!(payment_hash, payment_hash_2);
7486                                 }
7487                         }
7488                         _ => panic!("Unexpected event"),
7489                 }
7490         }
7491 }
7492
7493 #[test]
7494 fn test_failure_delay_dust_htlc_local_commitment() {
7495         do_test_failure_delay_dust_htlc_local_commitment(true);
7496         do_test_failure_delay_dust_htlc_local_commitment(false);
7497 }
7498
7499 #[test]
7500 fn test_no_failure_dust_htlc_local_commitment() {
7501         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7502         // prone to error, we test here that a dummy transaction don't fail them.
7503
7504         let chanmon_cfgs = create_chanmon_cfgs(2);
7505         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7506         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7507         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7508         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7509
7510         // Rebalance a bit
7511         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7512
7513         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7514         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7515
7516         // We route 2 dust-HTLCs between A and B
7517         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7518         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7519
7520         // Build a dummy invalid transaction trying to spend a commitment tx
7521         let input = TxIn {
7522                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7523                 script_sig: Script::new(),
7524                 sequence: 0,
7525                 witness: Vec::new(),
7526         };
7527
7528         let outp = TxOut {
7529                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7530                 value: 10000,
7531         };
7532
7533         let dummy_tx = Transaction {
7534                 version: 2,
7535                 lock_time: 0,
7536                 input: vec![input],
7537                 output: vec![outp]
7538         };
7539
7540         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7541         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
7542         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7543         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7544         // We broadcast a few more block to check everything is all right
7545         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
7546         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7547         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7548
7549         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7550         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7551 }
7552
7553 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7554         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7555         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7556         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7557         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7558         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7559         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7560
7561         let chanmon_cfgs = create_chanmon_cfgs(3);
7562         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7563         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7564         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7565         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7566
7567         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7568
7569         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7570         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7571
7572         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7573         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7574
7575         // We revoked bs_commitment_tx
7576         if revoked {
7577                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7578                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7579         }
7580
7581         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7582         let mut timeout_tx = Vec::new();
7583         if local {
7584                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7585                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7586                 check_closed_broadcast!(nodes[0], false);
7587                 check_added_monitors!(nodes[0], 1);
7588                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7589                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7590                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7591                 expect_payment_failed!(nodes[0], dust_hash, true);
7592                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7593                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7594                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7595                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7596                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7597                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7598                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7599                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7600         } else {
7601                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7602                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7603                 check_closed_broadcast!(nodes[0], false);
7604                 check_added_monitors!(nodes[0], 1);
7605                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7606                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7607                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7608                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7609                 if !revoked {
7610                         expect_payment_failed!(nodes[0], dust_hash, true);
7611                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7612                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7613                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7614                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7615                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7616                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7617                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7618                 } else {
7619                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7620                         // commitment tx
7621                         let events = nodes[0].node.get_and_clear_pending_events();
7622                         assert_eq!(events.len(), 2);
7623                         let first;
7624                         match events[0] {
7625                                 Event::PaymentFailed { payment_hash, .. } => {
7626                                         if payment_hash == dust_hash { first = true; }
7627                                         else { first = false; }
7628                                 },
7629                                 _ => panic!("Unexpected event"),
7630                         }
7631                         match events[1] {
7632                                 Event::PaymentFailed { payment_hash, .. } => {
7633                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7634                                         else { assert_eq!(payment_hash, dust_hash); }
7635                                 },
7636                                 _ => panic!("Unexpected event"),
7637                         }
7638                 }
7639         }
7640 }
7641
7642 #[test]
7643 fn test_sweep_outbound_htlc_failure_update() {
7644         do_test_sweep_outbound_htlc_failure_update(false, true);
7645         do_test_sweep_outbound_htlc_failure_update(false, false);
7646         do_test_sweep_outbound_htlc_failure_update(true, false);
7647 }
7648
7649 #[test]
7650 fn test_upfront_shutdown_script() {
7651         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7652         // enforce it at shutdown message
7653
7654         let mut config = UserConfig::default();
7655         config.channel_options.announced_channel = true;
7656         config.peer_channel_config_limits.force_announced_channel_preference = false;
7657         config.channel_options.commit_upfront_shutdown_pubkey = false;
7658         let user_cfgs = [None, Some(config), None];
7659         let chanmon_cfgs = create_chanmon_cfgs(3);
7660         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7661         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7662         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7663
7664         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7665         let flags = InitFeatures::known();
7666         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7667         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7668         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7669         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7670         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7671         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7672     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()));
7673         check_added_monitors!(nodes[2], 1);
7674
7675         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7676         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7677         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7678         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7679         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7680         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7681         let events = nodes[2].node.get_and_clear_pending_msg_events();
7682         assert_eq!(events.len(), 1);
7683         match events[0] {
7684                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7685                 _ => panic!("Unexpected event"),
7686         }
7687
7688         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7689         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7690         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7691         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7692         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7693         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7694         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7695         let events = nodes[1].node.get_and_clear_pending_msg_events();
7696         assert_eq!(events.len(), 1);
7697         match events[0] {
7698                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7699                 _ => panic!("Unexpected event"),
7700         }
7701
7702         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7703         // channel smoothly, opt-out is from channel initiator here
7704         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7705         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7706         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7707         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7708         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7709         let events = nodes[0].node.get_and_clear_pending_msg_events();
7710         assert_eq!(events.len(), 1);
7711         match events[0] {
7712                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7713                 _ => panic!("Unexpected event"),
7714         }
7715
7716         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7717         //// channel smoothly
7718         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7719         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7720         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7721         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7722         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7723         let events = nodes[0].node.get_and_clear_pending_msg_events();
7724         assert_eq!(events.len(), 2);
7725         match events[0] {
7726                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7727                 _ => panic!("Unexpected event"),
7728         }
7729         match events[1] {
7730                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7731                 _ => panic!("Unexpected event"),
7732         }
7733 }
7734
7735 #[test]
7736 fn test_user_configurable_csv_delay() {
7737         // We test our channel constructors yield errors when we pass them absurd csv delay
7738
7739         let mut low_our_to_self_config = UserConfig::default();
7740         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7741         let mut high_their_to_self_config = UserConfig::default();
7742         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7743         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7744         let chanmon_cfgs = create_chanmon_cfgs(2);
7745         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7746         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7747         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7748
7749         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7750         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7751         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) {
7752                 match error {
7753                         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())); },
7754                         _ => panic!("Unexpected event"),
7755                 }
7756         } else { assert!(false) }
7757
7758         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7759         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7760         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7761         open_channel.to_self_delay = 200;
7762         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) {
7763                 match error {
7764                         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()));  },
7765                         _ => panic!("Unexpected event"),
7766                 }
7767         } else { assert!(false); }
7768
7769         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7770         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7771         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()));
7772         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7773         accept_channel.to_self_delay = 200;
7774         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7775         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7776                 match action {
7777                         &ErrorAction::SendErrorMessage { ref msg } => {
7778                                 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()));
7779                         },
7780                         _ => { assert!(false); }
7781                 }
7782         } else { assert!(false); }
7783
7784         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7785         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7786         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7787         open_channel.to_self_delay = 200;
7788         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) {
7789                 match error {
7790                         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())); },
7791                         _ => panic!("Unexpected event"),
7792                 }
7793         } else { assert!(false); }
7794 }
7795
7796 #[test]
7797 fn test_data_loss_protect() {
7798         // We want to be sure that :
7799         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7800         // * we close channel in case of detecting other being fallen behind
7801         // * we are able to claim our own outputs thanks to to_remote being static
7802         let keys_manager;
7803         let logger;
7804         let fee_estimator;
7805         let tx_broadcaster;
7806         let chain_monitor;
7807         let monitor;
7808         let node_state_0;
7809         let chanmon_cfgs = create_chanmon_cfgs(2);
7810         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7811         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7812         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7813
7814         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7815
7816         // Cache node A state before any channel update
7817         let previous_node_state = nodes[0].node.encode();
7818         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7819         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7820
7821         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7822         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7823
7824         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7825         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7826
7827         // Restore node A from previous state
7828         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7829         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7830         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7831         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7832         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7833         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7834         monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7835         node_state_0 = {
7836                 let mut channel_monitors = HashMap::new();
7837                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7838                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7839                         keys_manager: &keys_manager,
7840                         fee_estimator: &fee_estimator,
7841                         monitor: &monitor,
7842                         logger: &logger,
7843                         tx_broadcaster: &tx_broadcaster,
7844                         default_config: UserConfig::default(),
7845                         channel_monitors: &mut channel_monitors,
7846                 }).unwrap().1
7847         };
7848         nodes[0].node = &node_state_0;
7849         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7850         nodes[0].chan_monitor = &monitor;
7851         nodes[0].chain_monitor = &chain_monitor;
7852
7853         nodes[0].block_notifier = BlockNotifier::new(&nodes[0].chain_monitor);
7854         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7855         nodes[0].block_notifier.register_listener(nodes[0].node);
7856
7857         check_added_monitors!(nodes[0], 1);
7858
7859         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7860         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7861
7862         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7863
7864         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7865         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7866         check_added_monitors!(nodes[0], 1);
7867
7868         {
7869                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7870                 assert_eq!(node_txn.len(), 0);
7871         }
7872
7873         let mut reestablish_1 = Vec::with_capacity(1);
7874         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7875                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7876                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7877                         reestablish_1.push(msg.clone());
7878                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7879                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7880                         match action {
7881                                 &ErrorAction::SendErrorMessage { ref msg } => {
7882                                         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");
7883                                 },
7884                                 _ => panic!("Unexpected event!"),
7885                         }
7886                 } else {
7887                         panic!("Unexpected event")
7888                 }
7889         }
7890
7891         // Check we close channel detecting A is fallen-behind
7892         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7893         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7894         check_added_monitors!(nodes[1], 1);
7895
7896
7897         // Check A is able to claim to_remote output
7898         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7899         assert_eq!(node_txn.len(), 1);
7900         check_spends!(node_txn[0], chan.3);
7901         assert_eq!(node_txn[0].output.len(), 2);
7902         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7903         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7904         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7905         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7906         assert_eq!(spend_txn.len(), 1);
7907         check_spends!(spend_txn[0], node_txn[0]);
7908 }
7909
7910 #[test]
7911 fn test_check_htlc_underpaying() {
7912         // Send payment through A -> B but A is maliciously
7913         // sending a probe payment (i.e less than expected value0
7914         // to B, B should refuse payment.
7915
7916         let chanmon_cfgs = create_chanmon_cfgs(2);
7917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7919         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7920
7921         // Create some initial channels
7922         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7923
7924         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7925
7926         // Node 3 is expecting payment of 100_000 but receive 10_000,
7927         // fail htlc like we didn't know the preimage.
7928         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7929         nodes[1].node.process_pending_htlc_forwards();
7930
7931         let events = nodes[1].node.get_and_clear_pending_msg_events();
7932         assert_eq!(events.len(), 1);
7933         let (update_fail_htlc, commitment_signed) = match events[0] {
7934                 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 } } => {
7935                         assert!(update_add_htlcs.is_empty());
7936                         assert!(update_fulfill_htlcs.is_empty());
7937                         assert_eq!(update_fail_htlcs.len(), 1);
7938                         assert!(update_fail_malformed_htlcs.is_empty());
7939                         assert!(update_fee.is_none());
7940                         (update_fail_htlcs[0].clone(), commitment_signed)
7941                 },
7942                 _ => panic!("Unexpected event"),
7943         };
7944         check_added_monitors!(nodes[1], 1);
7945
7946         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7947         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7948
7949         // 10_000 msat as u64, followed by a height of 99 as u32
7950         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7951         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7952         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7953         nodes[1].node.get_and_clear_pending_events();
7954 }
7955
7956 #[test]
7957 fn test_announce_disable_channels() {
7958         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7959         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7960
7961         let chanmon_cfgs = create_chanmon_cfgs(2);
7962         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7963         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7964         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7965
7966         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7967         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7968         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7969
7970         // Disconnect peers
7971         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7972         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7973
7974         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7975         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7976         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7977         assert_eq!(msg_events.len(), 3);
7978         for e in msg_events {
7979                 match e {
7980                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7981                                 let short_id = msg.contents.short_channel_id;
7982                                 // Check generated channel_update match list in PendingChannelUpdate
7983                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7984                                         panic!("Generated ChannelUpdate for wrong chan!");
7985                                 }
7986                         },
7987                         _ => panic!("Unexpected event"),
7988                 }
7989         }
7990         // Reconnect peers
7991         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7992         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7993         assert_eq!(reestablish_1.len(), 3);
7994         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7995         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7996         assert_eq!(reestablish_2.len(), 3);
7997
7998         // Reestablish chan_1
7999         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
8000         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8001         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
8002         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8003         // Reestablish chan_2
8004         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
8005         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8006         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
8007         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8008         // Reestablish chan_3
8009         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
8010         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8011         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
8012         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8013
8014         nodes[0].node.timer_chan_freshness_every_min();
8015         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8016 }
8017
8018 #[test]
8019 fn test_bump_penalty_txn_on_revoked_commitment() {
8020         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8021         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8022
8023         let chanmon_cfgs = create_chanmon_cfgs(2);
8024         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8026         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8027
8028         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8029         let logger = test_utils::TestLogger::new();
8030
8031
8032         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8033         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8034         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();
8035         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8036
8037         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8038         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8039         assert_eq!(revoked_txn[0].output.len(), 4);
8040         assert_eq!(revoked_txn[0].input.len(), 1);
8041         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8042         let revoked_txid = revoked_txn[0].txid();
8043
8044         let mut penalty_sum = 0;
8045         for outp in revoked_txn[0].output.iter() {
8046                 if outp.script_pubkey.is_v0_p2wsh() {
8047                         penalty_sum += outp.value;
8048                 }
8049         }
8050
8051         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8052         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
8053
8054         // Actually revoke tx by claiming a HTLC
8055         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8056         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8057         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
8058         check_added_monitors!(nodes[1], 1);
8059
8060         // One or more justice tx should have been broadcast, check it
8061         let penalty_1;
8062         let feerate_1;
8063         {
8064                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8065                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
8066                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8067                 assert_eq!(node_txn[0].output.len(), 1);
8068                 check_spends!(node_txn[0], revoked_txn[0]);
8069                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8070                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8071                 penalty_1 = node_txn[0].txid();
8072                 node_txn.clear();
8073         };
8074
8075         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8076         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
8077         let mut penalty_2 = penalty_1;
8078         let mut feerate_2 = 0;
8079         {
8080                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8081                 assert_eq!(node_txn.len(), 1);
8082                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8083                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8084                         assert_eq!(node_txn[0].output.len(), 1);
8085                         check_spends!(node_txn[0], revoked_txn[0]);
8086                         penalty_2 = node_txn[0].txid();
8087                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8088                         assert_ne!(penalty_2, penalty_1);
8089                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8090                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8091                         // Verify 25% bump heuristic
8092                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8093                         node_txn.clear();
8094                 }
8095         }
8096         assert_ne!(feerate_2, 0);
8097
8098         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8099         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
8100         let penalty_3;
8101         let mut feerate_3 = 0;
8102         {
8103                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8104                 assert_eq!(node_txn.len(), 1);
8105                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8106                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8107                         assert_eq!(node_txn[0].output.len(), 1);
8108                         check_spends!(node_txn[0], revoked_txn[0]);
8109                         penalty_3 = node_txn[0].txid();
8110                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8111                         assert_ne!(penalty_3, penalty_2);
8112                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8113                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8114                         // Verify 25% bump heuristic
8115                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8116                         node_txn.clear();
8117                 }
8118         }
8119         assert_ne!(feerate_3, 0);
8120
8121         nodes[1].node.get_and_clear_pending_events();
8122         nodes[1].node.get_and_clear_pending_msg_events();
8123 }
8124
8125 #[test]
8126 fn test_bump_penalty_txn_on_revoked_htlcs() {
8127         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8128         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8129
8130         let chanmon_cfgs = create_chanmon_cfgs(2);
8131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8133         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8134
8135         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8136         // Lock HTLC in both directions
8137         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
8138         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8139
8140         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8141         assert_eq!(revoked_local_txn[0].input.len(), 1);
8142         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8143
8144         // Revoke local commitment tx
8145         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8146
8147         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8148         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8149         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8150         check_closed_broadcast!(nodes[1], false);
8151         check_added_monitors!(nodes[1], 1);
8152
8153         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8154         assert_eq!(revoked_htlc_txn.len(), 4);
8155         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8156                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8157                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8158                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8159                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8160                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8161         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8162                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8163                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8164                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8165                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8166                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8167         }
8168
8169         // Broadcast set of revoked txn on A
8170         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
8171         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8172
8173         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8174         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
8175         let first;
8176         let feerate_1;
8177         let penalty_txn;
8178         {
8179                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8180                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8181                 // Verify claim tx are spending revoked HTLC txn
8182                 assert_eq!(node_txn[4].input.len(), 2);
8183                 assert_eq!(node_txn[4].output.len(), 1);
8184                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8185                 first = node_txn[4].txid();
8186                 // Store both feerates for later comparison
8187                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8188                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8189                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8190                 node_txn.clear();
8191         }
8192
8193         // Connect three more block to see if bumped penalty are issued for HTLC txn
8194         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8195         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8196         {
8197                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8198                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8199
8200                 check_spends!(node_txn[0], revoked_local_txn[0]);
8201                 check_spends!(node_txn[1], revoked_local_txn[0]);
8202
8203                 node_txn.clear();
8204         };
8205
8206         // Few more blocks to confirm penalty txn
8207         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
8208         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8209         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
8210         let node_txn = {
8211                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8212                 assert_eq!(node_txn.len(), 1);
8213
8214                 assert_eq!(node_txn[0].input.len(), 2);
8215                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8216                 // Verify bumped tx is different and 25% bump heuristic
8217                 assert_ne!(first, node_txn[0].txid());
8218                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8219                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8220                 assert!(feerate_2 * 100 > feerate_1 * 125);
8221                 let txn = vec![node_txn[0].clone()];
8222                 node_txn.clear();
8223                 txn
8224         };
8225         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8226         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8227         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
8228         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
8229         {
8230                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8231                 // We verify than no new transaction has been broadcast because previously
8232                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8233                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8234                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8235                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8236                 // up bumped justice generation.
8237                 assert_eq!(node_txn.len(), 0);
8238                 node_txn.clear();
8239         }
8240         check_closed_broadcast!(nodes[0], false);
8241         check_added_monitors!(nodes[0], 1);
8242 }
8243
8244 #[test]
8245 fn test_bump_penalty_txn_on_remote_commitment() {
8246         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8247         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8248
8249         // Create 2 HTLCs
8250         // Provide preimage for one
8251         // Check aggregation
8252
8253         let chanmon_cfgs = create_chanmon_cfgs(2);
8254         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8255         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8256         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8257
8258         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8259         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8260         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8261
8262         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8263         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8264         assert_eq!(remote_txn[0].output.len(), 4);
8265         assert_eq!(remote_txn[0].input.len(), 1);
8266         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8267
8268         // Claim a HTLC without revocation (provide B monitor with preimage)
8269         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
8270         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8271         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
8272         check_added_monitors!(nodes[1], 2);
8273
8274         // One or more claim tx should have been broadcast, check it
8275         let timeout;
8276         let preimage;
8277         let feerate_timeout;
8278         let feerate_preimage;
8279         {
8280                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8281                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8282                 assert_eq!(node_txn[0].input.len(), 1);
8283                 assert_eq!(node_txn[1].input.len(), 1);
8284                 check_spends!(node_txn[0], remote_txn[0]);
8285                 check_spends!(node_txn[1], remote_txn[0]);
8286                 check_spends!(node_txn[2], chan.3);
8287                 check_spends!(node_txn[3], node_txn[2]);
8288                 check_spends!(node_txn[4], node_txn[2]);
8289                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8290                         timeout = node_txn[0].txid();
8291                         let index = node_txn[0].input[0].previous_output.vout;
8292                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8293                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8294
8295                         preimage = node_txn[1].txid();
8296                         let index = node_txn[1].input[0].previous_output.vout;
8297                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8298                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8299                 } else {
8300                         timeout = node_txn[1].txid();
8301                         let index = node_txn[1].input[0].previous_output.vout;
8302                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8303                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8304
8305                         preimage = node_txn[0].txid();
8306                         let index = node_txn[0].input[0].previous_output.vout;
8307                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8308                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8309                 }
8310                 node_txn.clear();
8311         };
8312         assert_ne!(feerate_timeout, 0);
8313         assert_ne!(feerate_preimage, 0);
8314
8315         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8316         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
8317         {
8318                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8319                 assert_eq!(node_txn.len(), 2);
8320                 assert_eq!(node_txn[0].input.len(), 1);
8321                 assert_eq!(node_txn[1].input.len(), 1);
8322                 check_spends!(node_txn[0], remote_txn[0]);
8323                 check_spends!(node_txn[1], remote_txn[0]);
8324                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8325                         let index = node_txn[0].input[0].previous_output.vout;
8326                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8327                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8328                         assert!(new_feerate * 100 > feerate_timeout * 125);
8329                         assert_ne!(timeout, node_txn[0].txid());
8330
8331                         let index = node_txn[1].input[0].previous_output.vout;
8332                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8333                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8334                         assert!(new_feerate * 100 > feerate_preimage * 125);
8335                         assert_ne!(preimage, node_txn[1].txid());
8336                 } else {
8337                         let index = node_txn[1].input[0].previous_output.vout;
8338                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8339                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8340                         assert!(new_feerate * 100 > feerate_timeout * 125);
8341                         assert_ne!(timeout, node_txn[1].txid());
8342
8343                         let index = node_txn[0].input[0].previous_output.vout;
8344                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8345                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8346                         assert!(new_feerate * 100 > feerate_preimage * 125);
8347                         assert_ne!(preimage, node_txn[0].txid());
8348                 }
8349                 node_txn.clear();
8350         }
8351
8352         nodes[1].node.get_and_clear_pending_events();
8353         nodes[1].node.get_and_clear_pending_msg_events();
8354 }
8355
8356 #[test]
8357 fn test_set_outpoints_partial_claiming() {
8358         // - remote party claim tx, new bump tx
8359         // - disconnect remote claiming tx, new bump
8360         // - disconnect tx, see no tx anymore
8361         let chanmon_cfgs = create_chanmon_cfgs(2);
8362         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8363         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8364         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8365
8366         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8367         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8368         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8369
8370         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8371         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8372         assert_eq!(remote_txn.len(), 3);
8373         assert_eq!(remote_txn[0].output.len(), 4);
8374         assert_eq!(remote_txn[0].input.len(), 1);
8375         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8376         check_spends!(remote_txn[1], remote_txn[0]);
8377         check_spends!(remote_txn[2], remote_txn[0]);
8378
8379         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8380         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
8381         // Provide node A with both preimage
8382         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8383         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8384         check_added_monitors!(nodes[0], 2);
8385         nodes[0].node.get_and_clear_pending_events();
8386         nodes[0].node.get_and_clear_pending_msg_events();
8387
8388         // Connect blocks on node A commitment transaction
8389         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8390         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8391         check_closed_broadcast!(nodes[0], false);
8392         check_added_monitors!(nodes[0], 1);
8393         // Verify node A broadcast tx claiming both HTLCs
8394         {
8395                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8396                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8397                 assert_eq!(node_txn.len(), 4);
8398                 check_spends!(node_txn[0], remote_txn[0]);
8399                 check_spends!(node_txn[1], chan.3);
8400                 check_spends!(node_txn[2], node_txn[1]);
8401                 check_spends!(node_txn[3], node_txn[1]);
8402                 assert_eq!(node_txn[0].input.len(), 2);
8403                 node_txn.clear();
8404         }
8405
8406         // Connect blocks on node B
8407         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
8408         check_closed_broadcast!(nodes[1], false);
8409         check_added_monitors!(nodes[1], 1);
8410         // Verify node B broadcast 2 HTLC-timeout txn
8411         let partial_claim_tx = {
8412                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8413                 assert_eq!(node_txn.len(), 3);
8414                 check_spends!(node_txn[1], node_txn[0]);
8415                 check_spends!(node_txn[2], node_txn[0]);
8416                 assert_eq!(node_txn[1].input.len(), 1);
8417                 assert_eq!(node_txn[2].input.len(), 1);
8418                 node_txn[1].clone()
8419         };
8420
8421         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8422         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8423         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8424         {
8425                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8426                 assert_eq!(node_txn.len(), 1);
8427                 check_spends!(node_txn[0], remote_txn[0]);
8428                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8429                 node_txn.clear();
8430         }
8431         nodes[0].node.get_and_clear_pending_msg_events();
8432
8433         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8434         nodes[0].block_notifier.block_disconnected(&header, 102);
8435         {
8436                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8437                 assert_eq!(node_txn.len(), 1);
8438                 check_spends!(node_txn[0], remote_txn[0]);
8439                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8440                 node_txn.clear();
8441         }
8442
8443         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8444         nodes[0].block_notifier.block_disconnected(&header, 101);
8445         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
8446         {
8447                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8448                 assert_eq!(node_txn.len(), 0);
8449                 node_txn.clear();
8450         }
8451 }
8452
8453 #[test]
8454 fn test_counterparty_raa_skip_no_crash() {
8455         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8456         // commitment transaction, we would have happily carried on and provided them the next
8457         // commitment transaction based on one RAA forward. This would probably eventually have led to
8458         // channel closure, but it would not have resulted in funds loss. Still, our
8459         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8460         // check simply that the channel is closed in response to such an RAA, but don't check whether
8461         // we decide to punish our counterparty for revoking their funds (as we don't currently
8462         // implement that).
8463         let chanmon_cfgs = create_chanmon_cfgs(2);
8464         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8465         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8466         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8467         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8468
8469         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8470         let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8471         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8472         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8473                 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8474         let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8475
8476         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8477                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8478         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8479         check_added_monitors!(nodes[1], 1);
8480 }
8481
8482 #[test]
8483 fn test_bump_txn_sanitize_tracking_maps() {
8484         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8485         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8486
8487         let chanmon_cfgs = create_chanmon_cfgs(2);
8488         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8489         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8490         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8491
8492         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8493         // Lock HTLC in both directions
8494         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8495         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8496
8497         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8498         assert_eq!(revoked_local_txn[0].input.len(), 1);
8499         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8500
8501         // Revoke local commitment tx
8502         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8503
8504         // Broadcast set of revoked txn on A
8505         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
8506         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8507
8508         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8509         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8510         check_closed_broadcast!(nodes[0], false);
8511         check_added_monitors!(nodes[0], 1);
8512         let penalty_txn = {
8513                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8514                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8515                 check_spends!(node_txn[0], revoked_local_txn[0]);
8516                 check_spends!(node_txn[1], revoked_local_txn[0]);
8517                 check_spends!(node_txn[2], revoked_local_txn[0]);
8518                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8519                 node_txn.clear();
8520                 penalty_txn
8521         };
8522         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8523         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8524         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
8525         {
8526                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8527                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8528                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8529                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8530                 }
8531         }
8532 }
8533
8534 #[test]
8535 fn test_override_channel_config() {
8536         let chanmon_cfgs = create_chanmon_cfgs(2);
8537         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8539         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8540
8541         // Node0 initiates a channel to node1 using the override config.
8542         let mut override_config = UserConfig::default();
8543         override_config.own_channel_config.our_to_self_delay = 200;
8544
8545         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8546
8547         // Assert the channel created by node0 is using the override config.
8548         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8549         assert_eq!(res.channel_flags, 0);
8550         assert_eq!(res.to_self_delay, 200);
8551 }
8552
8553 #[test]
8554 fn test_override_0msat_htlc_minimum() {
8555         let mut zero_config = UserConfig::default();
8556         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8557         let chanmon_cfgs = create_chanmon_cfgs(2);
8558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8560         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8561
8562         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8563         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8564         assert_eq!(res.htlc_minimum_msat, 1);
8565
8566         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8567         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8568         assert_eq!(res.htlc_minimum_msat, 1);
8569 }
8570
8571 #[test]
8572 fn test_simple_payment_secret() {
8573         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8574         // features, however.
8575         let chanmon_cfgs = create_chanmon_cfgs(3);
8576         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8577         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8578         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8579
8580         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8581         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8582         let logger = test_utils::TestLogger::new();
8583
8584         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8585         let payment_secret = PaymentSecret([0xdb; 32]);
8586         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8587         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();
8588         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8589         // Claiming with all the correct values but the wrong secret should result in nothing...
8590         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8591         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8592         // ...but with the right secret we should be able to claim all the way back
8593         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8594 }
8595
8596 #[test]
8597 fn test_simple_mpp() {
8598         // Simple test of sending a multi-path payment.
8599         let chanmon_cfgs = create_chanmon_cfgs(4);
8600         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8601         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8602         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8603
8604         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8605         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8606         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8607         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8608         let logger = test_utils::TestLogger::new();
8609
8610         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8611         let payment_secret = PaymentSecret([0xdb; 32]);
8612         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8613         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();
8614         let path = route.paths[0].clone();
8615         route.paths.push(path);
8616         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8617         route.paths[0][0].short_channel_id = chan_1_id;
8618         route.paths[0][1].short_channel_id = chan_3_id;
8619         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8620         route.paths[1][0].short_channel_id = chan_2_id;
8621         route.paths[1][1].short_channel_id = chan_4_id;
8622         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8623         // Claiming with all the correct values but the wrong secret should result in nothing...
8624         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8625         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8626         // ...but with the right secret we should be able to claim all the way back
8627         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8628 }
8629
8630 #[test]
8631 fn test_update_err_monitor_lockdown() {
8632         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8633         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8634         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8635         //
8636         // This scenario may happen in a watchtower setup, where watchtower process a block height
8637         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8638         // commitment at same time.
8639
8640         let chanmon_cfgs = create_chanmon_cfgs(2);
8641         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8642         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8643         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8644
8645         // Create some initial channel
8646         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8647         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8648
8649         // Rebalance the network to generate htlc in the two directions
8650         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8651
8652         // Route a HTLC from node 0 to node 1 (but don't settle)
8653         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8654
8655         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8656         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8657         let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8658         let watchtower = {
8659                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8660                 let monitor = monitors.get(&outpoint).unwrap();
8661                 let mut w = test_utils::TestVecWriter(Vec::new());
8662                 monitor.write_for_disk(&mut w).unwrap();
8663                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8664                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8665                 assert!(new_monitor == *monitor);
8666                 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8667                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8668                 watchtower
8669         };
8670         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8671         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
8672
8673         // Try to update ChannelMonitor
8674         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8675         check_added_monitors!(nodes[1], 1);
8676         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8677         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8678         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8679         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8680                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8681                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8682                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8683                 } else { assert!(false); }
8684         } else { assert!(false); };
8685         // Our local monitor is in-sync and hasn't processed yet timeout
8686         check_added_monitors!(nodes[0], 1);
8687         let events = nodes[0].node.get_and_clear_pending_events();
8688         assert_eq!(events.len(), 1);
8689 }