_ 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::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
   9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  11 use ln::channelmonitor;
  12 use ln::channel::{Channel, ChannelError};
  13 use ln::{chan_utils, onion_utils};
  14 use routing::router::{Route, RouteHop, get_route};
  15 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  16 use ln::msgs;
  17 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction, OptionalField};
  18 use util::enforcing_trait_impls::EnforcingChannelKeys;
  19 use util::{byte_utils, test_utils};
  20 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  21 use util::errors::APIError;
  22 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
  23 use util::config::UserConfig;
  24
  25 use bitcoin::util::hash::BitcoinHash;
  26 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  27 use bitcoin::hashes::HashEngine;
  28 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  29 use bitcoin::util::bip143;
  30 use bitcoin::util::address::Address;
  31 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  32 use bitcoin::blockdata::block::{Block, BlockHeader};
  33 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  34 use bitcoin::blockdata::script::{Builder, Script};
  35 use bitcoin::blockdata::opcodes;
  36 use bitcoin::blockdata::constants::genesis_block;
  37 use bitcoin::network::constants::Network;
  38
  39 use bitcoin::hashes::sha256::Hash as Sha256;
  40 use bitcoin::hashes::Hash;
  41
  42 use bitcoin::secp256k1::{Secp256k1, Message};
  43 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  44
  45 use regex;
  46
  47 use std::collections::{BTreeSet, HashMap, HashSet};
  48 use std::default::Default;
  49 use std::sync::{Arc, Mutex};
  50 use std::sync::atomic::Ordering;
  51 use std::{mem, io};
  52
  53 use ln::functional_test_utils::*;
  54
  55 #[test]
  56 fn test_insane_channel_opens() {
  57         // Stand up a network of 2 nodes
  58         let chanmon_cfgs = create_chanmon_cfgs(2);
  59         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  60         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  61         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  62
  63         // Instantiate channel parameters where we push the maximum msats given our
  64         // funding satoshis
  65         let channel_value_sat = 31337; // same as funding satoshis
  66         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
  67         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  68
  69         // Have node0 initiate a channel to node1 with aforementioned parameters
  70         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  71
  72         // Extract the channel open message from node0 to node1
  73         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  74
  75         // Test helper that asserts we get the correct error string given a mutator
  76         // that supposedly makes the channel open message insane
  77         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  78                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  79                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  80                 assert_eq!(msg_events.len(), 1);
  81                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  82                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  83                         match action {
  84                                 &ErrorAction::SendErrorMessage { .. } => {
  85                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  86                                 },
  87                                 _ => panic!("unexpected event!"),
  88                         }
  89                 } else { assert!(false); }
  90         };
  91
  92         use ln::channel::MAX_FUNDING_SATOSHIS;
  93         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  94
  95         // Test all mutations that would make the channel open message insane
  96         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 });
  97
  98         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  99
 100         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 });
 101
 102         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 103
 104         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 });
 105
 106         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 });
 107
 108         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 });
 109
 110         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 111
 112         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 113 }
 114
 115 #[test]
 116 fn test_async_inbound_update_fee() {
 117         let chanmon_cfgs = create_chanmon_cfgs(2);
 118         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 119         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 120         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 121         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 122         let logger = test_utils::TestLogger::new();
 123         let channel_id = chan.2;
 124
 125         // balancing
 126         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 127
 128         // A                                        B
 129         // update_fee                            ->
 130         // send (1) commitment_signed            -.
 131         //                                       <- update_add_htlc/commitment_signed
 132         // send (2) RAA (awaiting remote revoke) -.
 133         // (1) commitment_signed is delivered    ->
 134         //                                       .- send (3) RAA (awaiting remote revoke)
 135         // (2) RAA is delivered                  ->
 136         //                                       .- send (4) commitment_signed
 137         //                                       <- (3) RAA is delivered
 138         // send (5) commitment_signed            -.
 139         //                                       <- (4) commitment_signed is delivered
 140         // send (6) RAA                          -.
 141         // (5) commitment_signed is delivered    ->
 142         //                                       <- RAA
 143         // (6) RAA is delivered                  ->
 144
 145         // First nodes[0] generates an update_fee
 146         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 147         check_added_monitors!(nodes[0], 1);
 148
 149         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 150         assert_eq!(events_0.len(), 1);
 151         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 152                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 153                         (update_fee.as_ref(), commitment_signed)
 154                 },
 155                 _ => panic!("Unexpected event"),
 156         };
 157
 158         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 159
 160         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 161         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 162         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 163         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();
 164         check_added_monitors!(nodes[1], 1);
 165
 166         let payment_event = {
 167                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 168                 assert_eq!(events_1.len(), 1);
 169                 SendEvent::from_event(events_1.remove(0))
 170         };
 171         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 172         assert_eq!(payment_event.msgs.len(), 1);
 173
 174         // ...now when the messages get delivered everyone should be happy
 175         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 176         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 177         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 178         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 179         check_added_monitors!(nodes[0], 1);
 180
 181         // deliver(1), generate (3):
 182         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 183         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 184         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 185         check_added_monitors!(nodes[1], 1);
 186
 187         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 188         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 189         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 190         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 191         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 192         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 193         assert!(bs_update.update_fee.is_none()); // (4)
 194         check_added_monitors!(nodes[1], 1);
 195
 196         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 197         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 198         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 199         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 200         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 201         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 202         assert!(as_update.update_fee.is_none()); // (5)
 203         check_added_monitors!(nodes[0], 1);
 204
 205         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 206         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 207         // only (6) so get_event_msg's assert(len == 1) passes
 208         check_added_monitors!(nodes[0], 1);
 209
 210         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 211         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 212         check_added_monitors!(nodes[1], 1);
 213
 214         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 215         check_added_monitors!(nodes[0], 1);
 216
 217         let events_2 = nodes[0].node.get_and_clear_pending_events();
 218         assert_eq!(events_2.len(), 1);
 219         match events_2[0] {
 220                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 221                 _ => panic!("Unexpected event"),
 222         }
 223
 224         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 225         check_added_monitors!(nodes[1], 1);
 226 }
 227
 228 #[test]
 229 fn test_update_fee_unordered_raa() {
 230         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 231         // crash in an earlier version of the update_fee patch)
 232         let chanmon_cfgs = create_chanmon_cfgs(2);
 233         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 234         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 235         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 236         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 237         let channel_id = chan.2;
 238         let logger = test_utils::TestLogger::new();
 239
 240         // balancing
 241         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 242
 243         // First nodes[0] generates an update_fee
 244         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 245         check_added_monitors!(nodes[0], 1);
 246
 247         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 248         assert_eq!(events_0.len(), 1);
 249         let update_msg = match events_0[0] { // (1)
 250                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 251                         update_fee.as_ref()
 252                 },
 253                 _ => panic!("Unexpected event"),
 254         };
 255
 256         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 257
 258         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 259         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 260         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 261         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();
 262         check_added_monitors!(nodes[1], 1);
 263
 264         let payment_event = {
 265                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 266                 assert_eq!(events_1.len(), 1);
 267                 SendEvent::from_event(events_1.remove(0))
 268         };
 269         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 270         assert_eq!(payment_event.msgs.len(), 1);
 271
 272         // ...now when the messages get delivered everyone should be happy
 273         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 274         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 275         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 276         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 277         check_added_monitors!(nodes[0], 1);
 278
 279         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 280         check_added_monitors!(nodes[1], 1);
 281
 282         // We can't continue, sadly, because our (1) now has a bogus signature
 283 }
 284
 285 #[test]
 286 fn test_multi_flight_update_fee() {
 287         let chanmon_cfgs = create_chanmon_cfgs(2);
 288         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 289         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 290         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 291         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 292         let channel_id = chan.2;
 293
 294         // A                                        B
 295         // update_fee/commitment_signed          ->
 296         //                                       .- send (1) RAA and (2) commitment_signed
 297         // update_fee (never committed)          ->
 298         // (3) update_fee                        ->
 299         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 300         // don't track which updates correspond to which revoke_and_ack responses so we're in
 301         // AwaitingRAA mode and will not generate the update_fee yet.
 302         //                                       <- (1) RAA delivered
 303         // (3) is generated and send (4) CS      -.
 304         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 305         // know the per_commitment_point to use for it.
 306         //                                       <- (2) commitment_signed delivered
 307         // revoke_and_ack                        ->
 308         //                                          B should send no response here
 309         // (4) commitment_signed delivered       ->
 310         //                                       <- RAA/commitment_signed delivered
 311         // revoke_and_ack                        ->
 312
 313         // First nodes[0] generates an update_fee
 314         let initial_feerate = get_feerate!(nodes[0], channel_id);
 315         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 316         check_added_monitors!(nodes[0], 1);
 317
 318         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 319         assert_eq!(events_0.len(), 1);
 320         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 321                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 322                         (update_fee.as_ref().unwrap(), commitment_signed)
 323                 },
 324                 _ => panic!("Unexpected event"),
 325         };
 326
 327         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 328         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 329         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 330         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 331         check_added_monitors!(nodes[1], 1);
 332
 333         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 334         // transaction:
 335         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 336         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 337         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 338
 339         // Create the (3) update_fee message that nodes[0] will generate before it does...
 340         let mut update_msg_2 = msgs::UpdateFee {
 341                 channel_id: update_msg_1.channel_id.clone(),
 342                 feerate_per_kw: (initial_feerate + 30) as u32,
 343         };
 344
 345         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 346
 347         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 348         // Deliver (3)
 349         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 350
 351         // Deliver (1), generating (3) and (4)
 352         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 353         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 354         check_added_monitors!(nodes[0], 1);
 355         assert!(as_second_update.update_add_htlcs.is_empty());
 356         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 357         assert!(as_second_update.update_fail_htlcs.is_empty());
 358         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 359         // Check that the update_fee newly generated matches what we delivered:
 360         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 361         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 362
 363         // Deliver (2) commitment_signed
 364         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 365         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 366         check_added_monitors!(nodes[0], 1);
 367         // No commitment_signed so get_event_msg's assert(len == 1) passes
 368
 369         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 370         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 371         check_added_monitors!(nodes[1], 1);
 372
 373         // Delever (4)
 374         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 375         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 376         check_added_monitors!(nodes[1], 1);
 377
 378         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 379         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 380         check_added_monitors!(nodes[0], 1);
 381
 382         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 383         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 384         // No commitment_signed so get_event_msg's assert(len == 1) passes
 385         check_added_monitors!(nodes[0], 1);
 386
 387         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 388         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 389         check_added_monitors!(nodes[1], 1);
 390 }
 391
 392 #[test]
 393 fn test_1_conf_open() {
 394         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 395         // tests that we properly send one in that case.
 396         let mut alice_config = UserConfig::default();
 397         alice_config.own_channel_config.minimum_depth = 1;
 398         alice_config.channel_options.announced_channel = true;
 399         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 400         let mut bob_config = UserConfig::default();
 401         bob_config.own_channel_config.minimum_depth = 1;
 402         bob_config.channel_options.announced_channel = true;
 403         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 404         let chanmon_cfgs = create_chanmon_cfgs(2);
 405         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 406         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 407         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 408
 409         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 410         let block = Block {
 411                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 412                 txdata: vec![tx],
 413         };
 414         connect_block(&nodes[1], &block, 1);
 415         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()));
 416
 417         connect_block(&nodes[0], &block, 1);
 418         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 419         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 420
 421         for node in nodes {
 422                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 423                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 424                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 425         }
 426 }
 427
 428 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 429         // Previously, we had issues deserializing channels when we hadn't connected the first block
 430         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 431         // serialization round-trips and simply do steps towards opening a channel and then drop the
 432         // Node objects.
 433
 434         let chanmon_cfgs = create_chanmon_cfgs(2);
 435         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 436         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 437         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 438
 439         if steps & 0b1000_0000 != 0{
 440                 let block = Block {
 441                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 442                         txdata: vec![],
 443                 };
 444                 connect_block(&nodes[0], &block, 1);
 445                 connect_block(&nodes[1], &block, 1);
 446         }
 447
 448         if steps & 0x0f == 0 { return; }
 449         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 450         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 451
 452         if steps & 0x0f == 1 { return; }
 453         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 454         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 455
 456         if steps & 0x0f == 2 { return; }
 457         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 458
 459         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 460
 461         if steps & 0x0f == 3 { return; }
 462         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 463         check_added_monitors!(nodes[0], 0);
 464         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 465
 466         if steps & 0x0f == 4 { return; }
 467         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 468         {
 469                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 470                 assert_eq!(added_monitors.len(), 1);
 471                 assert_eq!(added_monitors[0].0, funding_output);
 472                 added_monitors.clear();
 473         }
 474         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 475
 476         if steps & 0x0f == 5 { return; }
 477         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 478         {
 479                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 480                 assert_eq!(added_monitors.len(), 1);
 481                 assert_eq!(added_monitors[0].0, funding_output);
 482                 added_monitors.clear();
 483         }
 484
 485         let events_4 = nodes[0].node.get_and_clear_pending_events();
 486         assert_eq!(events_4.len(), 1);
 487         match events_4[0] {
 488                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 489                         assert_eq!(user_channel_id, 42);
 490                         assert_eq!(*funding_txo, funding_output);
 491                 },
 492                 _ => panic!("Unexpected event"),
 493         };
 494
 495         if steps & 0x0f == 6 { return; }
 496         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 497
 498         if steps & 0x0f == 7 { return; }
 499         confirm_transaction(&nodes[0], &tx);
 500         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 501 }
 502
 503 #[test]
 504 fn test_sanity_on_in_flight_opens() {
 505         do_test_sanity_on_in_flight_opens(0);
 506         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 507         do_test_sanity_on_in_flight_opens(1);
 508         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(2);
 510         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(3);
 512         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(4);
 514         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(5);
 516         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(6);
 518         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(7);
 520         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(8);
 522         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 523 }
 524
 525 #[test]
 526 fn test_update_fee_vanilla() {
 527         let chanmon_cfgs = create_chanmon_cfgs(2);
 528         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 530         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 531         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 532         let channel_id = chan.2;
 533
 534         let feerate = get_feerate!(nodes[0], channel_id);
 535         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 536         check_added_monitors!(nodes[0], 1);
 537
 538         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 539         assert_eq!(events_0.len(), 1);
 540         let (update_msg, commitment_signed) = match events_0[0] {
 541                         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 } } => {
 542                         (update_fee.as_ref(), commitment_signed)
 543                 },
 544                 _ => panic!("Unexpected event"),
 545         };
 546         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 547
 548         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 549         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 550         check_added_monitors!(nodes[1], 1);
 551
 552         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 553         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 554         check_added_monitors!(nodes[0], 1);
 555
 556         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 557         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 558         // No commitment_signed so get_event_msg's assert(len == 1) passes
 559         check_added_monitors!(nodes[0], 1);
 560
 561         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 562         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 563         check_added_monitors!(nodes[1], 1);
 564 }
 565
 566 #[test]
 567 fn test_update_fee_that_funder_cannot_afford() {
 568         let chanmon_cfgs = create_chanmon_cfgs(2);
 569         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 570         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 571         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 572         let channel_value = 1888;
 573         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 574         let channel_id = chan.2;
 575
 576         let feerate = 260;
 577         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 578         check_added_monitors!(nodes[0], 1);
 579         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 580
 581         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 582
 583         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 584
 585         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 586         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 587         {
 588                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 589
 590                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 591                 let num_htlcs = commitment_tx.output.len() - 2;
 592                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 593                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 594                 actual_fee = channel_value - actual_fee;
 595                 assert_eq!(total_fee, actual_fee);
 596         }
 597
 598         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 599         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 600         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 601         check_added_monitors!(nodes[0], 1);
 602
 603         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 604
 605         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 606
 607         //While producing the commitment_signed response after handling a received update_fee request the
 608         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 609         //Should produce and error.
 610         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 611         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 612         check_added_monitors!(nodes[1], 1);
 613         check_closed_broadcast!(nodes[1], true);
 614 }
 615
 616 #[test]
 617 fn test_update_fee_with_fundee_update_add_htlc() {
 618         let chanmon_cfgs = create_chanmon_cfgs(2);
 619         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 620         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 621         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 622         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 623         let channel_id = chan.2;
 624         let logger = test_utils::TestLogger::new();
 625
 626         // balancing
 627         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 628
 629         let feerate = get_feerate!(nodes[0], channel_id);
 630         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 631         check_added_monitors!(nodes[0], 1);
 632
 633         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 634         assert_eq!(events_0.len(), 1);
 635         let (update_msg, commitment_signed) = match events_0[0] {
 636                         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 } } => {
 637                         (update_fee.as_ref(), commitment_signed)
 638                 },
 639                 _ => panic!("Unexpected event"),
 640         };
 641         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 642         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 643         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 644         check_added_monitors!(nodes[1], 1);
 645
 646         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 647         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 648         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();
 649
 650         // nothing happens since node[1] is in AwaitingRemoteRevoke
 651         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 652         {
 653                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 654                 assert_eq!(added_monitors.len(), 0);
 655                 added_monitors.clear();
 656         }
 657         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 658         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 659         // node[1] has nothing to do
 660
 661         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 663         check_added_monitors!(nodes[0], 1);
 664
 665         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 666         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 667         // No commitment_signed so get_event_msg's assert(len == 1) passes
 668         check_added_monitors!(nodes[0], 1);
 669         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 670         check_added_monitors!(nodes[1], 1);
 671         // AwaitingRemoteRevoke ends here
 672
 673         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 674         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 675         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 676         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 677         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 678         assert_eq!(commitment_update.update_fee.is_none(), true);
 679
 680         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 681         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 682         check_added_monitors!(nodes[0], 1);
 683         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 684
 685         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 686         check_added_monitors!(nodes[1], 1);
 687         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 688
 689         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 690         check_added_monitors!(nodes[1], 1);
 691         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 692         // No commitment_signed so get_event_msg's assert(len == 1) passes
 693
 694         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 695         check_added_monitors!(nodes[0], 1);
 696         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 697
 698         expect_pending_htlcs_forwardable!(nodes[0]);
 699
 700         let events = nodes[0].node.get_and_clear_pending_events();
 701         assert_eq!(events.len(), 1);
 702         match events[0] {
 703                 Event::PaymentReceived { .. } => { },
 704                 _ => panic!("Unexpected event"),
 705         };
 706
 707         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 708
 709         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 710         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 711         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 712 }
 713
 714 #[test]
 715 fn test_update_fee() {
 716         let chanmon_cfgs = create_chanmon_cfgs(2);
 717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 719         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 720         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 721         let channel_id = chan.2;
 722
 723         // A                                        B
 724         // (1) update_fee/commitment_signed      ->
 725         //                                       <- (2) revoke_and_ack
 726         //                                       .- send (3) commitment_signed
 727         // (4) update_fee/commitment_signed      ->
 728         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 729         //                                       <- (3) commitment_signed delivered
 730         // send (6) revoke_and_ack               -.
 731         //                                       <- (5) deliver revoke_and_ack
 732         // (6) deliver revoke_and_ack            ->
 733         //                                       .- send (7) commitment_signed in response to (4)
 734         //                                       <- (7) deliver commitment_signed
 735         // revoke_and_ack                        ->
 736
 737         // Create and deliver (1)...
 738         let feerate = get_feerate!(nodes[0], channel_id);
 739         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 740         check_added_monitors!(nodes[0], 1);
 741
 742         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 743         assert_eq!(events_0.len(), 1);
 744         let (update_msg, commitment_signed) = match events_0[0] {
 745                         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 } } => {
 746                         (update_fee.as_ref(), commitment_signed)
 747                 },
 748                 _ => panic!("Unexpected event"),
 749         };
 750         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 751
 752         // Generate (2) and (3):
 753         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 754         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 755         check_added_monitors!(nodes[1], 1);
 756
 757         // Deliver (2):
 758         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 759         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 760         check_added_monitors!(nodes[0], 1);
 761
 762         // Create and deliver (4)...
 763         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 764         check_added_monitors!(nodes[0], 1);
 765         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 766         assert_eq!(events_0.len(), 1);
 767         let (update_msg, commitment_signed) = match events_0[0] {
 768                         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 } } => {
 769                         (update_fee.as_ref(), commitment_signed)
 770                 },
 771                 _ => panic!("Unexpected event"),
 772         };
 773
 774         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 775         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 776         check_added_monitors!(nodes[1], 1);
 777         // ... creating (5)
 778         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 779         // No commitment_signed so get_event_msg's assert(len == 1) passes
 780
 781         // Handle (3), creating (6):
 782         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 783         check_added_monitors!(nodes[0], 1);
 784         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 785         // No commitment_signed so get_event_msg's assert(len == 1) passes
 786
 787         // Deliver (5):
 788         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 789         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 790         check_added_monitors!(nodes[0], 1);
 791
 792         // Deliver (6), creating (7):
 793         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 794         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 795         assert!(commitment_update.update_add_htlcs.is_empty());
 796         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 797         assert!(commitment_update.update_fail_htlcs.is_empty());
 798         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 799         assert!(commitment_update.update_fee.is_none());
 800         check_added_monitors!(nodes[1], 1);
 801
 802         // Deliver (7)
 803         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 804         check_added_monitors!(nodes[0], 1);
 805         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 806         // No commitment_signed so get_event_msg's assert(len == 1) passes
 807
 808         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 809         check_added_monitors!(nodes[1], 1);
 810         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 811
 812         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 813         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 814         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 815 }
 816
 817 #[test]
 818 fn pre_funding_lock_shutdown_test() {
 819         // Test sending a shutdown prior to funding_locked after funding generation
 820         let chanmon_cfgs = create_chanmon_cfgs(2);
 821         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 822         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 823         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 824         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 825         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 826         connect_block(&nodes[0], &Block { header, txdata: vec![tx.clone()]}, 1);
 827         connect_block(&nodes[1], &Block { header, txdata: vec![tx.clone()]}, 1);
 828
 829         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 830         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 831         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 832         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 833         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 834
 835         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 836         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 837         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 838         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 839         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 840         assert!(node_0_none.is_none());
 841
 842         assert!(nodes[0].node.list_channels().is_empty());
 843         assert!(nodes[1].node.list_channels().is_empty());
 844 }
 845
 846 #[test]
 847 fn updates_shutdown_wait() {
 848         // Test sending a shutdown with outstanding updates pending
 849         let chanmon_cfgs = create_chanmon_cfgs(3);
 850         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 851         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 852         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 853         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 854         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 855         let logger = test_utils::TestLogger::new();
 856
 857         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 858
 859         nodes[0].node.close_channel(&chan_1.2).unwrap();
 860         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 861         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 862         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 863         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 864
 865         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 866         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 867
 868         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 869
 870         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 871         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 872         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();
 873         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();
 874         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 875         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 876
 877         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 878         check_added_monitors!(nodes[2], 1);
 879         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 880         assert!(updates.update_add_htlcs.is_empty());
 881         assert!(updates.update_fail_htlcs.is_empty());
 882         assert!(updates.update_fail_malformed_htlcs.is_empty());
 883         assert!(updates.update_fee.is_none());
 884         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 885         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 886         check_added_monitors!(nodes[1], 1);
 887         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 888         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 889
 890         assert!(updates_2.update_add_htlcs.is_empty());
 891         assert!(updates_2.update_fail_htlcs.is_empty());
 892         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 893         assert!(updates_2.update_fee.is_none());
 894         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 895         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 896         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 897
 898         let events = nodes[0].node.get_and_clear_pending_events();
 899         assert_eq!(events.len(), 1);
 900         match events[0] {
 901                 Event::PaymentSent { ref payment_preimage } => {
 902                         assert_eq!(our_payment_preimage, *payment_preimage);
 903                 },
 904                 _ => panic!("Unexpected event"),
 905         }
 906
 907         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 908         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 909         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 910         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 911         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 912         assert!(node_0_none.is_none());
 913
 914         assert!(nodes[0].node.list_channels().is_empty());
 915
 916         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 917         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 918         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 919         assert!(nodes[1].node.list_channels().is_empty());
 920         assert!(nodes[2].node.list_channels().is_empty());
 921 }
 922
 923 #[test]
 924 fn htlc_fail_async_shutdown() {
 925         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 926         let chanmon_cfgs = create_chanmon_cfgs(3);
 927         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 928         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 929         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 930         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 931         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 932         let logger = test_utils::TestLogger::new();
 933
 934         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 935         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 936         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();
 937         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 938         check_added_monitors!(nodes[0], 1);
 939         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 940         assert_eq!(updates.update_add_htlcs.len(), 1);
 941         assert!(updates.update_fulfill_htlcs.is_empty());
 942         assert!(updates.update_fail_htlcs.is_empty());
 943         assert!(updates.update_fail_malformed_htlcs.is_empty());
 944         assert!(updates.update_fee.is_none());
 945
 946         nodes[1].node.close_channel(&chan_1.2).unwrap();
 947         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 948         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 949         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 950
 951         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 952         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 953         check_added_monitors!(nodes[1], 1);
 954         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 955         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 956
 957         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 958         assert!(updates_2.update_add_htlcs.is_empty());
 959         assert!(updates_2.update_fulfill_htlcs.is_empty());
 960         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 961         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 962         assert!(updates_2.update_fee.is_none());
 963
 964         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 965         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 966
 967         expect_payment_failed!(nodes[0], our_payment_hash, false);
 968
 969         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 970         assert_eq!(msg_events.len(), 2);
 971         let node_0_closing_signed = match msg_events[0] {
 972                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 973                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 974                         (*msg).clone()
 975                 },
 976                 _ => panic!("Unexpected event"),
 977         };
 978         match msg_events[1] {
 979                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 980                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 981                 },
 982                 _ => panic!("Unexpected event"),
 983         }
 984
 985         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 986         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 987         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 988         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 989         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 990         assert!(node_0_none.is_none());
 991
 992         assert!(nodes[0].node.list_channels().is_empty());
 993
 994         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 995         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 996         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 997         assert!(nodes[1].node.list_channels().is_empty());
 998         assert!(nodes[2].node.list_channels().is_empty());
 999 }
1000
1001 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1002         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1003         // messages delivered prior to disconnect
1004         let chanmon_cfgs = create_chanmon_cfgs(3);
1005         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1006         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1008         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1009         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1010
1011         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1012
1013         nodes[1].node.close_channel(&chan_1.2).unwrap();
1014         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1015         if recv_count > 0 {
1016                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1017                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1018                 if recv_count > 1 {
1019                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1020                 }
1021         }
1022
1023         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1024         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1025
1026         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1028         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1030
1031         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1032         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033         assert!(node_1_shutdown == node_1_2nd_shutdown);
1034
1035         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1036         let node_0_2nd_shutdown = if recv_count > 0 {
1037                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1038                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1039                 node_0_2nd_shutdown
1040         } else {
1041                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1043                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1044         };
1045         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1046
1047         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1048         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1049
1050         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1051         check_added_monitors!(nodes[2], 1);
1052         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053         assert!(updates.update_add_htlcs.is_empty());
1054         assert!(updates.update_fail_htlcs.is_empty());
1055         assert!(updates.update_fail_malformed_htlcs.is_empty());
1056         assert!(updates.update_fee.is_none());
1057         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1058         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1059         check_added_monitors!(nodes[1], 1);
1060         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1061         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1062
1063         assert!(updates_2.update_add_htlcs.is_empty());
1064         assert!(updates_2.update_fail_htlcs.is_empty());
1065         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1066         assert!(updates_2.update_fee.is_none());
1067         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1068         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1069         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1070
1071         let events = nodes[0].node.get_and_clear_pending_events();
1072         assert_eq!(events.len(), 1);
1073         match events[0] {
1074                 Event::PaymentSent { ref payment_preimage } => {
1075                         assert_eq!(our_payment_preimage, *payment_preimage);
1076                 },
1077                 _ => panic!("Unexpected event"),
1078         }
1079
1080         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1081         if recv_count > 0 {
1082                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1083                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1084                 assert!(node_1_closing_signed.is_some());
1085         }
1086
1087         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1088         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1089
1090         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1092         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093         if recv_count == 0 {
1094                 // If all closing_signeds weren't delivered we can just resume where we left off...
1095                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1096
1097                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1098                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1099                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1100
1101                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1102                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1103                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1104
1105                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1106                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1107
1108                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1109                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1110                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1111
1112                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1113                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1114                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1115                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1116                 assert!(node_0_none.is_none());
1117         } else {
1118                 // If one node, however, received + responded with an identical closing_signed we end
1119                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1120                 // There isn't really anything better we can do simply, but in the future we might
1121                 // explore storing a set of recently-closed channels that got disconnected during
1122                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1123                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1124                 // transaction.
1125                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1126
1127                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1128                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1129                 assert_eq!(msg_events.len(), 1);
1130                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1131                         match action {
1132                                 &ErrorAction::SendErrorMessage { ref msg } => {
1133                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1134                                         assert_eq!(msg.channel_id, chan_1.2);
1135                                 },
1136                                 _ => panic!("Unexpected event!"),
1137                         }
1138                 } else { panic!("Needed SendErrorMessage close"); }
1139
1140                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1141                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1142                 // closing_signed so we do it ourselves
1143                 check_closed_broadcast!(nodes[0], false);
1144                 check_added_monitors!(nodes[0], 1);
1145         }
1146
1147         assert!(nodes[0].node.list_channels().is_empty());
1148
1149         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1150         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1151         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1152         assert!(nodes[1].node.list_channels().is_empty());
1153         assert!(nodes[2].node.list_channels().is_empty());
1154 }
1155
1156 #[test]
1157 fn test_shutdown_rebroadcast() {
1158         do_test_shutdown_rebroadcast(0);
1159         do_test_shutdown_rebroadcast(1);
1160         do_test_shutdown_rebroadcast(2);
1161 }
1162
1163 #[test]
1164 fn fake_network_test() {
1165         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1166         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1167         let chanmon_cfgs = create_chanmon_cfgs(4);
1168         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1169         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1170         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1171
1172         // Create some initial channels
1173         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1174         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1175         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1176
1177         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1182
1183         // Send some more payments
1184         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1185         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1186         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1187
1188         // Test failure packets
1189         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1190         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1191
1192         // Add a new channel that skips 3
1193         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1194
1195         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1196         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1202
1203         // Do some rebalance loop payments, simultaneously
1204         let mut hops = Vec::with_capacity(3);
1205         hops.push(RouteHop {
1206                 pubkey: nodes[2].node.get_our_node_id(),
1207                 node_features: NodeFeatures::empty(),
1208                 short_channel_id: chan_2.0.contents.short_channel_id,
1209                 channel_features: ChannelFeatures::empty(),
1210                 fee_msat: 0,
1211                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1212         });
1213         hops.push(RouteHop {
1214                 pubkey: nodes[3].node.get_our_node_id(),
1215                 node_features: NodeFeatures::empty(),
1216                 short_channel_id: chan_3.0.contents.short_channel_id,
1217                 channel_features: ChannelFeatures::empty(),
1218                 fee_msat: 0,
1219                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1220         });
1221         hops.push(RouteHop {
1222                 pubkey: nodes[1].node.get_our_node_id(),
1223                 node_features: NodeFeatures::empty(),
1224                 short_channel_id: chan_4.0.contents.short_channel_id,
1225                 channel_features: ChannelFeatures::empty(),
1226                 fee_msat: 1000000,
1227                 cltv_expiry_delta: TEST_FINAL_CLTV,
1228         });
1229         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;
1230         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;
1231         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1232
1233         let mut hops = Vec::with_capacity(3);
1234         hops.push(RouteHop {
1235                 pubkey: nodes[3].node.get_our_node_id(),
1236                 node_features: NodeFeatures::empty(),
1237                 short_channel_id: chan_4.0.contents.short_channel_id,
1238                 channel_features: ChannelFeatures::empty(),
1239                 fee_msat: 0,
1240                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1241         });
1242         hops.push(RouteHop {
1243                 pubkey: nodes[2].node.get_our_node_id(),
1244                 node_features: NodeFeatures::empty(),
1245                 short_channel_id: chan_3.0.contents.short_channel_id,
1246                 channel_features: ChannelFeatures::empty(),
1247                 fee_msat: 0,
1248                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1249         });
1250         hops.push(RouteHop {
1251                 pubkey: nodes[1].node.get_our_node_id(),
1252                 node_features: NodeFeatures::empty(),
1253                 short_channel_id: chan_2.0.contents.short_channel_id,
1254                 channel_features: ChannelFeatures::empty(),
1255                 fee_msat: 1000000,
1256                 cltv_expiry_delta: TEST_FINAL_CLTV,
1257         });
1258         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;
1259         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;
1260         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1261
1262         // Claim the rebalances...
1263         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1264         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1265
1266         // Add a duplicate new channel from 2 to 4
1267         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1268
1269         // Send some payments across both channels
1270         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273
1274
1275         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1276         let events = nodes[0].node.get_and_clear_pending_msg_events();
1277         assert_eq!(events.len(), 0);
1278         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);
1279
1280         //TODO: Test that routes work again here as we've been notified that the channel is full
1281
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1283         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1285
1286         // Close down the channels...
1287         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1288         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1289         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1290         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1291         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1292 }
1293
1294 #[test]
1295 fn holding_cell_htlc_counting() {
1296         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1297         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1298         // commitment dance rounds.
1299         let chanmon_cfgs = create_chanmon_cfgs(3);
1300         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1301         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1302         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1303         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1304         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1305         let logger = test_utils::TestLogger::new();
1306
1307         let mut payments = Vec::new();
1308         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1309                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1310                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1311                 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();
1312                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1313                 payments.push((payment_preimage, payment_hash));
1314         }
1315         check_added_monitors!(nodes[1], 1);
1316
1317         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1318         assert_eq!(events.len(), 1);
1319         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1320         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1321
1322         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1323         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1324         // another HTLC.
1325         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1326         {
1327                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1328                 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();
1329                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1330                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1331                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1332                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1333         }
1334
1335         // This should also be true if we try to forward a payment.
1336         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1337         {
1338                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1339                 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();
1340                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1341                 check_added_monitors!(nodes[0], 1);
1342         }
1343
1344         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1345         assert_eq!(events.len(), 1);
1346         let payment_event = SendEvent::from_event(events.pop().unwrap());
1347         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1348
1349         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1350         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1351         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1352         // fails), the second will process the resulting failure and fail the HTLC backward.
1353         expect_pending_htlcs_forwardable!(nodes[1]);
1354         expect_pending_htlcs_forwardable!(nodes[1]);
1355         check_added_monitors!(nodes[1], 1);
1356
1357         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1358         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1359         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1360
1361         let events = nodes[0].node.get_and_clear_pending_msg_events();
1362         assert_eq!(events.len(), 1);
1363         match events[0] {
1364                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1365                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1366                 },
1367                 _ => panic!("Unexpected event"),
1368         }
1369
1370         expect_payment_failed!(nodes[0], payment_hash_2, false);
1371
1372         // Now forward all the pending HTLCs and claim them back
1373         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1374         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1375         check_added_monitors!(nodes[2], 1);
1376
1377         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1379         check_added_monitors!(nodes[1], 1);
1380         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1381
1382         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1383         check_added_monitors!(nodes[1], 1);
1384         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1385
1386         for ref update in as_updates.update_add_htlcs.iter() {
1387                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1388         }
1389         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1390         check_added_monitors!(nodes[2], 1);
1391         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1392         check_added_monitors!(nodes[2], 1);
1393         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1394
1395         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1396         check_added_monitors!(nodes[1], 1);
1397         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1398         check_added_monitors!(nodes[1], 1);
1399         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1400
1401         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1402         check_added_monitors!(nodes[2], 1);
1403
1404         expect_pending_htlcs_forwardable!(nodes[2]);
1405
1406         let events = nodes[2].node.get_and_clear_pending_events();
1407         assert_eq!(events.len(), payments.len());
1408         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1409                 match event {
1410                         &Event::PaymentReceived { ref payment_hash, .. } => {
1411                                 assert_eq!(*payment_hash, *hash);
1412                         },
1413                         _ => panic!("Unexpected event"),
1414                 };
1415         }
1416
1417         for (preimage, _) in payments.drain(..) {
1418                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1419         }
1420
1421         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1422 }
1423
1424 #[test]
1425 fn duplicate_htlc_test() {
1426         // Test that we accept duplicate payment_hash HTLCs across the network and that
1427         // claiming/failing them are all separate and don't affect each other
1428         let chanmon_cfgs = create_chanmon_cfgs(6);
1429         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1430         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1431         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1432
1433         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1434         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1435         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1437         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1438         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1439
1440         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1441
1442         *nodes[0].network_payment_count.borrow_mut() -= 1;
1443         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1444
1445         *nodes[0].network_payment_count.borrow_mut() -= 1;
1446         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1447
1448         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1449         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1451 }
1452
1453 #[test]
1454 fn test_duplicate_htlc_different_direction_onchain() {
1455         // Test that ChannelMonitor doesn't generate 2 preimage txn
1456         // when we have 2 HTLCs with same preimage that go across a node
1457         // in opposite directions.
1458         let chanmon_cfgs = create_chanmon_cfgs(2);
1459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1461         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1462
1463         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1464         let logger = test_utils::TestLogger::new();
1465
1466         // balancing
1467         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1468
1469         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1470
1471         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1472         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();
1473         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1474
1475         // Provide preimage to node 0 by claiming payment
1476         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1477         check_added_monitors!(nodes[0], 1);
1478
1479         // Broadcast node 1 commitment txn
1480         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1481
1482         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1483         let mut has_both_htlcs = 0; // check htlcs match ones committed
1484         for outp in remote_txn[0].output.iter() {
1485                 if outp.value == 800_000 / 1000 {
1486                         has_both_htlcs += 1;
1487                 } else if outp.value == 900_000 / 1000 {
1488                         has_both_htlcs += 1;
1489                 }
1490         }
1491         assert_eq!(has_both_htlcs, 2);
1492
1493         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1494         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1495         check_added_monitors!(nodes[0], 1);
1496
1497         // Check we only broadcast 1 timeout tx
1498         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1499         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()) };
1500         assert_eq!(claim_txn.len(), 5);
1501         check_spends!(claim_txn[2], chan_1.3);
1502         check_spends!(claim_txn[3], claim_txn[2]);
1503         assert_eq!(htlc_pair.0.input.len(), 1);
1504         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1505         check_spends!(htlc_pair.0, remote_txn[0]);
1506         assert_eq!(htlc_pair.1.input.len(), 1);
1507         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1508         check_spends!(htlc_pair.1, remote_txn[0]);
1509
1510         let events = nodes[0].node.get_and_clear_pending_msg_events();
1511         assert_eq!(events.len(), 2);
1512         for e in events {
1513                 match e {
1514                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1515                         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, .. } } => {
1516                                 assert!(update_add_htlcs.is_empty());
1517                                 assert!(update_fail_htlcs.is_empty());
1518                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1519                                 assert!(update_fail_malformed_htlcs.is_empty());
1520                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1521                         },
1522                         _ => panic!("Unexpected event"),
1523                 }
1524         }
1525 }
1526
1527 #[test]
1528 fn test_basic_channel_reserve() {
1529         let chanmon_cfgs = create_chanmon_cfgs(2);
1530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1532         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1533         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1534         let logger = test_utils::TestLogger::new();
1535
1536         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1537         let channel_reserve = chan_stat.channel_reserve_msat;
1538
1539         // The 2* and +1 are for the fee spike reserve.
1540         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1541         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1542         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1543         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1544         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();
1545         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1546         match err {
1547                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1548                         match &fails[0] {
1549                                 &APIError::ChannelUnavailable{ref err} =>
1550                                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1551                                 _ => panic!("Unexpected error variant"),
1552                         }
1553                 },
1554                 _ => panic!("Unexpected error variant"),
1555         }
1556         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1557         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);
1558
1559         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1560 }
1561
1562 #[test]
1563 fn test_fee_spike_violation_fails_htlc() {
1564         let chanmon_cfgs = create_chanmon_cfgs(2);
1565         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1566         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1567         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1568         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1569         let logger = test_utils::TestLogger::new();
1570
1571         macro_rules! get_route_and_payment_hash {
1572                 ($recv_value: expr) => {{
1573                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1574                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1575                         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();
1576                         (route, payment_hash, payment_preimage)
1577                 }}
1578         };
1579
1580         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1581         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1582         let secp_ctx = Secp256k1::new();
1583         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1584
1585         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1586
1587         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1588         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1589         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1590         let msg = msgs::UpdateAddHTLC {
1591                 channel_id: chan.2,
1592                 htlc_id: 0,
1593                 amount_msat: htlc_msat,
1594                 payment_hash: payment_hash,
1595                 cltv_expiry: htlc_cltv,
1596                 onion_routing_packet: onion_packet,
1597         };
1598
1599         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1600
1601         // Now manually create the commitment_signed message corresponding to the update_add
1602         // nodes[0] just sent. In the code for construction of this message, "local" refers
1603         // to the sender of the message, and "remote" refers to the receiver.
1604
1605         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1606
1607         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1608
1609         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1610         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1611         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1612                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1613                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1614                 let chan_keys = local_chan.get_local_keys();
1615                 let pubkeys = chan_keys.pubkeys();
1616                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1617                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1618         };
1619         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1620                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1621                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622                 let chan_keys = remote_chan.get_local_keys();
1623                 let pubkeys = chan_keys.pubkeys();
1624                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1625                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1626         };
1627
1628         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1629         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1630         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1631         let commit_tx_keys = chan_utils::TxCreationKeys::new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1632                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1633
1634         // Build the remote commitment transaction so we can sign it, and then later use the
1635         // signature for the commitment_signed message.
1636         let local_chan_balance = 1313;
1637         let static_payment_pk = local_payment_point.serialize();
1638         let remote_commit_tx_output = TxOut {
1639                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1640                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1641                                                              .into_script(),
1642                 value: local_chan_balance as u64
1643         };
1644
1645         let local_commit_tx_output = TxOut {
1646                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1647                                                                                BREAKDOWN_TIMEOUT,
1648                                                                                &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1649                                 value: 95000,
1650         };
1651
1652         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1653                 offered: false,
1654                 amount_msat: 3460001,
1655                 cltv_expiry: htlc_cltv,
1656                 payment_hash: payment_hash,
1657                 transaction_output_index: Some(1),
1658         };
1659
1660         let htlc_output = TxOut {
1661                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1662                 value: 3460001 / 1000
1663         };
1664
1665         let commit_tx_obscure_factor = {
1666                 let mut sha = Sha256::engine();
1667                 let remote_payment_point = &remote_payment_point.serialize();
1668                 sha.input(&local_payment_point.serialize());
1669                 sha.input(remote_payment_point);
1670                 let res = Sha256::from_engine(sha).into_inner();
1671
1672                 ((res[26] as u64) << 5*8) |
1673                 ((res[27] as u64) << 4*8) |
1674                 ((res[28] as u64) << 3*8) |
1675                 ((res[29] as u64) << 2*8) |
1676                 ((res[30] as u64) << 1*8) |
1677                 ((res[31] as u64) << 0*8)
1678         };
1679         let commitment_number = 1;
1680         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1681         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1682         let input = TxIn {
1683                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1684                 script_sig: Script::new(),
1685                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1686                 witness: Vec::new(),
1687         };
1688
1689         let commit_tx = Transaction {
1690                 version: 2,
1691                 lock_time,
1692                 input: vec![input],
1693                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1694         };
1695         let res = {
1696                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1697                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1698                 let local_chan_keys = local_chan.get_local_keys();
1699                 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &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                 connect_block(&nodes[0], &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                 connect_block(&nodes[2], &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                 connect_block(&nodes[3], &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                 connect_block(&nodes[4], &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 block = Block {
2397                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2398                         txdata: vec![],
2399                 };
2400                 connect_block(&nodes[3], &block, 2);
2401                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2402                         block = Block {
2403                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2404                                 txdata: vec![],
2405                         };
2406                         connect_block(&nodes[3], &block, i);
2407                 }
2408                 check_added_monitors!(nodes[3], 1);
2409
2410                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2411                 {
2412                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2413                         node_txn.retain(|tx| {
2414                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2415                                         false
2416                                 } else { true }
2417                         });
2418                 }
2419
2420                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2421
2422                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2423                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2424
2425                 block = Block {
2426                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2427                         txdata: vec![],
2428                 };
2429
2430                 connect_block(&nodes[4], &block, 2);
2431                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2432                         block = Block {
2433                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2434                                 txdata: vec![],
2435                         };
2436                         connect_block(&nodes[4], &block, i);
2437                 }
2438
2439                 check_added_monitors!(nodes[4], 1);
2440                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2441
2442                 block = Block {
2443                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2444                         txdata: vec![node_txn[0].clone()],
2445                 };
2446                 connect_block(&nodes[4], &block, TEST_FINAL_CLTV - 5);
2447
2448                 check_preimage_claim(&nodes[4], &node_txn);
2449         }
2450         get_announce_close_broadcast_events(&nodes, 3, 4);
2451         assert_eq!(nodes[3].node.list_channels().len(), 0);
2452         assert_eq!(nodes[4].node.list_channels().len(), 0);
2453 }
2454
2455 #[test]
2456 fn test_justice_tx() {
2457         // Test justice txn built on revoked HTLC-Success tx, against both sides
2458         let mut alice_config = UserConfig::default();
2459         alice_config.channel_options.announced_channel = true;
2460         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2461         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2462         let mut bob_config = UserConfig::default();
2463         bob_config.channel_options.announced_channel = true;
2464         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2465         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2466         let user_cfgs = [Some(alice_config), Some(bob_config)];
2467         let chanmon_cfgs = create_chanmon_cfgs(2);
2468         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2469         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2470         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2471         // Create some new channels:
2472         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2473
2474         // A pending HTLC which will be revoked:
2475         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2476         // Get the will-be-revoked local txn from nodes[0]
2477         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2478         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2479         assert_eq!(revoked_local_txn[0].input.len(), 1);
2480         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2481         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2482         assert_eq!(revoked_local_txn[1].input.len(), 1);
2483         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2484         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2485         // Revoke the old state
2486         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2487
2488         {
2489                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2490                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2491                 {
2492                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2493                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2494                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2495
2496                         check_spends!(node_txn[0], revoked_local_txn[0]);
2497                         node_txn.swap_remove(0);
2498                         node_txn.truncate(1);
2499                 }
2500                 check_added_monitors!(nodes[1], 1);
2501                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2502
2503                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2504                 // Verify broadcast of revoked HTLC-timeout
2505                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2506                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2507                 check_added_monitors!(nodes[0], 1);
2508                 // Broadcast revoked HTLC-timeout on node 1
2509                 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2510                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2511         }
2512         get_announce_close_broadcast_events(&nodes, 0, 1);
2513
2514         assert_eq!(nodes[0].node.list_channels().len(), 0);
2515         assert_eq!(nodes[1].node.list_channels().len(), 0);
2516
2517         // We test justice_tx build by A on B's revoked HTLC-Success tx
2518         // Create some new channels:
2519         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2520         {
2521                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2522                 node_txn.clear();
2523         }
2524
2525         // A pending HTLC which will be revoked:
2526         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2527         // Get the will-be-revoked local txn from B
2528         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2529         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2530         assert_eq!(revoked_local_txn[0].input.len(), 1);
2531         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2532         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2533         // Revoke the old state
2534         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2535         {
2536                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2537                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2538                 {
2539                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2540                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2541                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2542
2543                         check_spends!(node_txn[0], revoked_local_txn[0]);
2544                         node_txn.swap_remove(0);
2545                 }
2546                 check_added_monitors!(nodes[0], 1);
2547                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2548
2549                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2550                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2551                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2552                 check_added_monitors!(nodes[1], 1);
2553                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2554                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2555         }
2556         get_announce_close_broadcast_events(&nodes, 0, 1);
2557         assert_eq!(nodes[0].node.list_channels().len(), 0);
2558         assert_eq!(nodes[1].node.list_channels().len(), 0);
2559 }
2560
2561 #[test]
2562 fn revoked_output_claim() {
2563         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2564         // transaction is broadcast by its counterparty
2565         let chanmon_cfgs = create_chanmon_cfgs(2);
2566         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2567         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2568         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2569         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2570         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2571         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2572         assert_eq!(revoked_local_txn.len(), 1);
2573         // Only output is the full channel value back to nodes[0]:
2574         assert_eq!(revoked_local_txn[0].output.len(), 1);
2575         // Send a payment through, updating everyone's latest commitment txn
2576         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2577
2578         // Inform nodes[1] that nodes[0] broadcast a stale tx
2579         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2580         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2581         check_added_monitors!(nodes[1], 1);
2582         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2583         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2584
2585         check_spends!(node_txn[0], revoked_local_txn[0]);
2586         check_spends!(node_txn[1], chan_1.3);
2587
2588         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2589         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2590         get_announce_close_broadcast_events(&nodes, 0, 1);
2591         check_added_monitors!(nodes[0], 1)
2592 }
2593
2594 #[test]
2595 fn claim_htlc_outputs_shared_tx() {
2596         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2597         let chanmon_cfgs = create_chanmon_cfgs(2);
2598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2600         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2601
2602         // Create some new channel:
2603         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2604
2605         // Rebalance the network to generate htlc in the two directions
2606         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2607         // 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
2608         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2609         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2610
2611         // Get the will-be-revoked local txn from node[0]
2612         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2613         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2614         assert_eq!(revoked_local_txn[0].input.len(), 1);
2615         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2616         assert_eq!(revoked_local_txn[1].input.len(), 1);
2617         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2618         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2619         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2620
2621         //Revoke the old state
2622         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2623
2624         {
2625                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2626                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2627                 check_added_monitors!(nodes[0], 1);
2628                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2629                 check_added_monitors!(nodes[1], 1);
2630                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2631                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2632
2633                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2634                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2635
2636                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2637                 check_spends!(node_txn[0], revoked_local_txn[0]);
2638
2639                 let mut witness_lens = BTreeSet::new();
2640                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2641                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2642                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2643                 assert_eq!(witness_lens.len(), 3);
2644                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2645                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2646                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2647
2648                 // Next nodes[1] broadcasts its current local tx state:
2649                 assert_eq!(node_txn[1].input.len(), 1);
2650                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2651
2652                 assert_eq!(node_txn[2].input.len(), 1);
2653                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2654                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2655                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2656                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2657                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2658         }
2659         get_announce_close_broadcast_events(&nodes, 0, 1);
2660         assert_eq!(nodes[0].node.list_channels().len(), 0);
2661         assert_eq!(nodes[1].node.list_channels().len(), 0);
2662 }
2663
2664 #[test]
2665 fn claim_htlc_outputs_single_tx() {
2666         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2667         let chanmon_cfgs = create_chanmon_cfgs(2);
2668         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2669         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2670         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2671
2672         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2673
2674         // Rebalance the network to generate htlc in the two directions
2675         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2676         // 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
2677         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2678         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2679         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2680
2681         // Get the will-be-revoked local txn from node[0]
2682         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2683
2684         //Revoke the old state
2685         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2686
2687         {
2688                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2689                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2690                 check_added_monitors!(nodes[0], 1);
2691                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2692                 check_added_monitors!(nodes[1], 1);
2693                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2694
2695                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2696                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2697
2698                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2699                 assert_eq!(node_txn.len(), 9);
2700                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2701                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2702                 // 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)
2703                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2704
2705                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2706                 assert_eq!(node_txn[2].input.len(), 1);
2707                 check_spends!(node_txn[2], chan_1.3);
2708                 assert_eq!(node_txn[3].input.len(), 1);
2709                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2710                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2711                 check_spends!(node_txn[3], node_txn[2]);
2712
2713                 // Justice transactions are indices 1-2-4
2714                 assert_eq!(node_txn[0].input.len(), 1);
2715                 assert_eq!(node_txn[1].input.len(), 1);
2716                 assert_eq!(node_txn[4].input.len(), 1);
2717
2718                 check_spends!(node_txn[0], revoked_local_txn[0]);
2719                 check_spends!(node_txn[1], revoked_local_txn[0]);
2720                 check_spends!(node_txn[4], revoked_local_txn[0]);
2721
2722                 let mut witness_lens = BTreeSet::new();
2723                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2724                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2725                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2726                 assert_eq!(witness_lens.len(), 3);
2727                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2728                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2729                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2730         }
2731         get_announce_close_broadcast_events(&nodes, 0, 1);
2732         assert_eq!(nodes[0].node.list_channels().len(), 0);
2733         assert_eq!(nodes[1].node.list_channels().len(), 0);
2734 }
2735
2736 #[test]
2737 fn test_htlc_on_chain_success() {
2738         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2739         // the preimage backward accordingly. So here we test that ChannelManager is
2740         // broadcasting the right event to other nodes in payment path.
2741         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2742         // A --------------------> B ----------------------> C (preimage)
2743         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2744         // commitment transaction was broadcast.
2745         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2746         // towards B.
2747         // B should be able to claim via preimage if A then broadcasts its local tx.
2748         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2749         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2750         // PaymentSent event).
2751
2752         let chanmon_cfgs = create_chanmon_cfgs(3);
2753         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2754         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2755         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2756
2757         // Create some initial channels
2758         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2759         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2760
2761         // Rebalance the network a bit by relaying one payment through all the channels...
2762         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2763         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2764
2765         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2766         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2767         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2768
2769         // Broadcast legit commitment tx from C on B's chain
2770         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2771         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2772         assert_eq!(commitment_tx.len(), 1);
2773         check_spends!(commitment_tx[0], chan_2.3);
2774         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2775         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2776         check_added_monitors!(nodes[2], 2);
2777         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2778         assert!(updates.update_add_htlcs.is_empty());
2779         assert!(updates.update_fail_htlcs.is_empty());
2780         assert!(updates.update_fail_malformed_htlcs.is_empty());
2781         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2782
2783         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2784         check_closed_broadcast!(nodes[2], false);
2785         check_added_monitors!(nodes[2], 1);
2786         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)
2787         assert_eq!(node_txn.len(), 5);
2788         assert_eq!(node_txn[0], node_txn[3]);
2789         assert_eq!(node_txn[1], node_txn[4]);
2790         assert_eq!(node_txn[2], commitment_tx[0]);
2791         check_spends!(node_txn[0], commitment_tx[0]);
2792         check_spends!(node_txn[1], commitment_tx[0]);
2793         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2794         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2795         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2796         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2797         assert_eq!(node_txn[0].lock_time, 0);
2798         assert_eq!(node_txn[1].lock_time, 0);
2799
2800         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2801         connect_block(&nodes[1], &Block { header, txdata: node_txn}, 1);
2802         {
2803                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2804                 assert_eq!(added_monitors.len(), 1);
2805                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2806                 added_monitors.clear();
2807         }
2808         let events = nodes[1].node.get_and_clear_pending_msg_events();
2809         {
2810                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2811                 assert_eq!(added_monitors.len(), 2);
2812                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2813                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2814                 added_monitors.clear();
2815         }
2816         assert_eq!(events.len(), 2);
2817         match events[0] {
2818                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2819                 _ => panic!("Unexpected event"),
2820         }
2821         match events[1] {
2822                 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, .. } } => {
2823                         assert!(update_add_htlcs.is_empty());
2824                         assert!(update_fail_htlcs.is_empty());
2825                         assert_eq!(update_fulfill_htlcs.len(), 1);
2826                         assert!(update_fail_malformed_htlcs.is_empty());
2827                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2828                 },
2829                 _ => panic!("Unexpected event"),
2830         };
2831         macro_rules! check_tx_local_broadcast {
2832                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2833                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2834                         assert_eq!(node_txn.len(), 5);
2835                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2836                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2837                         check_spends!(node_txn[0], $commitment_tx);
2838                         check_spends!(node_txn[1], $commitment_tx);
2839                         assert_ne!(node_txn[0].lock_time, 0);
2840                         assert_ne!(node_txn[1].lock_time, 0);
2841                         if $htlc_offered {
2842                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2844                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2846                         } else {
2847                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2849                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2850                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2851                         }
2852                         check_spends!(node_txn[2], $chan_tx);
2853                         check_spends!(node_txn[3], node_txn[2]);
2854                         check_spends!(node_txn[4], node_txn[2]);
2855                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2856                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2857                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2858                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2859                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2860                         assert_ne!(node_txn[3].lock_time, 0);
2861                         assert_ne!(node_txn[4].lock_time, 0);
2862                         node_txn.clear();
2863                 } }
2864         }
2865         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2866         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2867         // timeout-claim of the output that nodes[2] just claimed via success.
2868         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2869
2870         // Broadcast legit commitment tx from A on B's chain
2871         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2872         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2873         check_spends!(commitment_tx[0], chan_1.3);
2874         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2875         check_closed_broadcast!(nodes[1], false);
2876         check_added_monitors!(nodes[1], 1);
2877         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2878         assert_eq!(node_txn.len(), 4);
2879         check_spends!(node_txn[0], commitment_tx[0]);
2880         assert_eq!(node_txn[0].input.len(), 2);
2881         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2882         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2883         assert_eq!(node_txn[0].lock_time, 0);
2884         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2885         check_spends!(node_txn[1], chan_1.3);
2886         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2887         check_spends!(node_txn[2], node_txn[1]);
2888         check_spends!(node_txn[3], node_txn[1]);
2889         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2890         // we already checked the same situation with A.
2891
2892         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2893         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2894         check_closed_broadcast!(nodes[0], false);
2895         check_added_monitors!(nodes[0], 1);
2896         let events = nodes[0].node.get_and_clear_pending_events();
2897         assert_eq!(events.len(), 2);
2898         let mut first_claimed = false;
2899         for event in events {
2900                 match event {
2901                         Event::PaymentSent { payment_preimage } => {
2902                                 if payment_preimage == our_payment_preimage {
2903                                         assert!(!first_claimed);
2904                                         first_claimed = true;
2905                                 } else {
2906                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2907                                 }
2908                         },
2909                         _ => panic!("Unexpected event"),
2910                 }
2911         }
2912         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2913 }
2914
2915 #[test]
2916 fn test_htlc_on_chain_timeout() {
2917         // Test that in case of a unilateral close onchain, we detect the state of output and
2918         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2919         // broadcasting the right event to other nodes in payment path.
2920         // A ------------------> B ----------------------> C (timeout)
2921         //    B's commitment tx                 C's commitment tx
2922         //            \                                  \
2923         //         B's HTLC timeout tx               B's timeout tx
2924
2925         let chanmon_cfgs = create_chanmon_cfgs(3);
2926         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2927         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2928         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2929
2930         // Create some intial channels
2931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2932         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2933
2934         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2935         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2936         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2937
2938         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2939         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2940
2941         // Broadcast legit commitment tx from C on B's chain
2942         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2943         check_spends!(commitment_tx[0], chan_2.3);
2944         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2945         check_added_monitors!(nodes[2], 0);
2946         expect_pending_htlcs_forwardable!(nodes[2]);
2947         check_added_monitors!(nodes[2], 1);
2948
2949         let events = nodes[2].node.get_and_clear_pending_msg_events();
2950         assert_eq!(events.len(), 1);
2951         match events[0] {
2952                 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, .. } } => {
2953                         assert!(update_add_htlcs.is_empty());
2954                         assert!(!update_fail_htlcs.is_empty());
2955                         assert!(update_fulfill_htlcs.is_empty());
2956                         assert!(update_fail_malformed_htlcs.is_empty());
2957                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2958                 },
2959                 _ => panic!("Unexpected event"),
2960         };
2961         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2962         check_closed_broadcast!(nodes[2], false);
2963         check_added_monitors!(nodes[2], 1);
2964         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2965         assert_eq!(node_txn.len(), 1);
2966         check_spends!(node_txn[0], chan_2.3);
2967         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2968
2969         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2970         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2971         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2972         let timeout_tx;
2973         {
2974                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2975                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2976                 assert_eq!(node_txn[1], node_txn[3]);
2977                 assert_eq!(node_txn[2], node_txn[4]);
2978
2979                 check_spends!(node_txn[0], commitment_tx[0]);
2980                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2981
2982                 check_spends!(node_txn[1], chan_2.3);
2983                 check_spends!(node_txn[2], node_txn[1]);
2984                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2985                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2986
2987                 timeout_tx = node_txn[0].clone();
2988                 node_txn.clear();
2989         }
2990
2991         connect_block(&nodes[1], &Block { header, txdata: vec![timeout_tx]}, 1);
2992         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2993         check_added_monitors!(nodes[1], 1);
2994         check_closed_broadcast!(nodes[1], false);
2995
2996         expect_pending_htlcs_forwardable!(nodes[1]);
2997         check_added_monitors!(nodes[1], 1);
2998         let events = nodes[1].node.get_and_clear_pending_msg_events();
2999         assert_eq!(events.len(), 1);
3000         match events[0] {
3001                 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, .. } } => {
3002                         assert!(update_add_htlcs.is_empty());
3003                         assert!(!update_fail_htlcs.is_empty());
3004                         assert!(update_fulfill_htlcs.is_empty());
3005                         assert!(update_fail_malformed_htlcs.is_empty());
3006                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3007                 },
3008                 _ => panic!("Unexpected event"),
3009         };
3010         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
3011         assert_eq!(node_txn.len(), 0);
3012
3013         // Broadcast legit commitment tx from B on A's chain
3014         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3015         check_spends!(commitment_tx[0], chan_1.3);
3016
3017         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3018         check_closed_broadcast!(nodes[0], false);
3019         check_added_monitors!(nodes[0], 1);
3020         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3021         assert_eq!(node_txn.len(), 3);
3022         check_spends!(node_txn[0], commitment_tx[0]);
3023         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3024         check_spends!(node_txn[1], chan_1.3);
3025         check_spends!(node_txn[2], node_txn[1]);
3026         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3027         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3028 }
3029
3030 #[test]
3031 fn test_simple_commitment_revoked_fail_backward() {
3032         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3033         // and fail backward accordingly.
3034
3035         let chanmon_cfgs = create_chanmon_cfgs(3);
3036         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3037         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3038         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3039
3040         // Create some initial channels
3041         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3042         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3043
3044         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3045         // Get the will-be-revoked local txn from nodes[2]
3046         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3047         // Revoke the old state
3048         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3049
3050         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3051
3052         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3053         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3054         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3055         check_added_monitors!(nodes[1], 1);
3056         check_closed_broadcast!(nodes[1], false);
3057
3058         expect_pending_htlcs_forwardable!(nodes[1]);
3059         check_added_monitors!(nodes[1], 1);
3060         let events = nodes[1].node.get_and_clear_pending_msg_events();
3061         assert_eq!(events.len(), 1);
3062         match events[0] {
3063                 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, .. } } => {
3064                         assert!(update_add_htlcs.is_empty());
3065                         assert_eq!(update_fail_htlcs.len(), 1);
3066                         assert!(update_fulfill_htlcs.is_empty());
3067                         assert!(update_fail_malformed_htlcs.is_empty());
3068                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3069
3070                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3071                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3072
3073                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3074                         assert_eq!(events.len(), 1);
3075                         match events[0] {
3076                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3077                                 _ => panic!("Unexpected event"),
3078                         }
3079                         expect_payment_failed!(nodes[0], payment_hash, false);
3080                 },
3081                 _ => panic!("Unexpected event"),
3082         }
3083 }
3084
3085 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3086         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3087         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3088         // commitment transaction anymore.
3089         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3090         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3091         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3092         // technically disallowed and we should probably handle it reasonably.
3093         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3094         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3095         // transactions:
3096         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3097         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3098         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3099         //   and once they revoke the previous commitment transaction (allowing us to send a new
3100         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3101         let chanmon_cfgs = create_chanmon_cfgs(3);
3102         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3103         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3104         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3105
3106         // Create some initial channels
3107         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3108         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3109
3110         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3111         // Get the will-be-revoked local txn from nodes[2]
3112         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3113         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3114         // Revoke the old state
3115         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3116
3117         let value = if use_dust {
3118                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3119                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3120                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3121         } else { 3000000 };
3122
3123         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3124         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3125         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3126
3127         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3128         expect_pending_htlcs_forwardable!(nodes[2]);
3129         check_added_monitors!(nodes[2], 1);
3130         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3131         assert!(updates.update_add_htlcs.is_empty());
3132         assert!(updates.update_fulfill_htlcs.is_empty());
3133         assert!(updates.update_fail_malformed_htlcs.is_empty());
3134         assert_eq!(updates.update_fail_htlcs.len(), 1);
3135         assert!(updates.update_fee.is_none());
3136         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3137         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3138         // Drop the last RAA from 3 -> 2
3139
3140         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3141         expect_pending_htlcs_forwardable!(nodes[2]);
3142         check_added_monitors!(nodes[2], 1);
3143         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3144         assert!(updates.update_add_htlcs.is_empty());
3145         assert!(updates.update_fulfill_htlcs.is_empty());
3146         assert!(updates.update_fail_malformed_htlcs.is_empty());
3147         assert_eq!(updates.update_fail_htlcs.len(), 1);
3148         assert!(updates.update_fee.is_none());
3149         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3150         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3151         check_added_monitors!(nodes[1], 1);
3152         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3153         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3154         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3155         check_added_monitors!(nodes[2], 1);
3156
3157         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3158         expect_pending_htlcs_forwardable!(nodes[2]);
3159         check_added_monitors!(nodes[2], 1);
3160         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3161         assert!(updates.update_add_htlcs.is_empty());
3162         assert!(updates.update_fulfill_htlcs.is_empty());
3163         assert!(updates.update_fail_malformed_htlcs.is_empty());
3164         assert_eq!(updates.update_fail_htlcs.len(), 1);
3165         assert!(updates.update_fee.is_none());
3166         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3167         // At this point first_payment_hash has dropped out of the latest two commitment
3168         // transactions that nodes[1] is tracking...
3169         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3170         check_added_monitors!(nodes[1], 1);
3171         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3172         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3173         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3174         check_added_monitors!(nodes[2], 1);
3175
3176         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3177         // on nodes[2]'s RAA.
3178         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3179         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3180         let logger = test_utils::TestLogger::new();
3181         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();
3182         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3183         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3184         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3185         check_added_monitors!(nodes[1], 0);
3186
3187         if deliver_bs_raa {
3188                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3189                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3190                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3191                 check_added_monitors!(nodes[1], 1);
3192                 let events = nodes[1].node.get_and_clear_pending_events();
3193                 assert_eq!(events.len(), 1);
3194                 match events[0] {
3195                         Event::PendingHTLCsForwardable { .. } => { },
3196                         _ => panic!("Unexpected event"),
3197                 };
3198                 // Deliberately don't process the pending fail-back so they all fail back at once after
3199                 // block connection just like the !deliver_bs_raa case
3200         }
3201
3202         let mut failed_htlcs = HashSet::new();
3203         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3204
3205         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3206         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3207         check_added_monitors!(nodes[1], 1);
3208         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3209
3210         let events = nodes[1].node.get_and_clear_pending_events();
3211         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3212         match events[0] {
3213                 Event::PaymentFailed { ref payment_hash, .. } => {
3214                         assert_eq!(*payment_hash, fourth_payment_hash);
3215                 },
3216                 _ => panic!("Unexpected event"),
3217         }
3218         if !deliver_bs_raa {
3219                 match events[1] {
3220                         Event::PendingHTLCsForwardable { .. } => { },
3221                         _ => panic!("Unexpected event"),
3222                 };
3223         }
3224         nodes[1].node.process_pending_htlc_forwards();
3225         check_added_monitors!(nodes[1], 1);
3226
3227         let events = nodes[1].node.get_and_clear_pending_msg_events();
3228         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3229         match events[if deliver_bs_raa { 1 } else { 0 }] {
3230                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3231                 _ => panic!("Unexpected event"),
3232         }
3233         if deliver_bs_raa {
3234                 match events[0] {
3235                         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, .. } } => {
3236                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3237                                 assert_eq!(update_add_htlcs.len(), 1);
3238                                 assert!(update_fulfill_htlcs.is_empty());
3239                                 assert!(update_fail_htlcs.is_empty());
3240                                 assert!(update_fail_malformed_htlcs.is_empty());
3241                         },
3242                         _ => panic!("Unexpected event"),
3243                 }
3244         }
3245         match events[if deliver_bs_raa { 2 } else { 1 }] {
3246                 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, .. } } => {
3247                         assert!(update_add_htlcs.is_empty());
3248                         assert_eq!(update_fail_htlcs.len(), 3);
3249                         assert!(update_fulfill_htlcs.is_empty());
3250                         assert!(update_fail_malformed_htlcs.is_empty());
3251                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3252
3253                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3254                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3255                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3256
3257                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3258
3259                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3260                         // If we delivered B's RAA we got an unknown preimage error, not something
3261                         // that we should update our routing table for.
3262                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3263                         for event in events {
3264                                 match event {
3265                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3266                                         _ => panic!("Unexpected event"),
3267                                 }
3268                         }
3269                         let events = nodes[0].node.get_and_clear_pending_events();
3270                         assert_eq!(events.len(), 3);
3271                         match events[0] {
3272                                 Event::PaymentFailed { ref payment_hash, .. } => {
3273                                         assert!(failed_htlcs.insert(payment_hash.0));
3274                                 },
3275                                 _ => panic!("Unexpected event"),
3276                         }
3277                         match events[1] {
3278                                 Event::PaymentFailed { ref payment_hash, .. } => {
3279                                         assert!(failed_htlcs.insert(payment_hash.0));
3280                                 },
3281                                 _ => panic!("Unexpected event"),
3282                         }
3283                         match events[2] {
3284                                 Event::PaymentFailed { ref payment_hash, .. } => {
3285                                         assert!(failed_htlcs.insert(payment_hash.0));
3286                                 },
3287                                 _ => panic!("Unexpected event"),
3288                         }
3289                 },
3290                 _ => panic!("Unexpected event"),
3291         }
3292
3293         assert!(failed_htlcs.contains(&first_payment_hash.0));
3294         assert!(failed_htlcs.contains(&second_payment_hash.0));
3295         assert!(failed_htlcs.contains(&third_payment_hash.0));
3296 }
3297
3298 #[test]
3299 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3300         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3301         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3302         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3303         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3304 }
3305
3306 #[test]
3307 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3308         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3309         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3310         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3311         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3312 }
3313
3314 #[test]
3315 fn fail_backward_pending_htlc_upon_channel_failure() {
3316         let chanmon_cfgs = create_chanmon_cfgs(2);
3317         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3318         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3319         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3320         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3321         let logger = test_utils::TestLogger::new();
3322
3323         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3324         {
3325                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3326                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3327                 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();
3328                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3329                 check_added_monitors!(nodes[0], 1);
3330
3331                 let payment_event = {
3332                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3333                         assert_eq!(events.len(), 1);
3334                         SendEvent::from_event(events.remove(0))
3335                 };
3336                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3337                 assert_eq!(payment_event.msgs.len(), 1);
3338         }
3339
3340         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3341         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3342         {
3343                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3344                 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();
3345                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3346                 check_added_monitors!(nodes[0], 0);
3347
3348                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3349         }
3350
3351         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3352         {
3353                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3354
3355                 let secp_ctx = Secp256k1::new();
3356                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3357                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3358                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3359                 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();
3360                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3361                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3362                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3363
3364                 // Send a 0-msat update_add_htlc to fail the channel.
3365                 let update_add_htlc = msgs::UpdateAddHTLC {
3366                         channel_id: chan.2,
3367                         htlc_id: 0,
3368                         amount_msat: 0,
3369                         payment_hash,
3370                         cltv_expiry,
3371                         onion_routing_packet,
3372                 };
3373                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3374         }
3375
3376         // Check that Alice fails backward the pending HTLC from the second payment.
3377         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3378         check_closed_broadcast!(nodes[0], true);
3379         check_added_monitors!(nodes[0], 1);
3380 }
3381
3382 #[test]
3383 fn test_htlc_ignore_latest_remote_commitment() {
3384         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3385         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3386         let chanmon_cfgs = create_chanmon_cfgs(2);
3387         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3388         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3389         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3390         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3391
3392         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3393         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3394         check_closed_broadcast!(nodes[0], false);
3395         check_added_monitors!(nodes[0], 1);
3396
3397         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3398         assert_eq!(node_txn.len(), 2);
3399
3400         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3401         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3402         check_closed_broadcast!(nodes[1], false);
3403         check_added_monitors!(nodes[1], 1);
3404
3405         // Duplicate the block_connected call since this may happen due to other listeners
3406         // registering new transactions
3407         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3408 }
3409
3410 #[test]
3411 fn test_force_close_fail_back() {
3412         // Check which HTLCs are failed-backwards on channel force-closure
3413         let chanmon_cfgs = create_chanmon_cfgs(3);
3414         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3415         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3416         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3417         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3418         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3419         let logger = test_utils::TestLogger::new();
3420
3421         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3422
3423         let mut payment_event = {
3424                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3425                 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();
3426                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3427                 check_added_monitors!(nodes[0], 1);
3428
3429                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3430                 assert_eq!(events.len(), 1);
3431                 SendEvent::from_event(events.remove(0))
3432         };
3433
3434         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3435         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3436
3437         expect_pending_htlcs_forwardable!(nodes[1]);
3438
3439         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3440         assert_eq!(events_2.len(), 1);
3441         payment_event = SendEvent::from_event(events_2.remove(0));
3442         assert_eq!(payment_event.msgs.len(), 1);
3443
3444         check_added_monitors!(nodes[1], 1);
3445         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3446         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3447         check_added_monitors!(nodes[2], 1);
3448         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3449
3450         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3451         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3452         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3453
3454         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3455         check_closed_broadcast!(nodes[2], false);
3456         check_added_monitors!(nodes[2], 1);
3457         let tx = {
3458                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3459                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3460                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3461                 // back to nodes[1] upon timeout otherwise.
3462                 assert_eq!(node_txn.len(), 1);
3463                 node_txn.remove(0)
3464         };
3465
3466         let block = Block {
3467                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3468                 txdata: vec![tx.clone()],
3469         };
3470         connect_block(&nodes[1], &block, 1);
3471
3472         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3473         check_closed_broadcast!(nodes[1], false);
3474         check_added_monitors!(nodes[1], 1);
3475
3476         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3477         {
3478                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3479                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3480                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3481         }
3482         connect_block(&nodes[2], &block, 1);
3483         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3484         assert_eq!(node_txn.len(), 1);
3485         assert_eq!(node_txn[0].input.len(), 1);
3486         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3487         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3488         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3489
3490         check_spends!(node_txn[0], tx);
3491 }
3492
3493 #[test]
3494 fn test_unconf_chan() {
3495         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3496         let chanmon_cfgs = create_chanmon_cfgs(2);
3497         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3498         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3499         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3500         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3501
3502         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3503         assert_eq!(channel_state.by_id.len(), 1);
3504         assert_eq!(channel_state.short_to_id.len(), 1);
3505         mem::drop(channel_state);
3506
3507         let mut headers = Vec::new();
3508         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3509         headers.push(header.clone());
3510         for _i in 2..100 {
3511                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3512                 headers.push(header.clone());
3513         }
3514         let mut height = 99;
3515         while !headers.is_empty() {
3516                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3517                 height -= 1;
3518         }
3519         check_closed_broadcast!(nodes[0], false);
3520         check_added_monitors!(nodes[0], 1);
3521         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3522         assert_eq!(channel_state.by_id.len(), 0);
3523         assert_eq!(channel_state.short_to_id.len(), 0);
3524 }
3525
3526 #[test]
3527 fn test_simple_peer_disconnect() {
3528         // Test that we can reconnect when there are no lost messages
3529         let chanmon_cfgs = create_chanmon_cfgs(3);
3530         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3531         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3532         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3533         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3534         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
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         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3539
3540         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3541         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3542         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3543         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3544
3545         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3546         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3547         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3548
3549         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3550         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3551         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3552         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3553
3554         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3555         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3556
3557         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3558         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3559
3560         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3561         {
3562                 let events = nodes[0].node.get_and_clear_pending_events();
3563                 assert_eq!(events.len(), 2);
3564                 match events[0] {
3565                         Event::PaymentSent { payment_preimage } => {
3566                                 assert_eq!(payment_preimage, payment_preimage_3);
3567                         },
3568                         _ => panic!("Unexpected event"),
3569                 }
3570                 match events[1] {
3571                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3572                                 assert_eq!(payment_hash, payment_hash_5);
3573                                 assert!(rejected_by_dest);
3574                         },
3575                         _ => panic!("Unexpected event"),
3576                 }
3577         }
3578
3579         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3580         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3581 }
3582
3583 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3584         // Test that we can reconnect when in-flight HTLC updates get dropped
3585         let chanmon_cfgs = create_chanmon_cfgs(2);
3586         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3587         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3588         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3589         if messages_delivered == 0 {
3590                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3591                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3592         } else {
3593                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3594         }
3595
3596         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3597
3598         let logger = test_utils::TestLogger::new();
3599         let payment_event = {
3600                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3601                 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();
3602                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3603                 check_added_monitors!(nodes[0], 1);
3604
3605                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3606                 assert_eq!(events.len(), 1);
3607                 SendEvent::from_event(events.remove(0))
3608         };
3609         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3610
3611         if messages_delivered < 2 {
3612                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3613         } else {
3614                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3615                 if messages_delivered >= 3 {
3616                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3617                         check_added_monitors!(nodes[1], 1);
3618                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3619
3620                         if messages_delivered >= 4 {
3621                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3622                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3623                                 check_added_monitors!(nodes[0], 1);
3624
3625                                 if messages_delivered >= 5 {
3626                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3627                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3628                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3629                                         check_added_monitors!(nodes[0], 1);
3630
3631                                         if messages_delivered >= 6 {
3632                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3633                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3634                                                 check_added_monitors!(nodes[1], 1);
3635                                         }
3636                                 }
3637                         }
3638                 }
3639         }
3640
3641         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3642         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3643         if messages_delivered < 3 {
3644                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3645                 // received on either side, both sides will need to resend them.
3646                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3647         } else if messages_delivered == 3 {
3648                 // nodes[0] still wants its RAA + commitment_signed
3649                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3650         } else if messages_delivered == 4 {
3651                 // nodes[0] still wants its commitment_signed
3652                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3653         } else if messages_delivered == 5 {
3654                 // nodes[1] still wants its final RAA
3655                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3656         } else if messages_delivered == 6 {
3657                 // Everything was delivered...
3658                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3659         }
3660
3661         let events_1 = nodes[1].node.get_and_clear_pending_events();
3662         assert_eq!(events_1.len(), 1);
3663         match events_1[0] {
3664                 Event::PendingHTLCsForwardable { .. } => { },
3665                 _ => panic!("Unexpected event"),
3666         };
3667
3668         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3669         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3670         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3671
3672         nodes[1].node.process_pending_htlc_forwards();
3673
3674         let events_2 = nodes[1].node.get_and_clear_pending_events();
3675         assert_eq!(events_2.len(), 1);
3676         match events_2[0] {
3677                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3678                         assert_eq!(payment_hash_1, *payment_hash);
3679                         assert_eq!(*payment_secret, None);
3680                         assert_eq!(amt, 1000000);
3681                 },
3682                 _ => panic!("Unexpected event"),
3683         }
3684
3685         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3686         check_added_monitors!(nodes[1], 1);
3687
3688         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3689         assert_eq!(events_3.len(), 1);
3690         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3691                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3692                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3693                         assert!(updates.update_add_htlcs.is_empty());
3694                         assert!(updates.update_fail_htlcs.is_empty());
3695                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3696                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3697                         assert!(updates.update_fee.is_none());
3698                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3699                 },
3700                 _ => panic!("Unexpected event"),
3701         };
3702
3703         if messages_delivered >= 1 {
3704                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3705
3706                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3707                 assert_eq!(events_4.len(), 1);
3708                 match events_4[0] {
3709                         Event::PaymentSent { ref payment_preimage } => {
3710                                 assert_eq!(payment_preimage_1, *payment_preimage);
3711                         },
3712                         _ => panic!("Unexpected event"),
3713                 }
3714
3715                 if messages_delivered >= 2 {
3716                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3717                         check_added_monitors!(nodes[0], 1);
3718                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3719
3720                         if messages_delivered >= 3 {
3721                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3722                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3723                                 check_added_monitors!(nodes[1], 1);
3724
3725                                 if messages_delivered >= 4 {
3726                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3727                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3728                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3729                                         check_added_monitors!(nodes[1], 1);
3730
3731                                         if messages_delivered >= 5 {
3732                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3733                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3734                                                 check_added_monitors!(nodes[0], 1);
3735                                         }
3736                                 }
3737                         }
3738                 }
3739         }
3740
3741         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3742         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3743         if messages_delivered < 2 {
3744                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3745                 //TODO: Deduplicate PaymentSent events, then enable this if:
3746                 //if messages_delivered < 1 {
3747                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3748                         assert_eq!(events_4.len(), 1);
3749                         match events_4[0] {
3750                                 Event::PaymentSent { ref payment_preimage } => {
3751                                         assert_eq!(payment_preimage_1, *payment_preimage);
3752                                 },
3753                                 _ => panic!("Unexpected event"),
3754                         }
3755                 //}
3756         } else if messages_delivered == 2 {
3757                 // nodes[0] still wants its RAA + commitment_signed
3758                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3759         } else if messages_delivered == 3 {
3760                 // nodes[0] still wants its commitment_signed
3761                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3762         } else if messages_delivered == 4 {
3763                 // nodes[1] still wants its final RAA
3764                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3765         } else if messages_delivered == 5 {
3766                 // Everything was delivered...
3767                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3768         }
3769
3770         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3771         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3772         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3773
3774         // Channel should still work fine...
3775         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3776         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();
3777         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3778         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3779 }
3780
3781 #[test]
3782 fn test_drop_messages_peer_disconnect_a() {
3783         do_test_drop_messages_peer_disconnect(0);
3784         do_test_drop_messages_peer_disconnect(1);
3785         do_test_drop_messages_peer_disconnect(2);
3786         do_test_drop_messages_peer_disconnect(3);
3787 }
3788
3789 #[test]
3790 fn test_drop_messages_peer_disconnect_b() {
3791         do_test_drop_messages_peer_disconnect(4);
3792         do_test_drop_messages_peer_disconnect(5);
3793         do_test_drop_messages_peer_disconnect(6);
3794 }
3795
3796 #[test]
3797 fn test_funding_peer_disconnect() {
3798         // Test that we can lock in our funding tx while disconnected
3799         let chanmon_cfgs = create_chanmon_cfgs(2);
3800         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3801         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3802         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3803         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3804
3805         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3806         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3807
3808         confirm_transaction(&nodes[0], &tx);
3809         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3810         assert_eq!(events_1.len(), 1);
3811         match events_1[0] {
3812                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3813                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3814                 },
3815                 _ => panic!("Unexpected event"),
3816         }
3817
3818         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3819
3820         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3821         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3822
3823         confirm_transaction(&nodes[1], &tx);
3824         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3825         assert_eq!(events_2.len(), 2);
3826         let funding_locked = match events_2[0] {
3827                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3828                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3829                         msg.clone()
3830                 },
3831                 _ => panic!("Unexpected event"),
3832         };
3833         let bs_announcement_sigs = match events_2[1] {
3834                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3835                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3836                         msg.clone()
3837                 },
3838                 _ => panic!("Unexpected event"),
3839         };
3840
3841         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3842
3843         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3844         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3845         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3846         assert_eq!(events_3.len(), 2);
3847         let as_announcement_sigs = match events_3[0] {
3848                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3849                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3850                         msg.clone()
3851                 },
3852                 _ => panic!("Unexpected event"),
3853         };
3854         let (as_announcement, as_update) = match events_3[1] {
3855                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3856                         (msg.clone(), update_msg.clone())
3857                 },
3858                 _ => panic!("Unexpected event"),
3859         };
3860
3861         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3862         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3863         assert_eq!(events_4.len(), 1);
3864         let (_, bs_update) = match events_4[0] {
3865                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3866                         (msg.clone(), update_msg.clone())
3867                 },
3868                 _ => panic!("Unexpected event"),
3869         };
3870
3871         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3872         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3873         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3874
3875         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3876         let logger = test_utils::TestLogger::new();
3877         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();
3878         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3879         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3880 }
3881
3882 #[test]
3883 fn test_drop_messages_peer_disconnect_dual_htlc() {
3884         // Test that we can handle reconnecting when both sides of a channel have pending
3885         // commitment_updates when we disconnect.
3886         let chanmon_cfgs = create_chanmon_cfgs(2);
3887         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3888         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3889         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3890         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3891         let logger = test_utils::TestLogger::new();
3892
3893         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3894
3895         // Now try to send a second payment which will fail to send
3896         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3897         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3898         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();
3899         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3900         check_added_monitors!(nodes[0], 1);
3901
3902         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3903         assert_eq!(events_1.len(), 1);
3904         match events_1[0] {
3905                 MessageSendEvent::UpdateHTLCs { .. } => {},
3906                 _ => panic!("Unexpected event"),
3907         }
3908
3909         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3910         check_added_monitors!(nodes[1], 1);
3911
3912         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3913         assert_eq!(events_2.len(), 1);
3914         match events_2[0] {
3915                 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 } } => {
3916                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3917                         assert!(update_add_htlcs.is_empty());
3918                         assert_eq!(update_fulfill_htlcs.len(), 1);
3919                         assert!(update_fail_htlcs.is_empty());
3920                         assert!(update_fail_malformed_htlcs.is_empty());
3921                         assert!(update_fee.is_none());
3922
3923                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3924                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3925                         assert_eq!(events_3.len(), 1);
3926                         match events_3[0] {
3927                                 Event::PaymentSent { ref payment_preimage } => {
3928                                         assert_eq!(*payment_preimage, payment_preimage_1);
3929                                 },
3930                                 _ => panic!("Unexpected event"),
3931                         }
3932
3933                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3934                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3935                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3936                         check_added_monitors!(nodes[0], 1);
3937                 },
3938                 _ => panic!("Unexpected event"),
3939         }
3940
3941         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3942         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3943
3944         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3945         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3946         assert_eq!(reestablish_1.len(), 1);
3947         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3948         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3949         assert_eq!(reestablish_2.len(), 1);
3950
3951         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3952         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3953         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3954         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3955
3956         assert!(as_resp.0.is_none());
3957         assert!(bs_resp.0.is_none());
3958
3959         assert!(bs_resp.1.is_none());
3960         assert!(bs_resp.2.is_none());
3961
3962         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3963
3964         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3965         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3966         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3967         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3968         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3969         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3970         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3971         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3972         // No commitment_signed so get_event_msg's assert(len == 1) passes
3973         check_added_monitors!(nodes[1], 1);
3974
3975         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3976         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3977         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3978         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3979         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3980         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3981         assert!(bs_second_commitment_signed.update_fee.is_none());
3982         check_added_monitors!(nodes[1], 1);
3983
3984         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3985         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3986         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3987         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3988         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3989         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3990         assert!(as_commitment_signed.update_fee.is_none());
3991         check_added_monitors!(nodes[0], 1);
3992
3993         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3994         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3995         // No commitment_signed so get_event_msg's assert(len == 1) passes
3996         check_added_monitors!(nodes[0], 1);
3997
3998         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3999         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4000         // No commitment_signed so get_event_msg's assert(len == 1) passes
4001         check_added_monitors!(nodes[1], 1);
4002
4003         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4004         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4005         check_added_monitors!(nodes[1], 1);
4006
4007         expect_pending_htlcs_forwardable!(nodes[1]);
4008
4009         let events_5 = nodes[1].node.get_and_clear_pending_events();
4010         assert_eq!(events_5.len(), 1);
4011         match events_5[0] {
4012                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4013                         assert_eq!(payment_hash_2, *payment_hash);
4014                         assert_eq!(*payment_secret, None);
4015                 },
4016                 _ => panic!("Unexpected event"),
4017         }
4018
4019         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4020         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4021         check_added_monitors!(nodes[0], 1);
4022
4023         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4024 }
4025
4026 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4027         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4028         // to avoid our counterparty failing the channel.
4029         let chanmon_cfgs = create_chanmon_cfgs(2);
4030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4032         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4033
4034         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4035         let logger = test_utils::TestLogger::new();
4036
4037         let our_payment_hash = if send_partial_mpp {
4038                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4039                 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();
4040                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4041                 let payment_secret = PaymentSecret([0xdb; 32]);
4042                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4043                 // indicates there are more HTLCs coming.
4044                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4045                 check_added_monitors!(nodes[0], 1);
4046                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4047                 assert_eq!(events.len(), 1);
4048                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4049                 // hop should *not* yet generate any PaymentReceived event(s).
4050                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4051                 our_payment_hash
4052         } else {
4053                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4054         };
4055
4056         let mut block = Block {
4057                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4058                 txdata: vec![],
4059         };
4060         connect_block(&nodes[0], &block, 101);
4061         connect_block(&nodes[1], &block, 101);
4062         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4063                 block.header.prev_blockhash = block.bitcoin_hash();
4064                 connect_block(&nodes[0], &block, i);
4065                 connect_block(&nodes[1], &block, i);
4066         }
4067
4068         expect_pending_htlcs_forwardable!(nodes[1]);
4069
4070         check_added_monitors!(nodes[1], 1);
4071         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4072         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4073         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4074         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4075         assert!(htlc_timeout_updates.update_fee.is_none());
4076
4077         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4078         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4079         // 100_000 msat as u64, followed by a height of 123 as u32
4080         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4081         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4082         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4083 }
4084
4085 #[test]
4086 fn test_htlc_timeout() {
4087         do_test_htlc_timeout(true);
4088         do_test_htlc_timeout(false);
4089 }
4090
4091 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4092         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4093         let chanmon_cfgs = create_chanmon_cfgs(3);
4094         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4095         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4096         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4097         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4098         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4099         let logger = test_utils::TestLogger::new();
4100
4101         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4102         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4103         {
4104                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4105                 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();
4106                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4107         }
4108         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4109         check_added_monitors!(nodes[1], 1);
4110
4111         // Now attempt to route a second payment, which should be placed in the holding cell
4112         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4113         if forwarded_htlc {
4114                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4115                 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();
4116                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4117                 check_added_monitors!(nodes[0], 1);
4118                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4119                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4120                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4121                 expect_pending_htlcs_forwardable!(nodes[1]);
4122                 check_added_monitors!(nodes[1], 0);
4123         } else {
4124                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4125                 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();
4126                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4127                 check_added_monitors!(nodes[1], 0);
4128         }
4129
4130         let mut block = Block {
4131                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4132                 txdata: vec![],
4133         };
4134         connect_block(&nodes[1], &block, 101);
4135         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4136                 block.header.prev_blockhash = block.bitcoin_hash();
4137                 connect_block(&nodes[1], &block, i);
4138         }
4139
4140         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4141         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4142
4143         block.header.prev_blockhash = block.bitcoin_hash();
4144         connect_block(&nodes[1], &block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4145
4146         if forwarded_htlc {
4147                 expect_pending_htlcs_forwardable!(nodes[1]);
4148                 check_added_monitors!(nodes[1], 1);
4149                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4150                 assert_eq!(fail_commit.len(), 1);
4151                 match fail_commit[0] {
4152                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4153                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4154                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4155                         },
4156                         _ => unreachable!(),
4157                 }
4158                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4159                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4160                         match update {
4161                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4162                                 _ => panic!("Unexpected event"),
4163                         }
4164                 } else {
4165                         panic!("Unexpected event");
4166                 }
4167         } else {
4168                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4169         }
4170 }
4171
4172 #[test]
4173 fn test_holding_cell_htlc_add_timeouts() {
4174         do_test_holding_cell_htlc_add_timeouts(false);
4175         do_test_holding_cell_htlc_add_timeouts(true);
4176 }
4177
4178 #[test]
4179 fn test_invalid_channel_announcement() {
4180         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4181         let secp_ctx = Secp256k1::new();
4182         let chanmon_cfgs = create_chanmon_cfgs(2);
4183         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4184         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4185         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4186
4187         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4188
4189         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4190         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4191         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4192         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4193
4194         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 } );
4195
4196         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4197         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4198
4199         let as_network_key = nodes[0].node.get_our_node_id();
4200         let bs_network_key = nodes[1].node.get_our_node_id();
4201
4202         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4203
4204         let mut chan_announcement;
4205
4206         macro_rules! dummy_unsigned_msg {
4207                 () => {
4208                         msgs::UnsignedChannelAnnouncement {
4209                                 features: ChannelFeatures::known(),
4210                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4211                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4212                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4213                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4214                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4215                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4216                                 excess_data: Vec::new(),
4217                         };
4218                 }
4219         }
4220
4221         macro_rules! sign_msg {
4222                 ($unsigned_msg: expr) => {
4223                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4224                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4225                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4226                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4227                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4228                         chan_announcement = msgs::ChannelAnnouncement {
4229                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4230                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4231                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4232                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4233                                 contents: $unsigned_msg
4234                         }
4235                 }
4236         }
4237
4238         let unsigned_msg = dummy_unsigned_msg!();
4239         sign_msg!(unsigned_msg);
4240         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4241         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 } );
4242
4243         // Configured with Network::Testnet
4244         let mut unsigned_msg = dummy_unsigned_msg!();
4245         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4246         sign_msg!(unsigned_msg);
4247         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4248
4249         let mut unsigned_msg = dummy_unsigned_msg!();
4250         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4251         sign_msg!(unsigned_msg);
4252         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4253 }
4254
4255 #[test]
4256 fn test_no_txn_manager_serialize_deserialize() {
4257         let chanmon_cfgs = create_chanmon_cfgs(2);
4258         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4259         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4260         let logger: test_utils::TestLogger;
4261         let fee_estimator: test_utils::TestFeeEstimator;
4262         let new_chan_monitor: test_utils::TestChannelMonitor;
4263         let keys_manager: test_utils::TestKeysInterface;
4264         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4265         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4266
4267         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4268
4269         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4270
4271         let nodes_0_serialized = nodes[0].node.encode();
4272         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4273         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4274
4275         logger = test_utils::TestLogger::new();
4276         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4277         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4278         nodes[0].chan_monitor = &new_chan_monitor;
4279         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4280         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4281         assert!(chan_0_monitor_read.is_empty());
4282
4283         let mut nodes_0_read = &nodes_0_serialized[..];
4284         let config = UserConfig::default();
4285         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4286         let (_, nodes_0_deserialized_tmp) = {
4287                 let mut channel_monitors = HashMap::new();
4288                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4289                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4290                         default_config: config,
4291                         keys_manager: &keys_manager,
4292                         fee_estimator: &fee_estimator,
4293                         monitor: nodes[0].chan_monitor,
4294                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4295                         logger: &logger,
4296                         channel_monitors: &mut channel_monitors,
4297                 }).unwrap()
4298         };
4299         nodes_0_deserialized = nodes_0_deserialized_tmp;
4300         assert!(nodes_0_read.is_empty());
4301
4302         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4303         nodes[0].node = &nodes_0_deserialized;
4304         nodes[0].block_notifier.register_listener(nodes[0].node);
4305         assert_eq!(nodes[0].node.list_channels().len(), 1);
4306         check_added_monitors!(nodes[0], 1);
4307
4308         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4309         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4310         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4311         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4312
4313         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4314         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4315         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4316         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4317
4318         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4319         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4320         for node in nodes.iter() {
4321                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4322                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4323                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4324         }
4325
4326         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4327 }
4328
4329 #[test]
4330 fn test_manager_serialize_deserialize_events() {
4331         // This test makes sure the events field in ChannelManager survives de/serialization
4332         let chanmon_cfgs = create_chanmon_cfgs(2);
4333         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4334         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4335         let fee_estimator: test_utils::TestFeeEstimator;
4336         let logger: test_utils::TestLogger;
4337         let new_chan_monitor: test_utils::TestChannelMonitor;
4338         let keys_manager: test_utils::TestKeysInterface;
4339         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4340         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4341
4342         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4343         let channel_value = 100000;
4344         let push_msat = 10001;
4345         let a_flags = InitFeatures::known();
4346         let b_flags = InitFeatures::known();
4347         let node_a = nodes.pop().unwrap();
4348         let node_b = nodes.pop().unwrap();
4349         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4350         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()));
4351         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()));
4352
4353         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4354
4355         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4356         check_added_monitors!(node_a, 0);
4357
4358         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()));
4359         {
4360                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4361                 assert_eq!(added_monitors.len(), 1);
4362                 assert_eq!(added_monitors[0].0, funding_output);
4363                 added_monitors.clear();
4364         }
4365
4366         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()));
4367         {
4368                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4369                 assert_eq!(added_monitors.len(), 1);
4370                 assert_eq!(added_monitors[0].0, funding_output);
4371                 added_monitors.clear();
4372         }
4373         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4374
4375         nodes.push(node_a);
4376         nodes.push(node_b);
4377
4378         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4379         let nodes_0_serialized = nodes[0].node.encode();
4380         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4381         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4382
4383         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4384         logger = test_utils::TestLogger::new();
4385         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4386         nodes[0].chan_monitor = &new_chan_monitor;
4387         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4388         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4389         assert!(chan_0_monitor_read.is_empty());
4390
4391         let mut nodes_0_read = &nodes_0_serialized[..];
4392         let config = UserConfig::default();
4393         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4394         let (_, nodes_0_deserialized_tmp) = {
4395                 let mut channel_monitors = HashMap::new();
4396                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4397                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4398                         default_config: config,
4399                         keys_manager: &keys_manager,
4400                         fee_estimator: &fee_estimator,
4401                         monitor: nodes[0].chan_monitor,
4402                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4403                         logger: &logger,
4404                         channel_monitors: &mut channel_monitors,
4405                 }).unwrap()
4406         };
4407         nodes_0_deserialized = nodes_0_deserialized_tmp;
4408         assert!(nodes_0_read.is_empty());
4409
4410         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4411
4412         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4413         nodes[0].node = &nodes_0_deserialized;
4414
4415         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4416         let events_4 = nodes[0].node.get_and_clear_pending_events();
4417         assert_eq!(events_4.len(), 1);
4418         match events_4[0] {
4419                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4420                         assert_eq!(user_channel_id, 42);
4421                         assert_eq!(*funding_txo, funding_output);
4422                 },
4423                 _ => panic!("Unexpected event"),
4424         };
4425
4426         // Make sure the channel is functioning as though the de/serialization never happened
4427         nodes[0].block_notifier.register_listener(nodes[0].node);
4428         assert_eq!(nodes[0].node.list_channels().len(), 1);
4429         check_added_monitors!(nodes[0], 1);
4430
4431         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4432         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4433         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4434         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4435
4436         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4437         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4438         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4439         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4440
4441         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4442         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4443         for node in nodes.iter() {
4444                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4445                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4446                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4447         }
4448
4449         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4450 }
4451
4452 #[test]
4453 fn test_simple_manager_serialize_deserialize() {
4454         let chanmon_cfgs = create_chanmon_cfgs(2);
4455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4457         let logger: test_utils::TestLogger;
4458         let fee_estimator: test_utils::TestFeeEstimator;
4459         let new_chan_monitor: test_utils::TestChannelMonitor;
4460         let keys_manager: test_utils::TestKeysInterface;
4461         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4462         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4463         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4464
4465         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4466         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4467
4468         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4469
4470         let nodes_0_serialized = nodes[0].node.encode();
4471         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4472         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4473
4474         logger = test_utils::TestLogger::new();
4475         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4476         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4477         nodes[0].chan_monitor = &new_chan_monitor;
4478         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4479         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4480         assert!(chan_0_monitor_read.is_empty());
4481
4482         let mut nodes_0_read = &nodes_0_serialized[..];
4483         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4484         let (_, nodes_0_deserialized_tmp) = {
4485                 let mut channel_monitors = HashMap::new();
4486                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4487                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4488                         default_config: UserConfig::default(),
4489                         keys_manager: &keys_manager,
4490                         fee_estimator: &fee_estimator,
4491                         monitor: nodes[0].chan_monitor,
4492                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4493                         logger: &logger,
4494                         channel_monitors: &mut channel_monitors,
4495                 }).unwrap()
4496         };
4497         nodes_0_deserialized = nodes_0_deserialized_tmp;
4498         assert!(nodes_0_read.is_empty());
4499
4500         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4501         nodes[0].node = &nodes_0_deserialized;
4502         check_added_monitors!(nodes[0], 1);
4503
4504         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4505
4506         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4507         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4508 }
4509
4510 #[test]
4511 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4512         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4513         let chanmon_cfgs = create_chanmon_cfgs(4);
4514         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4515         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4516         let logger: test_utils::TestLogger;
4517         let fee_estimator: test_utils::TestFeeEstimator;
4518         let new_chan_monitor: test_utils::TestChannelMonitor;
4519         let keys_manager: test_utils::TestKeysInterface;
4520         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4521         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4522         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4523         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4524         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4525
4526         let mut node_0_stale_monitors_serialized = Vec::new();
4527         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4528                 let mut writer = test_utils::TestVecWriter(Vec::new());
4529                 monitor.1.write_for_disk(&mut writer).unwrap();
4530                 node_0_stale_monitors_serialized.push(writer.0);
4531         }
4532
4533         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4534
4535         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4536         let nodes_0_serialized = nodes[0].node.encode();
4537
4538         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4539         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4540         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4541         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4542
4543         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4544         // nodes[3])
4545         let mut node_0_monitors_serialized = Vec::new();
4546         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4547                 let mut writer = test_utils::TestVecWriter(Vec::new());
4548                 monitor.1.write_for_disk(&mut writer).unwrap();
4549                 node_0_monitors_serialized.push(writer.0);
4550         }
4551
4552         logger = test_utils::TestLogger::new();
4553         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4554         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4555         nodes[0].chan_monitor = &new_chan_monitor;
4556
4557         let mut node_0_stale_monitors = Vec::new();
4558         for serialized in node_0_stale_monitors_serialized.iter() {
4559                 let mut read = &serialized[..];
4560                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4561                 assert!(read.is_empty());
4562                 node_0_stale_monitors.push(monitor);
4563         }
4564
4565         let mut node_0_monitors = Vec::new();
4566         for serialized in node_0_monitors_serialized.iter() {
4567                 let mut read = &serialized[..];
4568                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4569                 assert!(read.is_empty());
4570                 node_0_monitors.push(monitor);
4571         }
4572
4573         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4574
4575         let mut nodes_0_read = &nodes_0_serialized[..];
4576         if let Err(msgs::DecodeError::InvalidValue) =
4577                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4578                 default_config: UserConfig::default(),
4579                 keys_manager: &keys_manager,
4580                 fee_estimator: &fee_estimator,
4581                 monitor: nodes[0].chan_monitor,
4582                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4583                 logger: &logger,
4584                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4585         }) { } else {
4586                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4587         };
4588
4589         let mut nodes_0_read = &nodes_0_serialized[..];
4590         let (_, nodes_0_deserialized_tmp) =
4591                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4592                 default_config: UserConfig::default(),
4593                 keys_manager: &keys_manager,
4594                 fee_estimator: &fee_estimator,
4595                 monitor: nodes[0].chan_monitor,
4596                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4597                 logger: &logger,
4598                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4599         }).unwrap();
4600         nodes_0_deserialized = nodes_0_deserialized_tmp;
4601         assert!(nodes_0_read.is_empty());
4602
4603         { // Channel close should result in a commitment tx and an HTLC tx
4604                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4605                 assert_eq!(txn.len(), 2);
4606                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4607                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4608         }
4609
4610         for monitor in node_0_monitors.drain(..) {
4611                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().0, monitor).is_ok());
4612                 check_added_monitors!(nodes[0], 1);
4613         }
4614         nodes[0].node = &nodes_0_deserialized;
4615
4616         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4617         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4618         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4619         //... and we can even still claim the payment!
4620         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4621
4622         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4623         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4624         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4625         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4626         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4627         assert_eq!(msg_events.len(), 1);
4628         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4629                 match action {
4630                         &ErrorAction::SendErrorMessage { ref msg } => {
4631                                 assert_eq!(msg.channel_id, channel_id);
4632                         },
4633                         _ => panic!("Unexpected event!"),
4634                 }
4635         }
4636 }
4637
4638 macro_rules! check_spendable_outputs {
4639         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4640                 {
4641                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4642                         let mut txn = Vec::new();
4643                         for event in events {
4644                                 match event {
4645                                         Event::SpendableOutputs { ref outputs } => {
4646                                                 for outp in outputs {
4647                                                         match *outp {
4648                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4649                                                                         let input = TxIn {
4650                                                                                 previous_output: outpoint.clone(),
4651                                                                                 script_sig: Script::new(),
4652                                                                                 sequence: 0,
4653                                                                                 witness: Vec::new(),
4654                                                                         };
4655                                                                         let outp = TxOut {
4656                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4657                                                                                 value: output.value,
4658                                                                         };
4659                                                                         let mut spend_tx = Transaction {
4660                                                                                 version: 2,
4661                                                                                 lock_time: 0,
4662                                                                                 input: vec![input],
4663                                                                                 output: vec![outp],
4664                                                                         };
4665                                                                         let secp_ctx = Secp256k1::new();
4666                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4667                                                                         let remotepubkey = keys.pubkeys().payment_point;
4668                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4669                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4670                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4671                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4672                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4673                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4674                                                                         txn.push(spend_tx);
4675                                                                 },
4676                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4677                                                                         let input = TxIn {
4678                                                                                 previous_output: outpoint.clone(),
4679                                                                                 script_sig: Script::new(),
4680                                                                                 sequence: *to_self_delay as u32,
4681                                                                                 witness: Vec::new(),
4682                                                                         };
4683                                                                         let outp = TxOut {
4684                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4685                                                                                 value: output.value,
4686                                                                         };
4687                                                                         let mut spend_tx = Transaction {
4688                                                                                 version: 2,
4689                                                                                 lock_time: 0,
4690                                                                                 input: vec![input],
4691                                                                                 output: vec![outp],
4692                                                                         };
4693                                                                         let secp_ctx = Secp256k1::new();
4694                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4695                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4696
4697                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4698                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4699                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4700                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4701                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4702                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4703                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4704                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4705                                                                         } else { panic!() }
4706                                                                         txn.push(spend_tx);
4707                                                                 },
4708                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4709                                                                         let secp_ctx = Secp256k1::new();
4710                                                                         let input = TxIn {
4711                                                                                 previous_output: outpoint.clone(),
4712                                                                                 script_sig: Script::new(),
4713                                                                                 sequence: 0,
4714                                                                                 witness: Vec::new(),
4715                                                                         };
4716                                                                         let outp = TxOut {
4717                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4718                                                                                 value: output.value,
4719                                                                         };
4720                                                                         let mut spend_tx = Transaction {
4721                                                                                 version: 2,
4722                                                                                 lock_time: 0,
4723                                                                                 input: vec![input],
4724                                                                                 output: vec![outp.clone()],
4725                                                                         };
4726                                                                         let secret = {
4727                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4728                                                                                         Ok(master_key) => {
4729                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4730                                                                                                         Ok(key) => key,
4731                                                                                                         Err(_) => panic!("Your RNG is busted"),
4732                                                                                                 }
4733                                                                                         }
4734                                                                                         Err(_) => panic!("Your rng is busted"),
4735                                                                                 }
4736                                                                         };
4737                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4738                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4739                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4740                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4741                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4742                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4743                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4744                                                                         txn.push(spend_tx);
4745                                                                 },
4746                                                         }
4747                                                 }
4748                                         },
4749                                         _ => panic!("Unexpected event"),
4750                                 };
4751                         }
4752                         txn
4753                 }
4754         }
4755 }
4756
4757 #[test]
4758 fn test_claim_sizeable_push_msat() {
4759         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4760         let chanmon_cfgs = create_chanmon_cfgs(2);
4761         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4762         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4763         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4764
4765         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4766         nodes[1].node.force_close_channel(&chan.2);
4767         check_closed_broadcast!(nodes[1], false);
4768         check_added_monitors!(nodes[1], 1);
4769         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4770         assert_eq!(node_txn.len(), 1);
4771         check_spends!(node_txn[0], chan.3);
4772         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
4773
4774         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4775         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4776         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4777
4778         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4779         assert_eq!(spend_txn.len(), 1);
4780         check_spends!(spend_txn[0], node_txn[0]);
4781 }
4782
4783 #[test]
4784 fn test_claim_on_remote_sizeable_push_msat() {
4785         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4786         // to_remote output is encumbered by a P2WPKH
4787         let chanmon_cfgs = create_chanmon_cfgs(2);
4788         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4789         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4790         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4791
4792         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4793         nodes[0].node.force_close_channel(&chan.2);
4794         check_closed_broadcast!(nodes[0], false);
4795         check_added_monitors!(nodes[0], 1);
4796
4797         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4798         assert_eq!(node_txn.len(), 1);
4799         check_spends!(node_txn[0], chan.3);
4800         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
4801
4802         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4803         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4804         check_closed_broadcast!(nodes[1], false);
4805         check_added_monitors!(nodes[1], 1);
4806         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4807
4808         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4809         assert_eq!(spend_txn.len(), 2);
4810         assert_eq!(spend_txn[0], spend_txn[1]);
4811         check_spends!(spend_txn[0], node_txn[0]);
4812 }
4813
4814 #[test]
4815 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4816         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4817         // to_remote output is encumbered by a P2WPKH
4818
4819         let chanmon_cfgs = create_chanmon_cfgs(2);
4820         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4821         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4822         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4823
4824         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4825         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4826         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4827         assert_eq!(revoked_local_txn[0].input.len(), 1);
4828         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4829
4830         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4831         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4832         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4833         check_closed_broadcast!(nodes[1], false);
4834         check_added_monitors!(nodes[1], 1);
4835
4836         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4837         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4838         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4839         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4840
4841         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4842         assert_eq!(spend_txn.len(), 3);
4843         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4844         check_spends!(spend_txn[0], revoked_local_txn[0]);
4845         check_spends!(spend_txn[2], node_txn[0]);
4846 }
4847
4848 #[test]
4849 fn test_static_spendable_outputs_preimage_tx() {
4850         let chanmon_cfgs = create_chanmon_cfgs(2);
4851         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4852         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4853         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4854
4855         // Create some initial channels
4856         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4857
4858         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4859
4860         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4861         assert_eq!(commitment_tx[0].input.len(), 1);
4862         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4863
4864         // Settle A's commitment tx on B's chain
4865         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4866         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4867         check_added_monitors!(nodes[1], 1);
4868         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4869         check_added_monitors!(nodes[1], 1);
4870         let events = nodes[1].node.get_and_clear_pending_msg_events();
4871         match events[0] {
4872                 MessageSendEvent::UpdateHTLCs { .. } => {},
4873                 _ => panic!("Unexpected event"),
4874         }
4875         match events[1] {
4876                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4877                 _ => panic!("Unexepected event"),
4878         }
4879
4880         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4881         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4882         assert_eq!(node_txn.len(), 3);
4883         check_spends!(node_txn[0], commitment_tx[0]);
4884         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4885         check_spends!(node_txn[1], chan_1.3);
4886         check_spends!(node_txn[2], node_txn[1]);
4887
4888         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4889         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4890         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4891
4892         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4893         assert_eq!(spend_txn.len(), 1);
4894         check_spends!(spend_txn[0], node_txn[0]);
4895 }
4896
4897 #[test]
4898 fn test_static_spendable_outputs_timeout_tx() {
4899         let chanmon_cfgs = create_chanmon_cfgs(2);
4900         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4901         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4902         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4903
4904         // Create some initial channels
4905         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4906
4907         // Rebalance the network a bit by relaying one payment through all the channels ...
4908         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4909
4910         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4911
4912         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4913         assert_eq!(commitment_tx[0].input.len(), 1);
4914         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4915
4916         // Settle A's commitment tx on B' chain
4917         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4918         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4919         check_added_monitors!(nodes[1], 1);
4920         let events = nodes[1].node.get_and_clear_pending_msg_events();
4921         match events[0] {
4922                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4923                 _ => panic!("Unexpected event"),
4924         }
4925
4926         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4927         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4928         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4929         check_spends!(node_txn[0],  commitment_tx[0].clone());
4930         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4931         check_spends!(node_txn[1], chan_1.3.clone());
4932         check_spends!(node_txn[2], node_txn[1]);
4933
4934         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4935         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4936         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4937         expect_payment_failed!(nodes[1], our_payment_hash, true);
4938
4939         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4940         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4941         check_spends!(spend_txn[2], node_txn[0].clone());
4942 }
4943
4944 #[test]
4945 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4946         let chanmon_cfgs = create_chanmon_cfgs(2);
4947         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4948         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4949         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4950
4951         // Create some initial channels
4952         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4953
4954         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4955         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4956         assert_eq!(revoked_local_txn[0].input.len(), 1);
4957         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4958
4959         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4960
4961         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4962         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4963         check_closed_broadcast!(nodes[1], false);
4964         check_added_monitors!(nodes[1], 1);
4965
4966         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4967         assert_eq!(node_txn.len(), 2);
4968         assert_eq!(node_txn[0].input.len(), 2);
4969         check_spends!(node_txn[0], revoked_local_txn[0]);
4970
4971         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4972         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4973         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4974
4975         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4976         assert_eq!(spend_txn.len(), 1);
4977         check_spends!(spend_txn[0], node_txn[0]);
4978 }
4979
4980 #[test]
4981 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4982         let chanmon_cfgs = create_chanmon_cfgs(2);
4983         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4985         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4986
4987         // Create some initial channels
4988         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4989
4990         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4991         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4992         assert_eq!(revoked_local_txn[0].input.len(), 1);
4993         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4994
4995         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4996
4997         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4998         // A will generate HTLC-Timeout from revoked commitment tx
4999         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5000         check_closed_broadcast!(nodes[0], false);
5001         check_added_monitors!(nodes[0], 1);
5002
5003         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5004         assert_eq!(revoked_htlc_txn.len(), 2);
5005         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5006         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5007         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5008         check_spends!(revoked_htlc_txn[1], chan_1.3);
5009
5010         // B will generate justice tx from A's revoked commitment/HTLC tx
5011         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5012         check_closed_broadcast!(nodes[1], false);
5013         check_added_monitors!(nodes[1], 1);
5014
5015         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5016         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
5017         assert_eq!(node_txn[0].input.len(), 2);
5018         check_spends!(node_txn[0], revoked_local_txn[0]);
5019         assert_eq!(node_txn[1].input.len(), 1);
5020         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5021         assert_eq!(node_txn[2].input.len(), 1);
5022         check_spends!(node_txn[2], revoked_local_txn[0]);
5023         check_spends!(node_txn[3], chan_1.3);
5024
5025         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5026         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5027         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5028
5029         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5030         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5031         assert_eq!(spend_txn.len(), 2);
5032         check_spends!(spend_txn[0], node_txn[0]);
5033         check_spends!(spend_txn[1], node_txn[2]);
5034 }
5035
5036 #[test]
5037 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5038         let chanmon_cfgs = create_chanmon_cfgs(2);
5039         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5040         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5041         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5042
5043         // Create some initial channels
5044         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5045
5046         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5047         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5048         assert_eq!(revoked_local_txn[0].input.len(), 1);
5049         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5050
5051         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5052
5053         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5054         // B will generate HTLC-Success from revoked commitment tx
5055         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5056         check_closed_broadcast!(nodes[1], false);
5057         check_added_monitors!(nodes[1], 1);
5058         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5059
5060         assert_eq!(revoked_htlc_txn.len(), 2);
5061         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5062         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5063         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5064
5065         // A will generate justice tx from B's revoked commitment/HTLC tx
5066         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5067         check_closed_broadcast!(nodes[0], false);
5068         check_added_monitors!(nodes[0], 1);
5069
5070         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5071         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5072         assert_eq!(node_txn[1].input.len(), 1);
5073         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5074
5075         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5076         connect_block(&nodes[0], &Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5077         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5078
5079         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5080         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5081         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5082         assert_eq!(spend_txn[0], spend_txn[1]);
5083         assert_eq!(spend_txn[0], spend_txn[2]);
5084         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5085         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5086         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5087 }
5088
5089 #[test]
5090 fn test_onchain_to_onchain_claim() {
5091         // Test that in case of channel closure, we detect the state of output and claim HTLC
5092         // on downstream peer's remote commitment tx.
5093         // First, have C claim an HTLC against its own latest commitment transaction.
5094         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5095         // channel.
5096         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5097         // gets broadcast.
5098
5099         let chanmon_cfgs = create_chanmon_cfgs(3);
5100         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5101         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5102         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5103
5104         // Create some initial channels
5105         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5106         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5107
5108         // Rebalance the network a bit by relaying one payment through all the channels ...
5109         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5110         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5111
5112         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5113         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5114         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5115         check_spends!(commitment_tx[0], chan_2.3);
5116         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5117         check_added_monitors!(nodes[2], 1);
5118         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5119         assert!(updates.update_add_htlcs.is_empty());
5120         assert!(updates.update_fail_htlcs.is_empty());
5121         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5122         assert!(updates.update_fail_malformed_htlcs.is_empty());
5123
5124         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5125         check_closed_broadcast!(nodes[2], false);
5126         check_added_monitors!(nodes[2], 1);
5127
5128         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5129         assert_eq!(c_txn.len(), 3);
5130         assert_eq!(c_txn[0], c_txn[2]);
5131         assert_eq!(commitment_tx[0], c_txn[1]);
5132         check_spends!(c_txn[1], chan_2.3);
5133         check_spends!(c_txn[2], c_txn[1]);
5134         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5135         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5136         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5137         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5138
5139         // 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
5140         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5141         {
5142                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5143                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5144                 assert_eq!(b_txn.len(), 3);
5145                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5146                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5147                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5148                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5149                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5150                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5151                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5152                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5153                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5154                 b_txn.clear();
5155         }
5156         check_added_monitors!(nodes[1], 1);
5157         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5158         check_added_monitors!(nodes[1], 1);
5159         match msg_events[0] {
5160                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5161                 _ => panic!("Unexpected event"),
5162         }
5163         match msg_events[1] {
5164                 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, .. } } => {
5165                         assert!(update_add_htlcs.is_empty());
5166                         assert!(update_fail_htlcs.is_empty());
5167                         assert_eq!(update_fulfill_htlcs.len(), 1);
5168                         assert!(update_fail_malformed_htlcs.is_empty());
5169                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5170                 },
5171                 _ => panic!("Unexpected event"),
5172         };
5173         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5174         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5175         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5176         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5177         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5178         assert_eq!(b_txn.len(), 3);
5179         check_spends!(b_txn[1], chan_1.3);
5180         check_spends!(b_txn[2], b_txn[1]);
5181         check_spends!(b_txn[0], commitment_tx[0]);
5182         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5183         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5184         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5185
5186         check_closed_broadcast!(nodes[1], false);
5187         check_added_monitors!(nodes[1], 1);
5188 }
5189
5190 #[test]
5191 fn test_duplicate_payment_hash_one_failure_one_success() {
5192         // Topology : A --> B --> C
5193         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5194         let chanmon_cfgs = create_chanmon_cfgs(3);
5195         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5196         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5197         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5198
5199         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5200         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5201
5202         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5203         *nodes[0].network_payment_count.borrow_mut() -= 1;
5204         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5205
5206         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5207         assert_eq!(commitment_txn[0].input.len(), 1);
5208         check_spends!(commitment_txn[0], chan_2.3);
5209
5210         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5211         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5212         check_closed_broadcast!(nodes[1], false);
5213         check_added_monitors!(nodes[1], 1);
5214
5215         let htlc_timeout_tx;
5216         { // Extract one of the two HTLC-Timeout transaction
5217                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5218                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5219                 assert_eq!(node_txn.len(), 5);
5220                 check_spends!(node_txn[0], commitment_txn[0]);
5221                 assert_eq!(node_txn[0].input.len(), 1);
5222                 check_spends!(node_txn[1], commitment_txn[0]);
5223                 assert_eq!(node_txn[1].input.len(), 1);
5224                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5225                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5226                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5227                 check_spends!(node_txn[2], chan_2.3);
5228                 check_spends!(node_txn[3], node_txn[2]);
5229                 check_spends!(node_txn[4], node_txn[2]);
5230                 htlc_timeout_tx = node_txn[1].clone();
5231         }
5232
5233         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5234         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5235         check_added_monitors!(nodes[2], 3);
5236         let events = nodes[2].node.get_and_clear_pending_msg_events();
5237         match events[0] {
5238                 MessageSendEvent::UpdateHTLCs { .. } => {},
5239                 _ => panic!("Unexpected event"),
5240         }
5241         match events[1] {
5242                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5243                 _ => panic!("Unexepected event"),
5244         }
5245         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5246         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)
5247         check_spends!(htlc_success_txn[2], chan_2.3);
5248         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5249         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5250         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5251         assert_eq!(htlc_success_txn[0].input.len(), 1);
5252         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5253         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5254         assert_eq!(htlc_success_txn[1].input.len(), 1);
5255         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5256         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5257         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5258         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5259
5260         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5261         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5262         expect_pending_htlcs_forwardable!(nodes[1]);
5263         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5264         assert!(htlc_updates.update_add_htlcs.is_empty());
5265         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5266         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5267         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5268         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5269         check_added_monitors!(nodes[1], 1);
5270
5271         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5272         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5273         {
5274                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5275                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5276                 assert_eq!(events.len(), 1);
5277                 match events[0] {
5278                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5279                         },
5280                         _ => { panic!("Unexpected event"); }
5281                 }
5282         }
5283         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5284
5285         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5286         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5287         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5288         assert!(updates.update_add_htlcs.is_empty());
5289         assert!(updates.update_fail_htlcs.is_empty());
5290         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5291         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5292         assert!(updates.update_fail_malformed_htlcs.is_empty());
5293         check_added_monitors!(nodes[1], 1);
5294
5295         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5296         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5297
5298         let events = nodes[0].node.get_and_clear_pending_events();
5299         match events[0] {
5300                 Event::PaymentSent { ref payment_preimage } => {
5301                         assert_eq!(*payment_preimage, our_payment_preimage);
5302                 }
5303                 _ => panic!("Unexpected event"),
5304         }
5305 }
5306
5307 #[test]
5308 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5309         let chanmon_cfgs = create_chanmon_cfgs(2);
5310         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5311         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5312         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5313
5314         // Create some initial channels
5315         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5316
5317         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5318         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5319         assert_eq!(local_txn[0].input.len(), 1);
5320         check_spends!(local_txn[0], chan_1.3);
5321
5322         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5323         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5324         check_added_monitors!(nodes[1], 1);
5325         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5326         connect_block(&nodes[1], &Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5327         check_added_monitors!(nodes[1], 1);
5328         let events = nodes[1].node.get_and_clear_pending_msg_events();
5329         match events[0] {
5330                 MessageSendEvent::UpdateHTLCs { .. } => {},
5331                 _ => panic!("Unexpected event"),
5332         }
5333         match events[1] {
5334                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5335                 _ => panic!("Unexepected event"),
5336         }
5337         let node_txn = {
5338                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5339                 assert_eq!(node_txn[0].input.len(), 1);
5340                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5341                 check_spends!(node_txn[0], local_txn[0]);
5342                 vec![node_txn[0].clone(), node_txn[2].clone()]
5343         };
5344
5345         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5346         connect_block(&nodes[1], &Block { header: header_201, txdata: node_txn.clone() }, 201);
5347         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5348
5349         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5350         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5351         assert_eq!(spend_txn.len(), 2);
5352         check_spends!(spend_txn[0], node_txn[0]);
5353         check_spends!(spend_txn[1], node_txn[1]);
5354 }
5355
5356 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5357         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5358         // unrevoked commitment transaction.
5359         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5360         // a remote RAA before they could be failed backwards (and combinations thereof).
5361         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5362         // use the same payment hashes.
5363         // Thus, we use a six-node network:
5364         //
5365         // A \         / E
5366         //    - C - D -
5367         // B /         \ F
5368         // And test where C fails back to A/B when D announces its latest commitment transaction
5369         let chanmon_cfgs = create_chanmon_cfgs(6);
5370         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5371         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5372         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5373         let logger = test_utils::TestLogger::new();
5374
5375         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5376         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5377         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5378         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5379         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5380
5381         // Rebalance and check output sanity...
5382         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5383         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5384         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5385
5386         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5387         // 0th HTLC:
5388         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
5389         // 1st HTLC:
5390         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
5391         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5392         let our_node_id = &nodes[1].node.get_our_node_id();
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(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5394         // 2nd HTLC:
5395         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
5396         // 3rd HTLC:
5397         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
5398         // 4th HTLC:
5399         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5400         // 5th HTLC:
5401         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5402         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();
5403         // 6th HTLC:
5404         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5405         // 7th HTLC:
5406         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5407
5408         // 8th HTLC:
5409         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5410         // 9th HTLC:
5411         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();
5412         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
5413
5414         // 10th HTLC:
5415         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
5416         // 11th HTLC:
5417         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();
5418         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5419
5420         // Double-check that six of the new HTLC were added
5421         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5422         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5423         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5424         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5425
5426         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5427         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5428         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5429         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5430         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5431         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5432         check_added_monitors!(nodes[4], 0);
5433         expect_pending_htlcs_forwardable!(nodes[4]);
5434         check_added_monitors!(nodes[4], 1);
5435
5436         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5437         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5438         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5439         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5440         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5441         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5442
5443         // Fail 3rd below-dust and 7th above-dust HTLCs
5444         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5445         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5446         check_added_monitors!(nodes[5], 0);
5447         expect_pending_htlcs_forwardable!(nodes[5]);
5448         check_added_monitors!(nodes[5], 1);
5449
5450         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5451         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5452         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5453         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5454
5455         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5456
5457         expect_pending_htlcs_forwardable!(nodes[3]);
5458         check_added_monitors!(nodes[3], 1);
5459         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5460         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5461         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5462         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5463         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5464         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5465         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5466         if deliver_last_raa {
5467                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5468         } else {
5469                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5470         }
5471
5472         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5473         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5474         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5475         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5476         //
5477         // We now broadcast the latest commitment transaction, which *should* result in failures for
5478         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5479         // the non-broadcast above-dust HTLCs.
5480         //
5481         // Alternatively, we may broadcast the previous commitment transaction, which should only
5482         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5483         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5484
5485         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5486         if announce_latest {
5487                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5488         } else {
5489                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5490         }
5491         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5492         check_closed_broadcast!(nodes[2], false);
5493         expect_pending_htlcs_forwardable!(nodes[2]);
5494         check_added_monitors!(nodes[2], 3);
5495
5496         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5497         assert_eq!(cs_msgs.len(), 2);
5498         let mut a_done = false;
5499         for msg in cs_msgs {
5500                 match msg {
5501                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5502                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5503                                 // should be failed-backwards here.
5504                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5505                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5506                                         for htlc in &updates.update_fail_htlcs {
5507                                                 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 });
5508                                         }
5509                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5510                                         assert!(!a_done);
5511                                         a_done = true;
5512                                         &nodes[0]
5513                                 } else {
5514                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5515                                         for htlc in &updates.update_fail_htlcs {
5516                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5517                                         }
5518                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5519                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5520                                         &nodes[1]
5521                                 };
5522                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5523                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5524                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5525                                 if announce_latest {
5526                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5527                                         if *node_id == nodes[0].node.get_our_node_id() {
5528                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5529                                         }
5530                                 }
5531                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5532                         },
5533                         _ => panic!("Unexpected event"),
5534                 }
5535         }
5536
5537         let as_events = nodes[0].node.get_and_clear_pending_events();
5538         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5539         let mut as_failds = HashSet::new();
5540         for event in as_events.iter() {
5541                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5542                         assert!(as_failds.insert(*payment_hash));
5543                         if *payment_hash != payment_hash_2 {
5544                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5545                         } else {
5546                                 assert!(!rejected_by_dest);
5547                         }
5548                 } else { panic!("Unexpected event"); }
5549         }
5550         assert!(as_failds.contains(&payment_hash_1));
5551         assert!(as_failds.contains(&payment_hash_2));
5552         if announce_latest {
5553                 assert!(as_failds.contains(&payment_hash_3));
5554                 assert!(as_failds.contains(&payment_hash_5));
5555         }
5556         assert!(as_failds.contains(&payment_hash_6));
5557
5558         let bs_events = nodes[1].node.get_and_clear_pending_events();
5559         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5560         let mut bs_failds = HashSet::new();
5561         for event in bs_events.iter() {
5562                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5563                         assert!(bs_failds.insert(*payment_hash));
5564                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5565                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5566                         } else {
5567                                 assert!(!rejected_by_dest);
5568                         }
5569                 } else { panic!("Unexpected event"); }
5570         }
5571         assert!(bs_failds.contains(&payment_hash_1));
5572         assert!(bs_failds.contains(&payment_hash_2));
5573         if announce_latest {
5574                 assert!(bs_failds.contains(&payment_hash_4));
5575         }
5576         assert!(bs_failds.contains(&payment_hash_5));
5577
5578         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5579         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5580         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5581         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5582         // PaymentFailureNetworkUpdates.
5583         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5584         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5585         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5586         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5587         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5588                 match event {
5589                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5590                         _ => panic!("Unexpected event"),
5591                 }
5592         }
5593 }
5594
5595 #[test]
5596 fn test_fail_backwards_latest_remote_announce_a() {
5597         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5598 }
5599
5600 #[test]
5601 fn test_fail_backwards_latest_remote_announce_b() {
5602         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5603 }
5604
5605 #[test]
5606 fn test_fail_backwards_previous_remote_announce() {
5607         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5608         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5609         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5610 }
5611
5612 #[test]
5613 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5614         let chanmon_cfgs = create_chanmon_cfgs(2);
5615         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5616         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5617         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5618
5619         // Create some initial channels
5620         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5621
5622         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5623         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5624         assert_eq!(local_txn[0].input.len(), 1);
5625         check_spends!(local_txn[0], chan_1.3);
5626
5627         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5628         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5629         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5630         check_closed_broadcast!(nodes[0], false);
5631         check_added_monitors!(nodes[0], 1);
5632
5633         let htlc_timeout = {
5634                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5635                 assert_eq!(node_txn[0].input.len(), 1);
5636                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5637                 check_spends!(node_txn[0], local_txn[0]);
5638                 node_txn[0].clone()
5639         };
5640
5641         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5642         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5643         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5644         expect_payment_failed!(nodes[0], our_payment_hash, true);
5645
5646         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5647         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5648         assert_eq!(spend_txn.len(), 3);
5649         assert_eq!(spend_txn[0], spend_txn[1]);
5650         check_spends!(spend_txn[0], local_txn[0]);
5651         check_spends!(spend_txn[2], htlc_timeout);
5652 }
5653
5654 #[test]
5655 fn test_key_derivation_params() {
5656         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5657         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5658         // let us re-derive the channel key set to then derive a delayed_payment_key.
5659
5660         let chanmon_cfgs = create_chanmon_cfgs(3);
5661
5662         // We manually create the node configuration to backup the seed.
5663         let seed = [42; 32];
5664         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5665         let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5666         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 };
5667         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5668         node_cfgs.remove(0);
5669         node_cfgs.insert(0, node);
5670
5671         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5672         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5673
5674         // Create some initial channels
5675         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5676         // for node 0
5677         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5678         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5679         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5680
5681         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5682         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5683         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5684         assert_eq!(local_txn_1[0].input.len(), 1);
5685         check_spends!(local_txn_1[0], chan_1.3);
5686
5687         // We check funding pubkey are unique
5688         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]));
5689         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]));
5690         if from_0_funding_key_0 == from_1_funding_key_0
5691             || from_0_funding_key_0 == from_1_funding_key_1
5692             || from_0_funding_key_1 == from_1_funding_key_0
5693             || from_0_funding_key_1 == from_1_funding_key_1 {
5694                 panic!("Funding pubkeys aren't unique");
5695         }
5696
5697         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5698         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5699         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5700         check_closed_broadcast!(nodes[0], false);
5701         check_added_monitors!(nodes[0], 1);
5702
5703         let htlc_timeout = {
5704                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5705                 assert_eq!(node_txn[0].input.len(), 1);
5706                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5707                 check_spends!(node_txn[0], local_txn_1[0]);
5708                 node_txn[0].clone()
5709         };
5710
5711         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5712         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5713         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5714         expect_payment_failed!(nodes[0], our_payment_hash, true);
5715
5716         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5717         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5718         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5719         assert_eq!(spend_txn.len(), 3);
5720         assert_eq!(spend_txn[0], spend_txn[1]);
5721         check_spends!(spend_txn[0], local_txn_1[0]);
5722         check_spends!(spend_txn[2], htlc_timeout);
5723 }
5724
5725 #[test]
5726 fn test_static_output_closing_tx() {
5727         let chanmon_cfgs = create_chanmon_cfgs(2);
5728         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5729         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5730         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5731
5732         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5733
5734         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5735         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5736
5737         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5738         connect_block(&nodes[0], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5739         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5740
5741         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5742         assert_eq!(spend_txn.len(), 1);
5743         check_spends!(spend_txn[0], closing_tx);
5744
5745         connect_block(&nodes[1], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5746         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5747
5748         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5749         assert_eq!(spend_txn.len(), 1);
5750         check_spends!(spend_txn[0], closing_tx);
5751 }
5752
5753 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5754         let chanmon_cfgs = create_chanmon_cfgs(2);
5755         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5756         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5757         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5758         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5759
5760         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5761
5762         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5763         // present in B's local commitment transaction, but none of A's commitment transactions.
5764         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5765         check_added_monitors!(nodes[1], 1);
5766
5767         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5768         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5769         let events = nodes[0].node.get_and_clear_pending_events();
5770         assert_eq!(events.len(), 1);
5771         match events[0] {
5772                 Event::PaymentSent { payment_preimage } => {
5773                         assert_eq!(payment_preimage, our_payment_preimage);
5774                 },
5775                 _ => panic!("Unexpected event"),
5776         }
5777
5778         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5779         check_added_monitors!(nodes[0], 1);
5780         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5781         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5782         check_added_monitors!(nodes[1], 1);
5783
5784         let mut block = Block {
5785                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5786                 txdata: vec![],
5787         };
5788         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5789                 connect_block(&nodes[1], &block, i);
5790                 block.header.prev_blockhash = block.bitcoin_hash();
5791         }
5792         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5793         check_closed_broadcast!(nodes[1], false);
5794         check_added_monitors!(nodes[1], 1);
5795 }
5796
5797 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5798         let chanmon_cfgs = create_chanmon_cfgs(2);
5799         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5800         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5801         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5802         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5803         let logger = test_utils::TestLogger::new();
5804
5805         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5806         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5807         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();
5808         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5809         check_added_monitors!(nodes[0], 1);
5810
5811         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5812
5813         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5814         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5815         // to "time out" the HTLC.
5816
5817         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5818
5819         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5820                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5821                 header.prev_blockhash = header.bitcoin_hash();
5822         }
5823         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5824         check_closed_broadcast!(nodes[0], false);
5825         check_added_monitors!(nodes[0], 1);
5826 }
5827
5828 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5829         let chanmon_cfgs = create_chanmon_cfgs(3);
5830         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5831         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5832         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5833         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5834
5835         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5836         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5837         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5838         // actually revoked.
5839         let htlc_value = if use_dust { 50000 } else { 3000000 };
5840         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5841         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5842         expect_pending_htlcs_forwardable!(nodes[1]);
5843         check_added_monitors!(nodes[1], 1);
5844
5845         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5846         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5847         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5848         check_added_monitors!(nodes[0], 1);
5849         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5850         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5851         check_added_monitors!(nodes[1], 1);
5852         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5853         check_added_monitors!(nodes[1], 1);
5854         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5855
5856         if check_revoke_no_close {
5857                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5858                 check_added_monitors!(nodes[0], 1);
5859         }
5860
5861         let mut block = Block {
5862                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5863                 txdata: vec![],
5864         };
5865         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5866                 connect_block(&nodes[0], &block, i);
5867                 block.header.prev_blockhash = block.bitcoin_hash();
5868         }
5869         if !check_revoke_no_close {
5870                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5871                 check_closed_broadcast!(nodes[0], false);
5872                 check_added_monitors!(nodes[0], 1);
5873         } else {
5874                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5875         }
5876 }
5877
5878 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5879 // There are only a few cases to test here:
5880 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5881 //    broadcastable commitment transactions result in channel closure,
5882 //  * its included in an unrevoked-but-previous remote commitment transaction,
5883 //  * its included in the latest remote or local commitment transactions.
5884 // We test each of the three possible commitment transactions individually and use both dust and
5885 // non-dust HTLCs.
5886 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5887 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5888 // tested for at least one of the cases in other tests.
5889 #[test]
5890 fn htlc_claim_single_commitment_only_a() {
5891         do_htlc_claim_local_commitment_only(true);
5892         do_htlc_claim_local_commitment_only(false);
5893
5894         do_htlc_claim_current_remote_commitment_only(true);
5895         do_htlc_claim_current_remote_commitment_only(false);
5896 }
5897
5898 #[test]
5899 fn htlc_claim_single_commitment_only_b() {
5900         do_htlc_claim_previous_remote_commitment_only(true, false);
5901         do_htlc_claim_previous_remote_commitment_only(false, false);
5902         do_htlc_claim_previous_remote_commitment_only(true, true);
5903         do_htlc_claim_previous_remote_commitment_only(false, true);
5904 }
5905
5906 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>)
5907         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5908                                 F2: FnMut(),
5909 {
5910         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);
5911 }
5912
5913 // test_case
5914 // 0: node1 fails backward
5915 // 1: final node fails backward
5916 // 2: payment completed but the user rejects the payment
5917 // 3: final node fails backward (but tamper onion payloads from node0)
5918 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5919 // 200: trigger error in the final node and tamper returning fail_htlc
5920 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>)
5921         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5922                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5923                                 F3: FnMut(),
5924 {
5925
5926         // reset block height
5927         let block = Block {
5928                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5929                 txdata: vec![],
5930         };
5931         for ix in 0..nodes.len() {
5932                 connect_block(&nodes[ix], &block, 1);
5933         }
5934
5935         macro_rules! expect_event {
5936                 ($node: expr, $event_type: path) => {{
5937                         let events = $node.node.get_and_clear_pending_events();
5938                         assert_eq!(events.len(), 1);
5939                         match events[0] {
5940                                 $event_type { .. } => {},
5941                                 _ => panic!("Unexpected event"),
5942                         }
5943                 }}
5944         }
5945
5946         macro_rules! expect_htlc_forward {
5947                 ($node: expr) => {{
5948                         expect_event!($node, Event::PendingHTLCsForwardable);
5949                         $node.node.process_pending_htlc_forwards();
5950                 }}
5951         }
5952
5953         // 0 ~~> 2 send payment
5954         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5955         check_added_monitors!(nodes[0], 1);
5956         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5957         // temper update_add (0 => 1)
5958         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5959         if test_case == 0 || test_case == 3 || test_case == 100 {
5960                 callback_msg(&mut update_add_0);
5961                 callback_node();
5962         }
5963         // 0 => 1 update_add & CS
5964         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5965         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5966
5967         let update_1_0 = match test_case {
5968                 0|100 => { // intermediate node failure; fail backward to 0
5969                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5970                         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));
5971                         update_1_0
5972                 },
5973                 1|2|3|200 => { // final node failure; forwarding to 2
5974                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5975                         // forwarding on 1
5976                         if test_case != 200 {
5977                                 callback_node();
5978                         }
5979                         expect_htlc_forward!(&nodes[1]);
5980
5981                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5982                         check_added_monitors!(&nodes[1], 1);
5983                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5984                         // tamper update_add (1 => 2)
5985                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5986                         if test_case != 3 && test_case != 200 {
5987                                 callback_msg(&mut update_add_1);
5988                         }
5989
5990                         // 1 => 2
5991                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5992                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5993
5994                         if test_case == 2 || test_case == 200 {
5995                                 expect_htlc_forward!(&nodes[2]);
5996                                 expect_event!(&nodes[2], Event::PaymentReceived);
5997                                 callback_node();
5998                                 expect_pending_htlcs_forwardable!(nodes[2]);
5999                         }
6000
6001                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6002                         if test_case == 2 || test_case == 200 {
6003                                 check_added_monitors!(&nodes[2], 1);
6004                         }
6005                         assert!(update_2_1.update_fail_htlcs.len() == 1);
6006
6007                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6008                         if test_case == 200 {
6009                                 callback_fail(&mut fail_msg);
6010                         }
6011
6012                         // 2 => 1
6013                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
6014                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
6015
6016                         // backward fail on 1
6017                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6018                         assert!(update_1_0.update_fail_htlcs.len() == 1);
6019                         update_1_0
6020                 },
6021                 _ => unreachable!(),
6022         };
6023
6024         // 1 => 0 commitment_signed_dance
6025         if update_1_0.update_fail_htlcs.len() > 0 {
6026                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6027                 if test_case == 100 {
6028                         callback_fail(&mut fail_msg);
6029                 }
6030                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6031         } else {
6032                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
6033         };
6034
6035         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6036
6037         let events = nodes[0].node.get_and_clear_pending_events();
6038         assert_eq!(events.len(), 1);
6039         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6040                 assert_eq!(*rejected_by_dest, !expected_retryable);
6041                 assert_eq!(*error_code, expected_error_code);
6042         } else {
6043                 panic!("Uexpected event");
6044         }
6045
6046         let events = nodes[0].node.get_and_clear_pending_msg_events();
6047         if expected_channel_update.is_some() {
6048                 assert_eq!(events.len(), 1);
6049                 match events[0] {
6050                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6051                                 match update {
6052                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6053                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6054                                                         panic!("channel_update not found!");
6055                                                 }
6056                                         },
6057                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6058                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6059                                                         assert!(*short_channel_id == *expected_short_channel_id);
6060                                                         assert!(*is_permanent == *expected_is_permanent);
6061                                                 } else {
6062                                                         panic!("Unexpected message event");
6063                                                 }
6064                                         },
6065                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6066                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6067                                                         assert!(*node_id == *expected_node_id);
6068                                                         assert!(*is_permanent == *expected_is_permanent);
6069                                                 } else {
6070                                                         panic!("Unexpected message event");
6071                                                 }
6072                                         },
6073                                 }
6074                         },
6075                         _ => panic!("Unexpected message event"),
6076                 }
6077         } else {
6078                 assert_eq!(events.len(), 0);
6079         }
6080 }
6081
6082 impl msgs::ChannelUpdate {
6083         fn dummy() -> msgs::ChannelUpdate {
6084                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6085                 use bitcoin::secp256k1::Signature;
6086                 msgs::ChannelUpdate {
6087                         signature: Signature::from(FFISignature::new()),
6088                         contents: msgs::UnsignedChannelUpdate {
6089                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
6090                                 short_channel_id: 0,
6091                                 timestamp: 0,
6092                                 flags: 0,
6093                                 cltv_expiry_delta: 0,
6094                                 htlc_minimum_msat: 0,
6095                                 htlc_maximum_msat: OptionalField::Absent,
6096                                 fee_base_msat: 0,
6097                                 fee_proportional_millionths: 0,
6098                                 excess_data: vec![],
6099                         }
6100                 }
6101         }
6102 }
6103
6104 struct BogusOnionHopData {
6105         data: Vec<u8>
6106 }
6107 impl BogusOnionHopData {
6108         fn new(orig: msgs::OnionHopData) -> Self {
6109                 Self { data: orig.encode() }
6110         }
6111 }
6112 impl Writeable for BogusOnionHopData {
6113         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6114                 writer.write_all(&self.data[..])
6115         }
6116 }
6117
6118 #[test]
6119 fn test_onion_failure() {
6120         use ln::msgs::ChannelUpdate;
6121         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6122         use bitcoin::secp256k1;
6123
6124         const BADONION: u16 = 0x8000;
6125         const PERM: u16 = 0x4000;
6126         const NODE: u16 = 0x2000;
6127         const UPDATE: u16 = 0x1000;
6128
6129         let chanmon_cfgs = create_chanmon_cfgs(3);
6130         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6131         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6132         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6133         for node in nodes.iter() {
6134                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
6135         }
6136         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())];
6137         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6138         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6139         let logger = test_utils::TestLogger::new();
6140         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();
6141         // positve case
6142         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6143
6144         // intermediate node failure
6145         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6146                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6147                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6148                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6149                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6150                 let mut new_payloads = Vec::new();
6151                 for payload in onion_payloads.drain(..) {
6152                         new_payloads.push(BogusOnionHopData::new(payload));
6153                 }
6154                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6155                 // describing a length-1 TLV payload, which is obviously bogus.
6156                 new_payloads[0].data[0] = 1;
6157                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6158         }, ||{}, 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
6159
6160         // final node failure
6161         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6162                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6163                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6164                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6165                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6166                 let mut new_payloads = Vec::new();
6167                 for payload in onion_payloads.drain(..) {
6168                         new_payloads.push(BogusOnionHopData::new(payload));
6169                 }
6170                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6171                 // length-1 TLV payload, which is obviously bogus.
6172                 new_payloads[1].data[0] = 1;
6173                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6174         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6175
6176         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6177         // receiving simulated fail messages
6178         // intermediate node failure
6179         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6180                 // trigger error
6181                 msg.amount_msat -= 1;
6182         }, |msg| {
6183                 // and tamper returning error message
6184                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6185                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6186                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6187         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6188
6189         // final node failure
6190         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6191                 // and tamper returning error message
6192                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6193                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6194                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6195         }, ||{
6196                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6197         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6198
6199         // intermediate node failure
6200         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6201                 msg.amount_msat -= 1;
6202         }, |msg| {
6203                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6204                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6205                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6206         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6207
6208         // final node failure
6209         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6210                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6211                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6212                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6213         }, ||{
6214                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6215         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6216
6217         // intermediate node failure
6218         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6219                 msg.amount_msat -= 1;
6220         }, |msg| {
6221                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6222                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6223                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6224         }, ||{
6225                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6226         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6227
6228         // final node failure
6229         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6230                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6231                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6232                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6233         }, ||{
6234                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6235         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6236
6237         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6238                 Some(BADONION|PERM|4), None);
6239
6240         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6241                 Some(BADONION|PERM|5), None);
6242
6243         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6244                 Some(BADONION|PERM|6), None);
6245
6246         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6247                 msg.amount_msat -= 1;
6248         }, |msg| {
6249                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6250                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6251                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6252         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6253
6254         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6255                 msg.amount_msat -= 1;
6256         }, |msg| {
6257                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6258                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6259                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6260                 // short_channel_id from the processing node
6261         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6262
6263         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6264                 msg.amount_msat -= 1;
6265         }, |msg| {
6266                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6267                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6268                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6269                 // short_channel_id from the processing node
6270         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6271
6272         let mut bogus_route = route.clone();
6273         bogus_route.paths[0][1].short_channel_id -= 1;
6274         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6275           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6276
6277         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6278         let mut bogus_route = route.clone();
6279         let route_len = bogus_route.paths[0].len();
6280         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6281         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6282
6283         //TODO: with new config API, we will be able to generate both valid and
6284         //invalid channel_update cases.
6285         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6286                 msg.amount_msat -= 1;
6287         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6288
6289         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6290                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6291                 msg.cltv_expiry -= 1;
6292         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6293
6294         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6295                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6296                 let block = Block {
6297                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6298                         txdata: vec![],
6299                 };
6300
6301                 connect_block(&nodes[1], &block, height);
6302         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6303
6304         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6305                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6306         }, false, Some(PERM|15), None);
6307
6308         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6309                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6310                 let block = Block {
6311                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6312                         txdata: vec![],
6313                 };
6314
6315                 connect_block(&nodes[2], &block, height);
6316         }, || {}, true, Some(17), None);
6317
6318         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6319                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6320                         for f in pending_forwards.iter_mut() {
6321                                 match f {
6322                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6323                                                 forward_info.outgoing_cltv_value += 1,
6324                                         _ => {},
6325                                 }
6326                         }
6327                 }
6328         }, true, Some(18), None);
6329
6330         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6331                 // violate amt_to_forward > msg.amount_msat
6332                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6333                         for f in pending_forwards.iter_mut() {
6334                                 match f {
6335                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6336                                                 forward_info.amt_to_forward -= 1,
6337                                         _ => {},
6338                                 }
6339                         }
6340                 }
6341         }, true, Some(19), None);
6342
6343         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6344                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6345                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6346                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6347         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6348         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6349
6350         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6351                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6352                 let mut route = route.clone();
6353                 let height = 1;
6354                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6355                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6356                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6357                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6358                 msg.cltv_expiry = htlc_cltv;
6359                 msg.onion_routing_packet = onion_packet;
6360         }, ||{}, true, Some(21), None);
6361 }
6362
6363 #[test]
6364 #[should_panic]
6365 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6366         let chanmon_cfgs = create_chanmon_cfgs(2);
6367         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6368         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6369         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6370         //Force duplicate channel ids
6371         for node in nodes.iter() {
6372                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6373         }
6374
6375         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6376         let channel_value_satoshis=10000;
6377         let push_msat=10001;
6378         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6379         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6380         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6381
6382         //Create a second channel with a channel_id collision
6383         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6384 }
6385
6386 #[test]
6387 fn bolt2_open_channel_sending_node_checks_part2() {
6388         let chanmon_cfgs = create_chanmon_cfgs(2);
6389         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6390         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6391         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6392
6393         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6394         let channel_value_satoshis=2^24;
6395         let push_msat=10001;
6396         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6397
6398         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6399         let channel_value_satoshis=10000;
6400         // Test when push_msat is equal to 1000 * funding_satoshis.
6401         let push_msat=1000*channel_value_satoshis+1;
6402         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6403
6404         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6405         let channel_value_satoshis=10000;
6406         let push_msat=10001;
6407         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
6408         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6409         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6410
6411         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6412         // 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
6413         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6414
6415         // 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.
6416         assert!(BREAKDOWN_TIMEOUT>0);
6417         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6418
6419         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6420         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6421         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6422
6423         // 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.
6424         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6425         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6426         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6427         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6428         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6429 }
6430
6431 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6432 // 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.
6433 //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.
6434
6435 #[test]
6436 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6437         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6438         let chanmon_cfgs = create_chanmon_cfgs(2);
6439         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6440         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6441         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6442         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6443
6444         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6445         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6446         let logger = test_utils::TestLogger::new();
6447         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();
6448         route.paths[0][0].fee_msat = 100;
6449
6450         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6451                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6452         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6453         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6454 }
6455
6456 #[test]
6457 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6458         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6459         let chanmon_cfgs = create_chanmon_cfgs(2);
6460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6462         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6463         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6464         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6465
6466         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6467         let logger = test_utils::TestLogger::new();
6468         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();
6469         route.paths[0][0].fee_msat = 0;
6470         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6471                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6472
6473         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6474         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6475 }
6476
6477 #[test]
6478 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6479         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6480         let chanmon_cfgs = create_chanmon_cfgs(2);
6481         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6482         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6483         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6484         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6485
6486         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6487         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6488         let logger = test_utils::TestLogger::new();
6489         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();
6490         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6491         check_added_monitors!(nodes[0], 1);
6492         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6493         updates.update_add_htlcs[0].amount_msat = 0;
6494
6495         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6496         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6497         check_closed_broadcast!(nodes[1], true).unwrap();
6498         check_added_monitors!(nodes[1], 1);
6499 }
6500
6501 #[test]
6502 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6503         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6504         //It is enforced when constructing a route.
6505         let chanmon_cfgs = create_chanmon_cfgs(2);
6506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6508         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6509         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6510         let logger = test_utils::TestLogger::new();
6511
6512         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6513
6514         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6515         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();
6516         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6517                 assert_eq!(err, &"Channel CLTV overflowed?"));
6518 }
6519
6520 #[test]
6521 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6522         //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.
6523         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6524         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6525         let chanmon_cfgs = create_chanmon_cfgs(2);
6526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6528         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6529         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6530         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6531
6532         let logger = test_utils::TestLogger::new();
6533         for i in 0..max_accepted_htlcs {
6534                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6535                 let payment_event = {
6536                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6537                         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();
6538                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6539                         check_added_monitors!(nodes[0], 1);
6540
6541                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6542                         assert_eq!(events.len(), 1);
6543                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6544                                 assert_eq!(htlcs[0].htlc_id, i);
6545                         } else {
6546                                 assert!(false);
6547                         }
6548                         SendEvent::from_event(events.remove(0))
6549                 };
6550                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6551                 check_added_monitors!(nodes[1], 0);
6552                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6553
6554                 expect_pending_htlcs_forwardable!(nodes[1]);
6555                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6556         }
6557         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6558         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6559         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();
6560         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6561                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6562
6563         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6564         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6565 }
6566
6567 #[test]
6568 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6569         //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.
6570         let chanmon_cfgs = create_chanmon_cfgs(2);
6571         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6572         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6573         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6574         let channel_value = 100000;
6575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6576         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6577
6578         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6579
6580         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6581         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6582         let logger = test_utils::TestLogger::new();
6583         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();
6584         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6585                 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)));
6586
6587         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6588         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);
6589
6590         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6591 }
6592
6593 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6594 #[test]
6595 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6596         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6597         let chanmon_cfgs = create_chanmon_cfgs(2);
6598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6600         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6601         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6602         let htlc_minimum_msat: u64;
6603         {
6604                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6605                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6606                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6607         }
6608
6609         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6610         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6611         let logger = test_utils::TestLogger::new();
6612         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();
6613         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6614         check_added_monitors!(nodes[0], 1);
6615         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6616         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6617         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6618         assert!(nodes[1].node.list_channels().is_empty());
6619         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6620         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()));
6621         check_added_monitors!(nodes[1], 1);
6622 }
6623
6624 #[test]
6625 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6626         //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
6627         let chanmon_cfgs = create_chanmon_cfgs(2);
6628         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6629         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6630         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6631         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6632         let logger = test_utils::TestLogger::new();
6633
6634         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6635         let channel_reserve = chan_stat.channel_reserve_msat;
6636         let feerate = get_feerate!(nodes[0], chan.2);
6637         // The 2* and +1 are for the fee spike reserve.
6638         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6639
6640         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6641         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6642         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6643         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();
6644         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6645         check_added_monitors!(nodes[0], 1);
6646         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6647
6648         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6649         // at this time channel-initiatee receivers are not required to enforce that senders
6650         // respect the fee_spike_reserve.
6651         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6652         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6653
6654         assert!(nodes[1].node.list_channels().is_empty());
6655         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6656         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6657         check_added_monitors!(nodes[1], 1);
6658 }
6659
6660 #[test]
6661 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6662         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6663         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6664         let chanmon_cfgs = create_chanmon_cfgs(2);
6665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6667         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6668         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6669         let logger = test_utils::TestLogger::new();
6670
6671         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6672         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6673
6674         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6675         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();
6676
6677         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6678         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6679         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6680         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6681
6682         let mut msg = msgs::UpdateAddHTLC {
6683                 channel_id: chan.2,
6684                 htlc_id: 0,
6685                 amount_msat: 1000,
6686                 payment_hash: our_payment_hash,
6687                 cltv_expiry: htlc_cltv,
6688                 onion_routing_packet: onion_packet.clone(),
6689         };
6690
6691         for i in 0..super::channel::OUR_MAX_HTLCS {
6692                 msg.htlc_id = i as u64;
6693                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6694         }
6695         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6696         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6697
6698         assert!(nodes[1].node.list_channels().is_empty());
6699         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6700         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6701         check_added_monitors!(nodes[1], 1);
6702 }
6703
6704 #[test]
6705 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6706         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6707         let chanmon_cfgs = create_chanmon_cfgs(2);
6708         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6710         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6711         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6712         let logger = test_utils::TestLogger::new();
6713
6714         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6715         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6716         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();
6717         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6718         check_added_monitors!(nodes[0], 1);
6719         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6720         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6721         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6722
6723         assert!(nodes[1].node.list_channels().is_empty());
6724         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6725         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6726         check_added_monitors!(nodes[1], 1);
6727 }
6728
6729 #[test]
6730 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6731         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6732         let chanmon_cfgs = create_chanmon_cfgs(2);
6733         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6734         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6735         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6736         let logger = test_utils::TestLogger::new();
6737
6738         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6739         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6740         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6741         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();
6742         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6743         check_added_monitors!(nodes[0], 1);
6744         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6745         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6746         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6747
6748         assert!(nodes[1].node.list_channels().is_empty());
6749         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6750         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6751         check_added_monitors!(nodes[1], 1);
6752 }
6753
6754 #[test]
6755 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6756         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6757         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6758         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6759         let chanmon_cfgs = create_chanmon_cfgs(2);
6760         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6761         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6762         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6763         let logger = test_utils::TestLogger::new();
6764
6765         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6766         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6767         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6768         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();
6769         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6770         check_added_monitors!(nodes[0], 1);
6771         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6772         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6773
6774         //Disconnect and Reconnect
6775         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6776         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6777         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6778         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6779         assert_eq!(reestablish_1.len(), 1);
6780         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6781         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6782         assert_eq!(reestablish_2.len(), 1);
6783         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6784         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6785         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6786         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6787
6788         //Resend HTLC
6789         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6790         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6791         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6792         check_added_monitors!(nodes[1], 1);
6793         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6794
6795         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6796
6797         assert!(nodes[1].node.list_channels().is_empty());
6798         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6799         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6800         check_added_monitors!(nodes[1], 1);
6801 }
6802
6803 #[test]
6804 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6805         //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.
6806
6807         let chanmon_cfgs = create_chanmon_cfgs(2);
6808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6810         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6811         let logger = test_utils::TestLogger::new();
6812         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6813         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6814         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6815         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();
6816         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6817
6818         check_added_monitors!(nodes[0], 1);
6819         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6820         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6821
6822         let update_msg = msgs::UpdateFulfillHTLC{
6823                 channel_id: chan.2,
6824                 htlc_id: 0,
6825                 payment_preimage: our_payment_preimage,
6826         };
6827
6828         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6829
6830         assert!(nodes[0].node.list_channels().is_empty());
6831         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6832         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()));
6833         check_added_monitors!(nodes[0], 1);
6834 }
6835
6836 #[test]
6837 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6838         //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.
6839
6840         let chanmon_cfgs = create_chanmon_cfgs(2);
6841         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6842         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6843         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6844         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6845         let logger = test_utils::TestLogger::new();
6846
6847         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6848         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6849         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();
6850         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6851         check_added_monitors!(nodes[0], 1);
6852         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6853         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6854
6855         let update_msg = msgs::UpdateFailHTLC{
6856                 channel_id: chan.2,
6857                 htlc_id: 0,
6858                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6859         };
6860
6861         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6862
6863         assert!(nodes[0].node.list_channels().is_empty());
6864         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6865         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()));
6866         check_added_monitors!(nodes[0], 1);
6867 }
6868
6869 #[test]
6870 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6871         //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.
6872
6873         let chanmon_cfgs = create_chanmon_cfgs(2);
6874         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6875         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6876         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6877         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6878         let logger = test_utils::TestLogger::new();
6879
6880         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6881         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6882         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6883         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6884         check_added_monitors!(nodes[0], 1);
6885         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6886         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6887
6888         let update_msg = msgs::UpdateFailMalformedHTLC{
6889                 channel_id: chan.2,
6890                 htlc_id: 0,
6891                 sha256_of_onion: [1; 32],
6892                 failure_code: 0x8000,
6893         };
6894
6895         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6896
6897         assert!(nodes[0].node.list_channels().is_empty());
6898         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6899         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()));
6900         check_added_monitors!(nodes[0], 1);
6901 }
6902
6903 #[test]
6904 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6905         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6906
6907         let chanmon_cfgs = create_chanmon_cfgs(2);
6908         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6909         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6910         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6911         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6912
6913         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6914
6915         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6916         check_added_monitors!(nodes[1], 1);
6917
6918         let events = nodes[1].node.get_and_clear_pending_msg_events();
6919         assert_eq!(events.len(), 1);
6920         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6921                 match events[0] {
6922                         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, .. } } => {
6923                                 assert!(update_add_htlcs.is_empty());
6924                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6925                                 assert!(update_fail_htlcs.is_empty());
6926                                 assert!(update_fail_malformed_htlcs.is_empty());
6927                                 assert!(update_fee.is_none());
6928                                 update_fulfill_htlcs[0].clone()
6929                         },
6930                         _ => panic!("Unexpected event"),
6931                 }
6932         };
6933
6934         update_fulfill_msg.htlc_id = 1;
6935
6936         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6937
6938         assert!(nodes[0].node.list_channels().is_empty());
6939         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6940         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6941         check_added_monitors!(nodes[0], 1);
6942 }
6943
6944 #[test]
6945 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6946         //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.
6947
6948         let chanmon_cfgs = create_chanmon_cfgs(2);
6949         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6950         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6951         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6952         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6953
6954         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6955
6956         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6957         check_added_monitors!(nodes[1], 1);
6958
6959         let events = nodes[1].node.get_and_clear_pending_msg_events();
6960         assert_eq!(events.len(), 1);
6961         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6962                 match events[0] {
6963                         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, .. } } => {
6964                                 assert!(update_add_htlcs.is_empty());
6965                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6966                                 assert!(update_fail_htlcs.is_empty());
6967                                 assert!(update_fail_malformed_htlcs.is_empty());
6968                                 assert!(update_fee.is_none());
6969                                 update_fulfill_htlcs[0].clone()
6970                         },
6971                         _ => panic!("Unexpected event"),
6972                 }
6973         };
6974
6975         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6976
6977         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6978
6979         assert!(nodes[0].node.list_channels().is_empty());
6980         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6981         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6982         check_added_monitors!(nodes[0], 1);
6983 }
6984
6985 #[test]
6986 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6987         //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.
6988
6989         let chanmon_cfgs = create_chanmon_cfgs(2);
6990         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6991         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6992         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6993         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6994         let logger = test_utils::TestLogger::new();
6995
6996         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6997         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6998         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();
6999         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7000         check_added_monitors!(nodes[0], 1);
7001
7002         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7003         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7004
7005         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7006         check_added_monitors!(nodes[1], 0);
7007         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7008
7009         let events = nodes[1].node.get_and_clear_pending_msg_events();
7010
7011         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7012                 match events[0] {
7013                         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, .. } } => {
7014                                 assert!(update_add_htlcs.is_empty());
7015                                 assert!(update_fulfill_htlcs.is_empty());
7016                                 assert!(update_fail_htlcs.is_empty());
7017                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7018                                 assert!(update_fee.is_none());
7019                                 update_fail_malformed_htlcs[0].clone()
7020                         },
7021                         _ => panic!("Unexpected event"),
7022                 }
7023         };
7024         update_msg.failure_code &= !0x8000;
7025         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7026
7027         assert!(nodes[0].node.list_channels().is_empty());
7028         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7029         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7030         check_added_monitors!(nodes[0], 1);
7031 }
7032
7033 #[test]
7034 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7035         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7036         //    * 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.
7037
7038         let chanmon_cfgs = create_chanmon_cfgs(3);
7039         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7040         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7041         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7042         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7043         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7044         let logger = test_utils::TestLogger::new();
7045
7046         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7047
7048         //First hop
7049         let mut payment_event = {
7050                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7051                 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();
7052                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7053                 check_added_monitors!(nodes[0], 1);
7054                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7055                 assert_eq!(events.len(), 1);
7056                 SendEvent::from_event(events.remove(0))
7057         };
7058         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7059         check_added_monitors!(nodes[1], 0);
7060         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7061         expect_pending_htlcs_forwardable!(nodes[1]);
7062         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7063         assert_eq!(events_2.len(), 1);
7064         check_added_monitors!(nodes[1], 1);
7065         payment_event = SendEvent::from_event(events_2.remove(0));
7066         assert_eq!(payment_event.msgs.len(), 1);
7067
7068         //Second Hop
7069         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7070         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7071         check_added_monitors!(nodes[2], 0);
7072         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7073
7074         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7075         assert_eq!(events_3.len(), 1);
7076         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7077                 match events_3[0] {
7078                         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 } } => {
7079                                 assert!(update_add_htlcs.is_empty());
7080                                 assert!(update_fulfill_htlcs.is_empty());
7081                                 assert!(update_fail_htlcs.is_empty());
7082                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7083                                 assert!(update_fee.is_none());
7084                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7085                         },
7086                         _ => panic!("Unexpected event"),
7087                 }
7088         };
7089
7090         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7091
7092         check_added_monitors!(nodes[1], 0);
7093         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7094         expect_pending_htlcs_forwardable!(nodes[1]);
7095         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7096         assert_eq!(events_4.len(), 1);
7097
7098         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7099         match events_4[0] {
7100                 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, .. } } => {
7101                         assert!(update_add_htlcs.is_empty());
7102                         assert!(update_fulfill_htlcs.is_empty());
7103                         assert_eq!(update_fail_htlcs.len(), 1);
7104                         assert!(update_fail_malformed_htlcs.is_empty());
7105                         assert!(update_fee.is_none());
7106                 },
7107                 _ => panic!("Unexpected event"),
7108         };
7109
7110         check_added_monitors!(nodes[1], 1);
7111 }
7112
7113 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7114         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7115         // 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
7116         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7117
7118         let chanmon_cfgs = create_chanmon_cfgs(2);
7119         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7120         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7121         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7122         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7123
7124         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7125
7126         // We route 2 dust-HTLCs between A and B
7127         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7128         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7129         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7130
7131         // Cache one local commitment tx as previous
7132         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7133
7134         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7135         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7136         check_added_monitors!(nodes[1], 0);
7137         expect_pending_htlcs_forwardable!(nodes[1]);
7138         check_added_monitors!(nodes[1], 1);
7139
7140         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7141         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7142         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7143         check_added_monitors!(nodes[0], 1);
7144
7145         // Cache one local commitment tx as lastest
7146         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7147
7148         let events = nodes[0].node.get_and_clear_pending_msg_events();
7149         match events[0] {
7150                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7151                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7152                 },
7153                 _ => panic!("Unexpected event"),
7154         }
7155         match events[1] {
7156                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7157                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7158                 },
7159                 _ => panic!("Unexpected event"),
7160         }
7161
7162         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7163         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7164         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7165
7166         if announce_latest {
7167                 connect_block(&nodes[0], &Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7168         } else {
7169                 connect_block(&nodes[0], &Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7170         }
7171
7172         check_closed_broadcast!(nodes[0], false);
7173         check_added_monitors!(nodes[0], 1);
7174
7175         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7176         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
7177         let events = nodes[0].node.get_and_clear_pending_events();
7178         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7179         assert_eq!(events.len(), 2);
7180         let mut first_failed = false;
7181         for event in events {
7182                 match event {
7183                         Event::PaymentFailed { payment_hash, .. } => {
7184                                 if payment_hash == payment_hash_1 {
7185                                         assert!(!first_failed);
7186                                         first_failed = true;
7187                                 } else {
7188                                         assert_eq!(payment_hash, payment_hash_2);
7189                                 }
7190                         }
7191                         _ => panic!("Unexpected event"),
7192                 }
7193         }
7194 }
7195
7196 #[test]
7197 fn test_failure_delay_dust_htlc_local_commitment() {
7198         do_test_failure_delay_dust_htlc_local_commitment(true);
7199         do_test_failure_delay_dust_htlc_local_commitment(false);
7200 }
7201
7202 #[test]
7203 fn test_no_failure_dust_htlc_local_commitment() {
7204         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7205         // prone to error, we test here that a dummy transaction don't fail them.
7206
7207         let chanmon_cfgs = create_chanmon_cfgs(2);
7208         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7209         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7210         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7211         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7212
7213         // Rebalance a bit
7214         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7215
7216         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7217         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7218
7219         // We route 2 dust-HTLCs between A and B
7220         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7221         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7222
7223         // Build a dummy invalid transaction trying to spend a commitment tx
7224         let input = TxIn {
7225                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7226                 script_sig: Script::new(),
7227                 sequence: 0,
7228                 witness: Vec::new(),
7229         };
7230
7231         let outp = TxOut {
7232                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7233                 value: 10000,
7234         };
7235
7236         let dummy_tx = Transaction {
7237                 version: 2,
7238                 lock_time: 0,
7239                 input: vec![input],
7240                 output: vec![outp]
7241         };
7242
7243         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7244         nodes[0].chan_monitor.simple_monitor.block_connected(&header, &[(0, &dummy_tx)], 1);
7245         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7246         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7247         // We broadcast a few more block to check everything is all right
7248         connect_blocks(&nodes[0], 20, 1, true, header.bitcoin_hash());
7249         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7250         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7251
7252         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7253         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7254 }
7255
7256 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7257         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7258         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7259         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7260         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7261         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7262         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7263
7264         let chanmon_cfgs = create_chanmon_cfgs(3);
7265         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7266         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7267         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7268         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7269
7270         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7271
7272         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7273         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7274
7275         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7276         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7277
7278         // We revoked bs_commitment_tx
7279         if revoked {
7280                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7281                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7282         }
7283
7284         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7285         let mut timeout_tx = Vec::new();
7286         if local {
7287                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7288                 connect_block(&nodes[0], &Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7289                 check_closed_broadcast!(nodes[0], false);
7290                 check_added_monitors!(nodes[0], 1);
7291                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7292                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7293                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7294                 expect_payment_failed!(nodes[0], dust_hash, true);
7295                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7296                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7297                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7298                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7299                 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7300                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7301                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7302                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7303         } else {
7304                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7305                 connect_block(&nodes[0], &Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7306                 check_closed_broadcast!(nodes[0], false);
7307                 check_added_monitors!(nodes[0], 1);
7308                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7309                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7310                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7311                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7312                 if !revoked {
7313                         expect_payment_failed!(nodes[0], dust_hash, true);
7314                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7315                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7316                         connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7317                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7318                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7319                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7320                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7321                 } else {
7322                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7323                         // commitment tx
7324                         let events = nodes[0].node.get_and_clear_pending_events();
7325                         assert_eq!(events.len(), 2);
7326                         let first;
7327                         match events[0] {
7328                                 Event::PaymentFailed { payment_hash, .. } => {
7329                                         if payment_hash == dust_hash { first = true; }
7330                                         else { first = false; }
7331                                 },
7332                                 _ => panic!("Unexpected event"),
7333                         }
7334                         match events[1] {
7335                                 Event::PaymentFailed { payment_hash, .. } => {
7336                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7337                                         else { assert_eq!(payment_hash, dust_hash); }
7338                                 },
7339                                 _ => panic!("Unexpected event"),
7340                         }
7341                 }
7342         }
7343 }
7344
7345 #[test]
7346 fn test_sweep_outbound_htlc_failure_update() {
7347         do_test_sweep_outbound_htlc_failure_update(false, true);
7348         do_test_sweep_outbound_htlc_failure_update(false, false);
7349         do_test_sweep_outbound_htlc_failure_update(true, false);
7350 }
7351
7352 #[test]
7353 fn test_upfront_shutdown_script() {
7354         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7355         // enforce it at shutdown message
7356
7357         let mut config = UserConfig::default();
7358         config.channel_options.announced_channel = true;
7359         config.peer_channel_config_limits.force_announced_channel_preference = false;
7360         config.channel_options.commit_upfront_shutdown_pubkey = false;
7361         let user_cfgs = [None, Some(config), None];
7362         let chanmon_cfgs = create_chanmon_cfgs(3);
7363         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7364         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7365         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7366
7367         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7368         let flags = InitFeatures::known();
7369         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7370         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7371         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7372         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7373         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7374         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7375     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()));
7376         check_added_monitors!(nodes[2], 1);
7377
7378         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7379         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7380         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7381         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7382         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7383         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7384         let events = nodes[2].node.get_and_clear_pending_msg_events();
7385         assert_eq!(events.len(), 1);
7386         match events[0] {
7387                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7388                 _ => panic!("Unexpected event"),
7389         }
7390
7391         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7392         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7393         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7394         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7395         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7396         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7397         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7398         let events = nodes[1].node.get_and_clear_pending_msg_events();
7399         assert_eq!(events.len(), 1);
7400         match events[0] {
7401                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7402                 _ => panic!("Unexpected event"),
7403         }
7404
7405         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7406         // channel smoothly, opt-out is from channel initiator here
7407         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7408         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7409         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7410         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7411         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7412         let events = nodes[0].node.get_and_clear_pending_msg_events();
7413         assert_eq!(events.len(), 1);
7414         match events[0] {
7415                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7416                 _ => panic!("Unexpected event"),
7417         }
7418
7419         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7420         //// channel smoothly
7421         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7422         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7423         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7424         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7425         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7426         let events = nodes[0].node.get_and_clear_pending_msg_events();
7427         assert_eq!(events.len(), 2);
7428         match events[0] {
7429                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7430                 _ => panic!("Unexpected event"),
7431         }
7432         match events[1] {
7433                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7434                 _ => panic!("Unexpected event"),
7435         }
7436 }
7437
7438 #[test]
7439 fn test_user_configurable_csv_delay() {
7440         // We test our channel constructors yield errors when we pass them absurd csv delay
7441
7442         let mut low_our_to_self_config = UserConfig::default();
7443         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7444         let mut high_their_to_self_config = UserConfig::default();
7445         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7446         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7447         let chanmon_cfgs = create_chanmon_cfgs(2);
7448         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7449         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7450         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7451
7452         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7453         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7454         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) {
7455                 match error {
7456                         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())); },
7457                         _ => panic!("Unexpected event"),
7458                 }
7459         } else { assert!(false) }
7460
7461         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7462         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7463         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7464         open_channel.to_self_delay = 200;
7465         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) {
7466                 match error {
7467                         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()));  },
7468                         _ => panic!("Unexpected event"),
7469                 }
7470         } else { assert!(false); }
7471
7472         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7473         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7474         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()));
7475         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7476         accept_channel.to_self_delay = 200;
7477         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7478         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7479                 match action {
7480                         &ErrorAction::SendErrorMessage { ref msg } => {
7481                                 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()));
7482                         },
7483                         _ => { assert!(false); }
7484                 }
7485         } else { assert!(false); }
7486
7487         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7488         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7489         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7490         open_channel.to_self_delay = 200;
7491         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) {
7492                 match error {
7493                         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())); },
7494                         _ => panic!("Unexpected event"),
7495                 }
7496         } else { assert!(false); }
7497 }
7498
7499 #[test]
7500 fn test_data_loss_protect() {
7501         // We want to be sure that :
7502         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7503         // * we close channel in case of detecting other being fallen behind
7504         // * we are able to claim our own outputs thanks to to_remote being static
7505         let keys_manager;
7506         let logger;
7507         let fee_estimator;
7508         let tx_broadcaster;
7509         let chain_monitor;
7510         let monitor;
7511         let node_state_0;
7512         let chanmon_cfgs = create_chanmon_cfgs(2);
7513         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7514         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7515         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7516
7517         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7518
7519         // Cache node A state before any channel update
7520         let previous_node_state = nodes[0].node.encode();
7521         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7522         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7523
7524         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7525         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7526
7527         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7528         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7529
7530         // Restore node A from previous state
7531         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7532         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7533         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7534         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7535         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7536         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7537         monitor = test_utils::TestChannelMonitor::new(&tx_broadcaster, &logger, &fee_estimator);
7538         node_state_0 = {
7539                 let mut channel_monitors = HashMap::new();
7540                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7541                 <(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 {
7542                         keys_manager: &keys_manager,
7543                         fee_estimator: &fee_estimator,
7544                         monitor: &monitor,
7545                         logger: &logger,
7546                         tx_broadcaster: &tx_broadcaster,
7547                         default_config: UserConfig::default(),
7548                         channel_monitors: &mut channel_monitors,
7549                 }).unwrap().1
7550         };
7551         nodes[0].node = &node_state_0;
7552         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7553         nodes[0].chan_monitor = &monitor;
7554         nodes[0].chain_monitor = &chain_monitor;
7555
7556         nodes[0].block_notifier = BlockNotifier::new();
7557         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7558         nodes[0].block_notifier.register_listener(nodes[0].node);
7559
7560         check_added_monitors!(nodes[0], 1);
7561
7562         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7563         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7564
7565         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7566
7567         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7568         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7569         check_added_monitors!(nodes[0], 1);
7570
7571         {
7572                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7573                 assert_eq!(node_txn.len(), 0);
7574         }
7575
7576         let mut reestablish_1 = Vec::with_capacity(1);
7577         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7578                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7579                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7580                         reestablish_1.push(msg.clone());
7581                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7582                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7583                         match action {
7584                                 &ErrorAction::SendErrorMessage { ref msg } => {
7585                                         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");
7586                                 },
7587                                 _ => panic!("Unexpected event!"),
7588                         }
7589                 } else {
7590                         panic!("Unexpected event")
7591                 }
7592         }
7593
7594         // Check we close channel detecting A is fallen-behind
7595         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7596         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7597         check_added_monitors!(nodes[1], 1);
7598
7599
7600         // Check A is able to claim to_remote output
7601         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7602         assert_eq!(node_txn.len(), 1);
7603         check_spends!(node_txn[0], chan.3);
7604         assert_eq!(node_txn[0].output.len(), 2);
7605         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7606         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7607         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7608         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7609         assert_eq!(spend_txn.len(), 1);
7610         check_spends!(spend_txn[0], node_txn[0]);
7611 }
7612
7613 #[test]
7614 fn test_check_htlc_underpaying() {
7615         // Send payment through A -> B but A is maliciously
7616         // sending a probe payment (i.e less than expected value0
7617         // to B, B should refuse payment.
7618
7619         let chanmon_cfgs = create_chanmon_cfgs(2);
7620         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7621         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7622         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7623
7624         // Create some initial channels
7625         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7626
7627         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7628
7629         // Node 3 is expecting payment of 100_000 but receive 10_000,
7630         // fail htlc like we didn't know the preimage.
7631         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7632         nodes[1].node.process_pending_htlc_forwards();
7633
7634         let events = nodes[1].node.get_and_clear_pending_msg_events();
7635         assert_eq!(events.len(), 1);
7636         let (update_fail_htlc, commitment_signed) = match events[0] {
7637                 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 } } => {
7638                         assert!(update_add_htlcs.is_empty());
7639                         assert!(update_fulfill_htlcs.is_empty());
7640                         assert_eq!(update_fail_htlcs.len(), 1);
7641                         assert!(update_fail_malformed_htlcs.is_empty());
7642                         assert!(update_fee.is_none());
7643                         (update_fail_htlcs[0].clone(), commitment_signed)
7644                 },
7645                 _ => panic!("Unexpected event"),
7646         };
7647         check_added_monitors!(nodes[1], 1);
7648
7649         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7650         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7651
7652         // 10_000 msat as u64, followed by a height of 99 as u32
7653         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7654         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7655         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7656         nodes[1].node.get_and_clear_pending_events();
7657 }
7658
7659 #[test]
7660 fn test_announce_disable_channels() {
7661         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7662         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7663
7664         let chanmon_cfgs = create_chanmon_cfgs(2);
7665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7667         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7668
7669         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7670         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7671         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7672
7673         // Disconnect peers
7674         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7675         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7676
7677         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7678         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7679         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7680         assert_eq!(msg_events.len(), 3);
7681         for e in msg_events {
7682                 match e {
7683                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7684                                 let short_id = msg.contents.short_channel_id;
7685                                 // Check generated channel_update match list in PendingChannelUpdate
7686                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7687                                         panic!("Generated ChannelUpdate for wrong chan!");
7688                                 }
7689                         },
7690                         _ => panic!("Unexpected event"),
7691                 }
7692         }
7693         // Reconnect peers
7694         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7695         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7696         assert_eq!(reestablish_1.len(), 3);
7697         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7698         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7699         assert_eq!(reestablish_2.len(), 3);
7700
7701         // Reestablish chan_1
7702         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7703         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7704         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7705         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7706         // Reestablish chan_2
7707         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7708         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7709         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7710         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7711         // Reestablish chan_3
7712         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7713         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7714         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7715         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7716
7717         nodes[0].node.timer_chan_freshness_every_min();
7718         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7719 }
7720
7721 #[test]
7722 fn test_bump_penalty_txn_on_revoked_commitment() {
7723         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7724         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7725
7726         let chanmon_cfgs = create_chanmon_cfgs(2);
7727         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7728         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7729         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7730
7731         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7732         let logger = test_utils::TestLogger::new();
7733
7734
7735         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7736         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7737         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();
7738         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7739
7740         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7741         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7742         assert_eq!(revoked_txn[0].output.len(), 4);
7743         assert_eq!(revoked_txn[0].input.len(), 1);
7744         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7745         let revoked_txid = revoked_txn[0].txid();
7746
7747         let mut penalty_sum = 0;
7748         for outp in revoked_txn[0].output.iter() {
7749                 if outp.script_pubkey.is_v0_p2wsh() {
7750                         penalty_sum += outp.value;
7751                 }
7752         }
7753
7754         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7755         let header_114 = connect_blocks(&nodes[1], 114, 0, false, Default::default());
7756
7757         // Actually revoke tx by claiming a HTLC
7758         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7759         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7760         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7761         check_added_monitors!(nodes[1], 1);
7762
7763         // One or more justice tx should have been broadcast, check it
7764         let penalty_1;
7765         let feerate_1;
7766         {
7767                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7768                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7769                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7770                 assert_eq!(node_txn[0].output.len(), 1);
7771                 check_spends!(node_txn[0], revoked_txn[0]);
7772                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7773                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7774                 penalty_1 = node_txn[0].txid();
7775                 node_txn.clear();
7776         };
7777
7778         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7779         let header = connect_blocks(&nodes[1], 3, 115,  true, header.bitcoin_hash());
7780         let mut penalty_2 = penalty_1;
7781         let mut feerate_2 = 0;
7782         {
7783                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7784                 assert_eq!(node_txn.len(), 1);
7785                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7786                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7787                         assert_eq!(node_txn[0].output.len(), 1);
7788                         check_spends!(node_txn[0], revoked_txn[0]);
7789                         penalty_2 = node_txn[0].txid();
7790                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7791                         assert_ne!(penalty_2, penalty_1);
7792                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7793                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7794                         // Verify 25% bump heuristic
7795                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7796                         node_txn.clear();
7797                 }
7798         }
7799         assert_ne!(feerate_2, 0);
7800
7801         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7802         connect_blocks(&nodes[1], 3, 118, true, header);
7803         let penalty_3;
7804         let mut feerate_3 = 0;
7805         {
7806                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7807                 assert_eq!(node_txn.len(), 1);
7808                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7809                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7810                         assert_eq!(node_txn[0].output.len(), 1);
7811                         check_spends!(node_txn[0], revoked_txn[0]);
7812                         penalty_3 = node_txn[0].txid();
7813                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7814                         assert_ne!(penalty_3, penalty_2);
7815                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7816                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7817                         // Verify 25% bump heuristic
7818                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7819                         node_txn.clear();
7820                 }
7821         }
7822         assert_ne!(feerate_3, 0);
7823
7824         nodes[1].node.get_and_clear_pending_events();
7825         nodes[1].node.get_and_clear_pending_msg_events();
7826 }
7827
7828 #[test]
7829 fn test_bump_penalty_txn_on_revoked_htlcs() {
7830         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7831         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7832
7833         let chanmon_cfgs = create_chanmon_cfgs(2);
7834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7836         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7837
7838         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7839         // Lock HTLC in both directions
7840         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7841         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7842
7843         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7844         assert_eq!(revoked_local_txn[0].input.len(), 1);
7845         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7846
7847         // Revoke local commitment tx
7848         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7849
7850         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7851         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7852         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7853         check_closed_broadcast!(nodes[1], false);
7854         check_added_monitors!(nodes[1], 1);
7855
7856         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7857         assert_eq!(revoked_htlc_txn.len(), 4);
7858         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7859                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7860                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7861                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7862                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7863                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7864         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7865                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7866                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7867                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7868                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7869                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7870         }
7871
7872         // Broadcast set of revoked txn on A
7873         let header_128 = connect_blocks(&nodes[0], 128, 0, true, header.bitcoin_hash());
7874         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7875
7876         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7877         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7878         let first;
7879         let feerate_1;
7880         let penalty_txn;
7881         {
7882                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7883                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7884                 // Verify claim tx are spending revoked HTLC txn
7885                 assert_eq!(node_txn[3].input.len(), 2);
7886                 assert_eq!(node_txn[3].output.len(), 1);
7887                 check_spends!(node_txn[3], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7888                 first = node_txn[3].txid();
7889                 // Store both feerates for later comparison
7890                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[3].output[0].value;
7891                 feerate_1 = fee_1 * 1000 / node_txn[3].get_weight() as u64;
7892                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7893                 node_txn.clear();
7894         }
7895
7896         // Connect three more block to see if bumped penalty are issued for HTLC txn
7897         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7898         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
7899         {
7900                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7901                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7902
7903                 check_spends!(node_txn[0], revoked_local_txn[0]);
7904                 check_spends!(node_txn[1], revoked_local_txn[0]);
7905
7906                 node_txn.clear();
7907         };
7908
7909         // Few more blocks to confirm penalty txn
7910         let header_135 = connect_blocks(&nodes[0], 5, 130, true, header_130.bitcoin_hash());
7911         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7912         let header_144 = connect_blocks(&nodes[0], 9, 135, true, header_135);
7913         let node_txn = {
7914                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7915                 assert_eq!(node_txn.len(), 1);
7916
7917                 assert_eq!(node_txn[0].input.len(), 2);
7918                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7919                 // Verify bumped tx is different and 25% bump heuristic
7920                 assert_ne!(first, node_txn[0].txid());
7921                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7922                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7923                 assert!(feerate_2 * 100 > feerate_1 * 125);
7924                 let txn = vec![node_txn[0].clone()];
7925                 node_txn.clear();
7926                 txn
7927         };
7928         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7929         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7930         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, 145);
7931         connect_blocks(&nodes[0], 20, 145, true, header_145.bitcoin_hash());
7932         {
7933                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7934                 // We verify than no new transaction has been broadcast because previously
7935                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7936                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7937                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7938                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7939                 // up bumped justice generation.
7940                 assert_eq!(node_txn.len(), 0);
7941                 node_txn.clear();
7942         }
7943         check_closed_broadcast!(nodes[0], false);
7944         check_added_monitors!(nodes[0], 1);
7945 }
7946
7947 #[test]
7948 fn test_bump_penalty_txn_on_remote_commitment() {
7949         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7950         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7951
7952         // Create 2 HTLCs
7953         // Provide preimage for one
7954         // Check aggregation
7955
7956         let chanmon_cfgs = create_chanmon_cfgs(2);
7957         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7958         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7959         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7960
7961         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7962         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7963         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7964
7965         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7966         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7967         assert_eq!(remote_txn[0].output.len(), 4);
7968         assert_eq!(remote_txn[0].input.len(), 1);
7969         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7970
7971         // Claim a HTLC without revocation (provide B monitor with preimage)
7972         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7973         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7974         connect_block(&nodes[1], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7975         check_added_monitors!(nodes[1], 2);
7976
7977         // One or more claim tx should have been broadcast, check it
7978         let timeout;
7979         let preimage;
7980         let feerate_timeout;
7981         let feerate_preimage;
7982         {
7983                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7984                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7985                 assert_eq!(node_txn[0].input.len(), 1);
7986                 assert_eq!(node_txn[1].input.len(), 1);
7987                 check_spends!(node_txn[0], remote_txn[0]);
7988                 check_spends!(node_txn[1], remote_txn[0]);
7989                 check_spends!(node_txn[2], chan.3);
7990                 check_spends!(node_txn[3], node_txn[2]);
7991                 check_spends!(node_txn[4], node_txn[2]);
7992                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7993                         timeout = node_txn[0].txid();
7994                         let index = node_txn[0].input[0].previous_output.vout;
7995                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7996                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7997
7998                         preimage = node_txn[1].txid();
7999                         let index = node_txn[1].input[0].previous_output.vout;
8000                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8001                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8002                 } else {
8003                         timeout = node_txn[1].txid();
8004                         let index = node_txn[1].input[0].previous_output.vout;
8005                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8006                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8007
8008                         preimage = node_txn[0].txid();
8009                         let index = node_txn[0].input[0].previous_output.vout;
8010                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8011                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8012                 }
8013                 node_txn.clear();
8014         };
8015         assert_ne!(feerate_timeout, 0);
8016         assert_ne!(feerate_preimage, 0);
8017
8018         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8019         connect_blocks(&nodes[1], 15, 1,  true, header.bitcoin_hash());
8020         {
8021                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8022                 assert_eq!(node_txn.len(), 2);
8023                 assert_eq!(node_txn[0].input.len(), 1);
8024                 assert_eq!(node_txn[1].input.len(), 1);
8025                 check_spends!(node_txn[0], remote_txn[0]);
8026                 check_spends!(node_txn[1], remote_txn[0]);
8027                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8028                         let index = node_txn[0].input[0].previous_output.vout;
8029                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8030                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8031                         assert!(new_feerate * 100 > feerate_timeout * 125);
8032                         assert_ne!(timeout, node_txn[0].txid());
8033
8034                         let index = node_txn[1].input[0].previous_output.vout;
8035                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8036                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8037                         assert!(new_feerate * 100 > feerate_preimage * 125);
8038                         assert_ne!(preimage, node_txn[1].txid());
8039                 } else {
8040                         let index = node_txn[1].input[0].previous_output.vout;
8041                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8042                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8043                         assert!(new_feerate * 100 > feerate_timeout * 125);
8044                         assert_ne!(timeout, node_txn[1].txid());
8045
8046                         let index = node_txn[0].input[0].previous_output.vout;
8047                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8048                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8049                         assert!(new_feerate * 100 > feerate_preimage * 125);
8050                         assert_ne!(preimage, node_txn[0].txid());
8051                 }
8052                 node_txn.clear();
8053         }
8054
8055         nodes[1].node.get_and_clear_pending_events();
8056         nodes[1].node.get_and_clear_pending_msg_events();
8057 }
8058
8059 #[test]
8060 fn test_set_outpoints_partial_claiming() {
8061         // - remote party claim tx, new bump tx
8062         // - disconnect remote claiming tx, new bump
8063         // - disconnect tx, see no tx anymore
8064         let chanmon_cfgs = create_chanmon_cfgs(2);
8065         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8066         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8067         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8068
8069         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8070         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8071         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8072
8073         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8074         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8075         assert_eq!(remote_txn.len(), 3);
8076         assert_eq!(remote_txn[0].output.len(), 4);
8077         assert_eq!(remote_txn[0].input.len(), 1);
8078         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8079         check_spends!(remote_txn[1], remote_txn[0]);
8080         check_spends!(remote_txn[2], remote_txn[0]);
8081
8082         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8083         let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
8084         // Provide node A with both preimage
8085         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8086         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8087         check_added_monitors!(nodes[0], 2);
8088         nodes[0].node.get_and_clear_pending_events();
8089         nodes[0].node.get_and_clear_pending_msg_events();
8090
8091         // Connect blocks on node A commitment transaction
8092         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8093         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8094         check_closed_broadcast!(nodes[0], false);
8095         check_added_monitors!(nodes[0], 1);
8096         // Verify node A broadcast tx claiming both HTLCs
8097         {
8098                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8099                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8100                 assert_eq!(node_txn.len(), 4);
8101                 check_spends!(node_txn[0], remote_txn[0]);
8102                 check_spends!(node_txn[1], chan.3);
8103                 check_spends!(node_txn[2], node_txn[1]);
8104                 check_spends!(node_txn[3], node_txn[1]);
8105                 assert_eq!(node_txn[0].input.len(), 2);
8106                 node_txn.clear();
8107         }
8108
8109         // Connect blocks on node B
8110         connect_blocks(&nodes[1], 135, 0, false, Default::default());
8111         check_closed_broadcast!(nodes[1], false);
8112         check_added_monitors!(nodes[1], 1);
8113         // Verify node B broadcast 2 HTLC-timeout txn
8114         let partial_claim_tx = {
8115                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8116                 assert_eq!(node_txn.len(), 3);
8117                 check_spends!(node_txn[1], node_txn[0]);
8118                 check_spends!(node_txn[2], node_txn[0]);
8119                 assert_eq!(node_txn[1].input.len(), 1);
8120                 assert_eq!(node_txn[2].input.len(), 1);
8121                 node_txn[1].clone()
8122         };
8123
8124         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8125         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8126         connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8127         {
8128                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8129                 assert_eq!(node_txn.len(), 1);
8130                 check_spends!(node_txn[0], remote_txn[0]);
8131                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8132                 node_txn.clear();
8133         }
8134         nodes[0].node.get_and_clear_pending_msg_events();
8135
8136         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8137         disconnect_block(&nodes[0], &header, 102);
8138         {
8139                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8140                 assert_eq!(node_txn.len(), 1);
8141                 check_spends!(node_txn[0], remote_txn[0]);
8142                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8143                 node_txn.clear();
8144         }
8145
8146         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8147         disconnect_block(&nodes[0], &header, 101);
8148         connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
8149         {
8150                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8151                 assert_eq!(node_txn.len(), 0);
8152                 node_txn.clear();
8153         }
8154 }
8155
8156 #[test]
8157 fn test_counterparty_raa_skip_no_crash() {
8158         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8159         // commitment transaction, we would have happily carried on and provided them the next
8160         // commitment transaction based on one RAA forward. This would probably eventually have led to
8161         // channel closure, but it would not have resulted in funds loss. Still, our
8162         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8163         // check simply that the channel is closed in response to such an RAA, but don't check whether
8164         // we decide to punish our counterparty for revoking their funds (as we don't currently
8165         // implement that).
8166         let chanmon_cfgs = create_chanmon_cfgs(2);
8167         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8168         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8169         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8170         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8171
8172         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8173         let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8174         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8175         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8176                 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8177         let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8178
8179         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8180                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8181         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8182         check_added_monitors!(nodes[1], 1);
8183 }
8184
8185 #[test]
8186 fn test_bump_txn_sanitize_tracking_maps() {
8187         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8188         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8189
8190         let chanmon_cfgs = create_chanmon_cfgs(2);
8191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8193         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8194
8195         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8196         // Lock HTLC in both directions
8197         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8198         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8199
8200         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8201         assert_eq!(revoked_local_txn[0].input.len(), 1);
8202         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8203
8204         // Revoke local commitment tx
8205         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8206
8207         // Broadcast set of revoked txn on A
8208         let header_128 = connect_blocks(&nodes[0], 128, 0,  false, Default::default());
8209         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8210
8211         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8212         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8213         check_closed_broadcast!(nodes[0], false);
8214         check_added_monitors!(nodes[0], 1);
8215         let penalty_txn = {
8216                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8217                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8218                 check_spends!(node_txn[0], revoked_local_txn[0]);
8219                 check_spends!(node_txn[1], revoked_local_txn[0]);
8220                 check_spends!(node_txn[2], revoked_local_txn[0]);
8221                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8222                 node_txn.clear();
8223                 penalty_txn
8224         };
8225         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8226         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
8227         connect_blocks(&nodes[0], 5, 130,  false, header_130.bitcoin_hash());
8228         {
8229                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8230                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8231                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8232                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8233                 }
8234         }
8235 }
8236
8237 #[test]
8238 fn test_override_channel_config() {
8239         let chanmon_cfgs = create_chanmon_cfgs(2);
8240         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8241         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8242         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8243
8244         // Node0 initiates a channel to node1 using the override config.
8245         let mut override_config = UserConfig::default();
8246         override_config.own_channel_config.our_to_self_delay = 200;
8247
8248         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8249
8250         // Assert the channel created by node0 is using the override config.
8251         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8252         assert_eq!(res.channel_flags, 0);
8253         assert_eq!(res.to_self_delay, 200);
8254 }
8255
8256 #[test]
8257 fn test_override_0msat_htlc_minimum() {
8258         let mut zero_config = UserConfig::default();
8259         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8260         let chanmon_cfgs = create_chanmon_cfgs(2);
8261         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8262         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8263         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8264
8265         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8266         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8267         assert_eq!(res.htlc_minimum_msat, 1);
8268
8269         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8270         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8271         assert_eq!(res.htlc_minimum_msat, 1);
8272 }
8273
8274 #[test]
8275 fn test_simple_payment_secret() {
8276         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8277         // features, however.
8278         let chanmon_cfgs = create_chanmon_cfgs(3);
8279         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8280         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8281         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8282
8283         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8284         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8285         let logger = test_utils::TestLogger::new();
8286
8287         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8288         let payment_secret = PaymentSecret([0xdb; 32]);
8289         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8290         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();
8291         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8292         // Claiming with all the correct values but the wrong secret should result in nothing...
8293         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8294         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8295         // ...but with the right secret we should be able to claim all the way back
8296         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8297 }
8298
8299 #[test]
8300 fn test_simple_mpp() {
8301         // Simple test of sending a multi-path payment.
8302         let chanmon_cfgs = create_chanmon_cfgs(4);
8303         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8304         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8305         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8306
8307         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8308         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8309         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8310         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8311         let logger = test_utils::TestLogger::new();
8312
8313         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8314         let payment_secret = PaymentSecret([0xdb; 32]);
8315         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8316         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();
8317         let path = route.paths[0].clone();
8318         route.paths.push(path);
8319         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8320         route.paths[0][0].short_channel_id = chan_1_id;
8321         route.paths[0][1].short_channel_id = chan_3_id;
8322         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8323         route.paths[1][0].short_channel_id = chan_2_id;
8324         route.paths[1][1].short_channel_id = chan_4_id;
8325         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8326         // Claiming with all the correct values but the wrong secret should result in nothing...
8327         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8328         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8329         // ...but with the right secret we should be able to claim all the way back
8330         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8331 }
8332
8333 #[test]
8334 fn test_update_err_monitor_lockdown() {
8335         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8336         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8337         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8338         //
8339         // This scenario may happen in a watchtower setup, where watchtower process a block height
8340         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8341         // commitment at same time.
8342
8343         let chanmon_cfgs = create_chanmon_cfgs(2);
8344         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8345         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8346         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8347
8348         // Create some initial channel
8349         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8350         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8351
8352         // Rebalance the network to generate htlc in the two directions
8353         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8354
8355         // Route a HTLC from node 0 to node 1 (but don't settle)
8356         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8357
8358         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8359         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8360         let watchtower = {
8361                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8362                 let monitor = monitors.get(&outpoint).unwrap();
8363                 let mut w = test_utils::TestVecWriter(Vec::new());
8364                 monitor.write_for_disk(&mut w).unwrap();
8365                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8366                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8367                 assert!(new_monitor == *monitor);
8368                 let watchtower = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8369                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8370                 watchtower
8371         };
8372         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8373         watchtower.simple_monitor.block_connected(&header, &[], 200);
8374
8375         // Try to update ChannelMonitor
8376         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8377         check_added_monitors!(nodes[1], 1);
8378         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8379         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8380         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8381         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8382                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8383                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8384                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8385                 } else { assert!(false); }
8386         } else { assert!(false); };
8387         // Our local monitor is in-sync and hasn't processed yet timeout
8388         check_added_monitors!(nodes[0], 1);
8389         let events = nodes[0].node.get_and_clear_pending_events();
8390         assert_eq!(events.len(), 1);
8391 }