_ 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, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  11 use ln::channel::{Channel, ChannelError};
  12 use ln::{chan_utils, onion_utils};
  13 use ln::router::{Route, RouteHop};
  14 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  15 use ln::msgs;
  16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  17 use util::enforcing_trait_impls::EnforcingChannelKeys;
  18 use util::test_utils;
  19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  20 use util::errors::APIError;
  21 use util::ser::{Writeable, Writer, ReadableArgs};
  22 use util::config::UserConfig;
  23 use util::logger::Logger;
  24
  25 use bitcoin::util::hash::BitcoinHash;
  26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  27 use bitcoin::util::bip143;
  28 use bitcoin::util::address::Address;
  29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  30 use bitcoin::blockdata::block::{Block, BlockHeader};
  31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  32 use bitcoin::blockdata::script::{Builder, Script};
  33 use bitcoin::blockdata::opcodes;
  34 use bitcoin::blockdata::constants::genesis_block;
  35 use bitcoin::network::constants::Network;
  36
  37 use bitcoin_hashes::sha256::Hash as Sha256;
  38 use bitcoin_hashes::Hash;
  39
  40 use secp256k1::{Secp256k1, Message};
  41 use secp256k1::key::{PublicKey,SecretKey};
  42
  43 use std::collections::{BTreeSet, HashMap, HashSet};
  44 use std::default::Default;
  45 use std::sync::{Arc, Mutex};
  46 use std::sync::atomic::Ordering;
  47 use std::{mem, io};
  48
  49 use rand::{thread_rng, Rng};
  50
  51 use ln::functional_test_utils::*;
  52
  53 #[test]
  54 fn test_insane_channel_opens() {
  55         // Stand up a network of 2 nodes
  56         let node_cfgs = create_node_cfgs(2);
  57         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  58         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  59
  60         // Instantiate channel parameters where we push the maximum msats given our
  61         // funding satoshis
  62         let channel_value_sat = 31337; // same as funding satoshis
  63         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
  64         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  65
  66         // Have node0 initiate a channel to node1 with aforementioned parameters
  67         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
  68
  69         // Extract the channel open message from node0 to node1
  70         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  71
  72         // Test helper that asserts we get the correct error string given a mutator
  73         // that supposedly makes the channel open message insane
  74         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  75                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
  76                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  77                 assert_eq!(msg_events.len(), 1);
  78                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  79                         match action {
  80                                 &ErrorAction::SendErrorMessage { .. } => {
  81                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  82                                 },
  83                                 _ => panic!("unexpected event!"),
  84                         }
  85                 } else { assert!(false); }
  86         };
  87
  88         use ln::channel::MAX_FUNDING_SATOSHIS;
  89         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  90
  91         // Test all mutations that would make the channel open message insane
  92         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  93
  94         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  95
  96         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  97
  98         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
  99
 100         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 101
 102         insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 103
 104         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 });
 105
 106         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 107
 108         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 109 }
 110
 111 #[test]
 112 fn test_async_inbound_update_fee() {
 113         let node_cfgs = create_node_cfgs(2);
 114         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 115         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 116         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 117         let channel_id = chan.2;
 118
 119         // balancing
 120         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 121
 122         // A                                        B
 123         // update_fee                            ->
 124         // send (1) commitment_signed            -.
 125         //                                       <- update_add_htlc/commitment_signed
 126         // send (2) RAA (awaiting remote revoke) -.
 127         // (1) commitment_signed is delivered    ->
 128         //                                       .- send (3) RAA (awaiting remote revoke)
 129         // (2) RAA is delivered                  ->
 130         //                                       .- send (4) commitment_signed
 131         //                                       <- (3) RAA is delivered
 132         // send (5) commitment_signed            -.
 133         //                                       <- (4) commitment_signed is delivered
 134         // send (6) RAA                          -.
 135         // (5) commitment_signed is delivered    ->
 136         //                                       <- RAA
 137         // (6) RAA is delivered                  ->
 138
 139         // First nodes[0] generates an update_fee
 140         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 141         check_added_monitors!(nodes[0], 1);
 142
 143         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 144         assert_eq!(events_0.len(), 1);
 145         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 146                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 147                         (update_fee.as_ref(), commitment_signed)
 148                 },
 149                 _ => panic!("Unexpected event"),
 150         };
 151
 152         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 153
 154         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 155         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 156         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash, None).unwrap();
 157         check_added_monitors!(nodes[1], 1);
 158
 159         let payment_event = {
 160                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 161                 assert_eq!(events_1.len(), 1);
 162                 SendEvent::from_event(events_1.remove(0))
 163         };
 164         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 165         assert_eq!(payment_event.msgs.len(), 1);
 166
 167         // ...now when the messages get delivered everyone should be happy
 168         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 169         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 170         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 171         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 172         check_added_monitors!(nodes[0], 1);
 173
 174         // deliver(1), generate (3):
 175         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 176         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 177         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 178         check_added_monitors!(nodes[1], 1);
 179
 180         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 181         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 182         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 183         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 184         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 185         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 186         assert!(bs_update.update_fee.is_none()); // (4)
 187         check_added_monitors!(nodes[1], 1);
 188
 189         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 190         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 191         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 192         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 193         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 194         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 195         assert!(as_update.update_fee.is_none()); // (5)
 196         check_added_monitors!(nodes[0], 1);
 197
 198         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 199         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 200         // only (6) so get_event_msg's assert(len == 1) passes
 201         check_added_monitors!(nodes[0], 1);
 202
 203         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 204         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 205         check_added_monitors!(nodes[1], 1);
 206
 207         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 208         check_added_monitors!(nodes[0], 1);
 209
 210         let events_2 = nodes[0].node.get_and_clear_pending_events();
 211         assert_eq!(events_2.len(), 1);
 212         match events_2[0] {
 213                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 214                 _ => panic!("Unexpected event"),
 215         }
 216
 217         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 218         check_added_monitors!(nodes[1], 1);
 219 }
 220
 221 #[test]
 222 fn test_update_fee_unordered_raa() {
 223         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 224         // crash in an earlier version of the update_fee patch)
 225         let node_cfgs = create_node_cfgs(2);
 226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 227         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 228         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 229         let channel_id = chan.2;
 230
 231         // balancing
 232         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 233
 234         // First nodes[0] generates an update_fee
 235         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 236         check_added_monitors!(nodes[0], 1);
 237
 238         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 239         assert_eq!(events_0.len(), 1);
 240         let update_msg = match events_0[0] { // (1)
 241                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 242                         update_fee.as_ref()
 243                 },
 244                 _ => panic!("Unexpected event"),
 245         };
 246
 247         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 248
 249         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 250         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 251         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash, None).unwrap();
 252         check_added_monitors!(nodes[1], 1);
 253
 254         let payment_event = {
 255                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 256                 assert_eq!(events_1.len(), 1);
 257                 SendEvent::from_event(events_1.remove(0))
 258         };
 259         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 260         assert_eq!(payment_event.msgs.len(), 1);
 261
 262         // ...now when the messages get delivered everyone should be happy
 263         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 264         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 265         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 266         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 267         check_added_monitors!(nodes[0], 1);
 268
 269         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 270         check_added_monitors!(nodes[1], 1);
 271
 272         // We can't continue, sadly, because our (1) now has a bogus signature
 273 }
 274
 275 #[test]
 276 fn test_multi_flight_update_fee() {
 277         let node_cfgs = create_node_cfgs(2);
 278         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 279         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 280         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 281         let channel_id = chan.2;
 282
 283         // A                                        B
 284         // update_fee/commitment_signed          ->
 285         //                                       .- send (1) RAA and (2) commitment_signed
 286         // update_fee (never committed)          ->
 287         // (3) update_fee                        ->
 288         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 289         // don't track which updates correspond to which revoke_and_ack responses so we're in
 290         // AwaitingRAA mode and will not generate the update_fee yet.
 291         //                                       <- (1) RAA delivered
 292         // (3) is generated and send (4) CS      -.
 293         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 294         // know the per_commitment_point to use for it.
 295         //                                       <- (2) commitment_signed delivered
 296         // revoke_and_ack                        ->
 297         //                                          B should send no response here
 298         // (4) commitment_signed delivered       ->
 299         //                                       <- RAA/commitment_signed delivered
 300         // revoke_and_ack                        ->
 301
 302         // First nodes[0] generates an update_fee
 303         let initial_feerate = get_feerate!(nodes[0], channel_id);
 304         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 305         check_added_monitors!(nodes[0], 1);
 306
 307         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 308         assert_eq!(events_0.len(), 1);
 309         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 310                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 311                         (update_fee.as_ref().unwrap(), commitment_signed)
 312                 },
 313                 _ => panic!("Unexpected event"),
 314         };
 315
 316         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 317         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 318         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 319         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 320         check_added_monitors!(nodes[1], 1);
 321
 322         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 323         // transaction:
 324         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 325         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 326         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 327
 328         // Create the (3) update_fee message that nodes[0] will generate before it does...
 329         let mut update_msg_2 = msgs::UpdateFee {
 330                 channel_id: update_msg_1.channel_id.clone(),
 331                 feerate_per_kw: (initial_feerate + 30) as u32,
 332         };
 333
 334         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 335
 336         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 337         // Deliver (3)
 338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 339
 340         // Deliver (1), generating (3) and (4)
 341         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 342         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 343         check_added_monitors!(nodes[0], 1);
 344         assert!(as_second_update.update_add_htlcs.is_empty());
 345         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 346         assert!(as_second_update.update_fail_htlcs.is_empty());
 347         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 348         // Check that the update_fee newly generated matches what we delivered:
 349         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 350         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 351
 352         // Deliver (2) commitment_signed
 353         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 354         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 355         check_added_monitors!(nodes[0], 1);
 356         // No commitment_signed so get_event_msg's assert(len == 1) passes
 357
 358         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 359         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 360         check_added_monitors!(nodes[1], 1);
 361
 362         // Delever (4)
 363         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 364         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 365         check_added_monitors!(nodes[1], 1);
 366
 367         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 368         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 369         check_added_monitors!(nodes[0], 1);
 370
 371         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 372         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 373         // No commitment_signed so get_event_msg's assert(len == 1) passes
 374         check_added_monitors!(nodes[0], 1);
 375
 376         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 377         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 378         check_added_monitors!(nodes[1], 1);
 379 }
 380
 381 #[test]
 382 fn test_update_fee_vanilla() {
 383         let node_cfgs = create_node_cfgs(2);
 384         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 385         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 386         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 387         let channel_id = chan.2;
 388
 389         let feerate = get_feerate!(nodes[0], channel_id);
 390         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 391         check_added_monitors!(nodes[0], 1);
 392
 393         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 394         assert_eq!(events_0.len(), 1);
 395         let (update_msg, commitment_signed) = match events_0[0] {
 396                         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 } } => {
 397                         (update_fee.as_ref(), commitment_signed)
 398                 },
 399                 _ => panic!("Unexpected event"),
 400         };
 401         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 402
 403         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 404         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 405         check_added_monitors!(nodes[1], 1);
 406
 407         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 408         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 409         check_added_monitors!(nodes[0], 1);
 410
 411         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 412         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 413         // No commitment_signed so get_event_msg's assert(len == 1) passes
 414         check_added_monitors!(nodes[0], 1);
 415
 416         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 417         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 418         check_added_monitors!(nodes[1], 1);
 419 }
 420
 421 #[test]
 422 fn test_update_fee_that_funder_cannot_afford() {
 423         let node_cfgs = create_node_cfgs(2);
 424         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 425         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 426         let channel_value = 1888;
 427         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 428         let channel_id = chan.2;
 429
 430         let feerate = 260;
 431         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 432         check_added_monitors!(nodes[0], 1);
 433         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 434
 435         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 436
 437         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 438
 439         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 440         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 441         {
 442                 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
 443                 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
 444
 445                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 446                 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
 447                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 448                 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
 449                 actual_fee = channel_value - actual_fee;
 450                 assert_eq!(total_fee, actual_fee);
 451         } //drop the mutex
 452
 453         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 454         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 455         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 456         check_added_monitors!(nodes[0], 1);
 457
 458         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 459
 460         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 461
 462         //While producing the commitment_signed response after handling a received update_fee request the
 463         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 464         //Should produce and error.
 465         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 466         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 467
 468         //clear the message we could not handle
 469         nodes[1].node.get_and_clear_pending_msg_events();
 470 }
 471
 472 #[test]
 473 fn test_update_fee_with_fundee_update_add_htlc() {
 474         let node_cfgs = create_node_cfgs(2);
 475         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 476         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 477         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 478         let channel_id = chan.2;
 479
 480         // balancing
 481         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 482
 483         let feerate = get_feerate!(nodes[0], channel_id);
 484         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 485         check_added_monitors!(nodes[0], 1);
 486
 487         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 488         assert_eq!(events_0.len(), 1);
 489         let (update_msg, commitment_signed) = match events_0[0] {
 490                         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 } } => {
 491                         (update_fee.as_ref(), commitment_signed)
 492                 },
 493                 _ => panic!("Unexpected event"),
 494         };
 495         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 496         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 497         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 498         check_added_monitors!(nodes[1], 1);
 499
 500         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 501
 502         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 503
 504         // nothing happens since node[1] is in AwaitingRemoteRevoke
 505         nodes[1].node.send_payment(route, our_payment_hash, None).unwrap();
 506         {
 507                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 508                 assert_eq!(added_monitors.len(), 0);
 509                 added_monitors.clear();
 510         }
 511         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 512         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 513         // node[1] has nothing to do
 514
 515         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 516         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 517         check_added_monitors!(nodes[0], 1);
 518
 519         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 520         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 521         // No commitment_signed so get_event_msg's assert(len == 1) passes
 522         check_added_monitors!(nodes[0], 1);
 523         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 524         check_added_monitors!(nodes[1], 1);
 525         // AwaitingRemoteRevoke ends here
 526
 527         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 528         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 529         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 530         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 531         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 532         assert_eq!(commitment_update.update_fee.is_none(), true);
 533
 534         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 535         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 536         check_added_monitors!(nodes[0], 1);
 537         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 538
 539         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 540         check_added_monitors!(nodes[1], 1);
 541         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 542
 543         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 544         check_added_monitors!(nodes[1], 1);
 545         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 546         // No commitment_signed so get_event_msg's assert(len == 1) passes
 547
 548         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 549         check_added_monitors!(nodes[0], 1);
 550         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 551
 552         expect_pending_htlcs_forwardable!(nodes[0]);
 553
 554         let events = nodes[0].node.get_and_clear_pending_events();
 555         assert_eq!(events.len(), 1);
 556         match events[0] {
 557                 Event::PaymentReceived { .. } => { },
 558                 _ => panic!("Unexpected event"),
 559         };
 560
 561         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 562
 563         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 564         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 565         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 566 }
 567
 568 #[test]
 569 fn test_update_fee() {
 570         let node_cfgs = create_node_cfgs(2);
 571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 572         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 573         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 574         let channel_id = chan.2;
 575
 576         // A                                        B
 577         // (1) update_fee/commitment_signed      ->
 578         //                                       <- (2) revoke_and_ack
 579         //                                       .- send (3) commitment_signed
 580         // (4) update_fee/commitment_signed      ->
 581         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 582         //                                       <- (3) commitment_signed delivered
 583         // send (6) revoke_and_ack               -.
 584         //                                       <- (5) deliver revoke_and_ack
 585         // (6) deliver revoke_and_ack            ->
 586         //                                       .- send (7) commitment_signed in response to (4)
 587         //                                       <- (7) deliver commitment_signed
 588         // revoke_and_ack                        ->
 589
 590         // Create and deliver (1)...
 591         let feerate = get_feerate!(nodes[0], channel_id);
 592         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 593         check_added_monitors!(nodes[0], 1);
 594
 595         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 596         assert_eq!(events_0.len(), 1);
 597         let (update_msg, commitment_signed) = match events_0[0] {
 598                         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 } } => {
 599                         (update_fee.as_ref(), commitment_signed)
 600                 },
 601                 _ => panic!("Unexpected event"),
 602         };
 603         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 604
 605         // Generate (2) and (3):
 606         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 607         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 608         check_added_monitors!(nodes[1], 1);
 609
 610         // Deliver (2):
 611         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 612         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 613         check_added_monitors!(nodes[0], 1);
 614
 615         // Create and deliver (4)...
 616         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 617         check_added_monitors!(nodes[0], 1);
 618         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 619         assert_eq!(events_0.len(), 1);
 620         let (update_msg, commitment_signed) = match events_0[0] {
 621                         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 } } => {
 622                         (update_fee.as_ref(), commitment_signed)
 623                 },
 624                 _ => panic!("Unexpected event"),
 625         };
 626
 627         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 628         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 629         check_added_monitors!(nodes[1], 1);
 630         // ... creating (5)
 631         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 632         // No commitment_signed so get_event_msg's assert(len == 1) passes
 633
 634         // Handle (3), creating (6):
 635         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 636         check_added_monitors!(nodes[0], 1);
 637         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 638         // No commitment_signed so get_event_msg's assert(len == 1) passes
 639
 640         // Deliver (5):
 641         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 642         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 643         check_added_monitors!(nodes[0], 1);
 644
 645         // Deliver (6), creating (7):
 646         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 647         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         assert!(commitment_update.update_add_htlcs.is_empty());
 649         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 650         assert!(commitment_update.update_fail_htlcs.is_empty());
 651         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 652         assert!(commitment_update.update_fee.is_none());
 653         check_added_monitors!(nodes[1], 1);
 654
 655         // Deliver (7)
 656         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 657         check_added_monitors!(nodes[0], 1);
 658         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 659         // No commitment_signed so get_event_msg's assert(len == 1) passes
 660
 661         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 662         check_added_monitors!(nodes[1], 1);
 663         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 664
 665         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 666         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 667         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 668 }
 669
 670 #[test]
 671 fn pre_funding_lock_shutdown_test() {
 672         // Test sending a shutdown prior to funding_locked after funding generation
 673         let node_cfgs = create_node_cfgs(2);
 674         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 675         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 676         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 677         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 678         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 679         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 680
 681         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 682         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 683         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 684         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 685         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 686
 687         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 688         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 689         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 690         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 691         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 692         assert!(node_0_none.is_none());
 693
 694         assert!(nodes[0].node.list_channels().is_empty());
 695         assert!(nodes[1].node.list_channels().is_empty());
 696 }
 697
 698 #[test]
 699 fn updates_shutdown_wait() {
 700         // Test sending a shutdown with outstanding updates pending
 701         let node_cfgs = create_node_cfgs(3);
 702         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 703         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 704         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 705         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 706         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 707         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 708
 709         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 710
 711         nodes[0].node.close_channel(&chan_1.2).unwrap();
 712         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 713         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 714         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 715         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 716
 717         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 718         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 719
 720         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 721         unwrap_send_err!(nodes[0].node.send_payment(route_1, payment_hash, None), true, APIError::ChannelUnavailable {..}, {});
 722         unwrap_send_err!(nodes[1].node.send_payment(route_2, payment_hash, None), true, APIError::ChannelUnavailable {..}, {});
 723
 724         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 725         check_added_monitors!(nodes[2], 1);
 726         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 727         assert!(updates.update_add_htlcs.is_empty());
 728         assert!(updates.update_fail_htlcs.is_empty());
 729         assert!(updates.update_fail_malformed_htlcs.is_empty());
 730         assert!(updates.update_fee.is_none());
 731         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 732         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 733         check_added_monitors!(nodes[1], 1);
 734         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 735         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 736
 737         assert!(updates_2.update_add_htlcs.is_empty());
 738         assert!(updates_2.update_fail_htlcs.is_empty());
 739         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 740         assert!(updates_2.update_fee.is_none());
 741         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 742         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 743         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 744
 745         let events = nodes[0].node.get_and_clear_pending_events();
 746         assert_eq!(events.len(), 1);
 747         match events[0] {
 748                 Event::PaymentSent { ref payment_preimage } => {
 749                         assert_eq!(our_payment_preimage, *payment_preimage);
 750                 },
 751                 _ => panic!("Unexpected event"),
 752         }
 753
 754         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 755         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 756         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 757         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 758         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 759         assert!(node_0_none.is_none());
 760
 761         assert!(nodes[0].node.list_channels().is_empty());
 762
 763         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 764         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 765         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 766         assert!(nodes[1].node.list_channels().is_empty());
 767         assert!(nodes[2].node.list_channels().is_empty());
 768 }
 769
 770 #[test]
 771 fn htlc_fail_async_shutdown() {
 772         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 773         let node_cfgs = create_node_cfgs(3);
 774         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 775         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 776         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 777         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 778
 779         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 780         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 781         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
 782         check_added_monitors!(nodes[0], 1);
 783         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 784         assert_eq!(updates.update_add_htlcs.len(), 1);
 785         assert!(updates.update_fulfill_htlcs.is_empty());
 786         assert!(updates.update_fail_htlcs.is_empty());
 787         assert!(updates.update_fail_malformed_htlcs.is_empty());
 788         assert!(updates.update_fee.is_none());
 789
 790         nodes[1].node.close_channel(&chan_1.2).unwrap();
 791         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 792         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 793         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 794
 795         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 796         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 797         check_added_monitors!(nodes[1], 1);
 798         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 799         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 800
 801         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 802         assert!(updates_2.update_add_htlcs.is_empty());
 803         assert!(updates_2.update_fulfill_htlcs.is_empty());
 804         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 805         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 806         assert!(updates_2.update_fee.is_none());
 807
 808         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 809         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 810
 811         let events = nodes[0].node.get_and_clear_pending_events();
 812         assert_eq!(events.len(), 1);
 813         match events[0] {
 814                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 815                         assert_eq!(our_payment_hash, *payment_hash);
 816                         assert!(!rejected_by_dest);
 817                 },
 818                 _ => panic!("Unexpected event"),
 819         }
 820
 821         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 822         assert_eq!(msg_events.len(), 2);
 823         let node_0_closing_signed = match msg_events[0] {
 824                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 825                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 826                         (*msg).clone()
 827                 },
 828                 _ => panic!("Unexpected event"),
 829         };
 830         match msg_events[1] {
 831                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 832                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 833                 },
 834                 _ => panic!("Unexpected event"),
 835         }
 836
 837         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 838         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 839         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 840         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 841         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 842         assert!(node_0_none.is_none());
 843
 844         assert!(nodes[0].node.list_channels().is_empty());
 845
 846         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 847         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 848         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 849         assert!(nodes[1].node.list_channels().is_empty());
 850         assert!(nodes[2].node.list_channels().is_empty());
 851 }
 852
 853 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 854         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 855         // messages delivered prior to disconnect
 856         let node_cfgs = create_node_cfgs(3);
 857         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 858         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 859         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 860         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 861
 862         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 863
 864         nodes[1].node.close_channel(&chan_1.2).unwrap();
 865         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 866         if recv_count > 0 {
 867                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 868                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 869                 if recv_count > 1 {
 870                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 871                 }
 872         }
 873
 874         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 875         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 876
 877         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 878         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 879         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 880         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 881
 882         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
 883         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 884         assert!(node_1_shutdown == node_1_2nd_shutdown);
 885
 886         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
 887         let node_0_2nd_shutdown = if recv_count > 0 {
 888                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 889                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 890                 node_0_2nd_shutdown
 891         } else {
 892                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 893                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 894                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 895         };
 896         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
 897
 898         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 899         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 900
 901         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 902         check_added_monitors!(nodes[2], 1);
 903         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 904         assert!(updates.update_add_htlcs.is_empty());
 905         assert!(updates.update_fail_htlcs.is_empty());
 906         assert!(updates.update_fail_malformed_htlcs.is_empty());
 907         assert!(updates.update_fee.is_none());
 908         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 909         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 910         check_added_monitors!(nodes[1], 1);
 911         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 912         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 913
 914         assert!(updates_2.update_add_htlcs.is_empty());
 915         assert!(updates_2.update_fail_htlcs.is_empty());
 916         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 917         assert!(updates_2.update_fee.is_none());
 918         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 919         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 920         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 921
 922         let events = nodes[0].node.get_and_clear_pending_events();
 923         assert_eq!(events.len(), 1);
 924         match events[0] {
 925                 Event::PaymentSent { ref payment_preimage } => {
 926                         assert_eq!(our_payment_preimage, *payment_preimage);
 927                 },
 928                 _ => panic!("Unexpected event"),
 929         }
 930
 931         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 932         if recv_count > 0 {
 933                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 934                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 935                 assert!(node_1_closing_signed.is_some());
 936         }
 937
 938         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 939         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 940
 941         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 942         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 943         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 944         if recv_count == 0 {
 945                 // If all closing_signeds weren't delivered we can just resume where we left off...
 946                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 947
 948                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 949                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 950                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 951
 952                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 953                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 954                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 955
 956                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
 957                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 958
 959                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
 960                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 961                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
 962
 963                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
 964                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 965                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 966                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 967                 assert!(node_0_none.is_none());
 968         } else {
 969                 // If one node, however, received + responded with an identical closing_signed we end
 970                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
 971                 // There isn't really anything better we can do simply, but in the future we might
 972                 // explore storing a set of recently-closed channels that got disconnected during
 973                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
 974                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
 975                 // transaction.
 976                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 977
 978                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 979                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
 980                 assert_eq!(msg_events.len(), 1);
 981                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
 982                         match action {
 983                                 &ErrorAction::SendErrorMessage { ref msg } => {
 984                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
 985                                         assert_eq!(msg.channel_id, chan_1.2);
 986                                 },
 987                                 _ => panic!("Unexpected event!"),
 988                         }
 989                 } else { panic!("Needed SendErrorMessage close"); }
 990
 991                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
 992                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
 993                 // closing_signed so we do it ourselves
 994                 check_closed_broadcast!(nodes[0], false);
 995         }
 996
 997         assert!(nodes[0].node.list_channels().is_empty());
 998
 999         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1000         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1001         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1002         assert!(nodes[1].node.list_channels().is_empty());
1003         assert!(nodes[2].node.list_channels().is_empty());
1004 }
1005
1006 #[test]
1007 fn test_shutdown_rebroadcast() {
1008         do_test_shutdown_rebroadcast(0);
1009         do_test_shutdown_rebroadcast(1);
1010         do_test_shutdown_rebroadcast(2);
1011 }
1012
1013 #[test]
1014 fn fake_network_test() {
1015         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1016         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1017         let node_cfgs = create_node_cfgs(4);
1018         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1019         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1020
1021         // Create some initial channels
1022         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1023         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1024         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1025
1026         // Rebalance the network a bit by relaying one payment through all the channels...
1027         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1028         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1029         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1030         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1031
1032         // Send some more payments
1033         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1034         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1035         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1036
1037         // Test failure packets
1038         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1039         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1040
1041         // Add a new channel that skips 3
1042         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1043
1044         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1045         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1046         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1047         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1048         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1049         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1050         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1051
1052         // Do some rebalance loop payments, simultaneously
1053         let mut hops = Vec::with_capacity(3);
1054         hops.push(RouteHop {
1055                 pubkey: nodes[2].node.get_our_node_id(),
1056                 node_features: NodeFeatures::empty(),
1057                 short_channel_id: chan_2.0.contents.short_channel_id,
1058                 channel_features: ChannelFeatures::empty(),
1059                 fee_msat: 0,
1060                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1061         });
1062         hops.push(RouteHop {
1063                 pubkey: nodes[3].node.get_our_node_id(),
1064                 node_features: NodeFeatures::empty(),
1065                 short_channel_id: chan_3.0.contents.short_channel_id,
1066                 channel_features: ChannelFeatures::empty(),
1067                 fee_msat: 0,
1068                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1069         });
1070         hops.push(RouteHop {
1071                 pubkey: nodes[1].node.get_our_node_id(),
1072                 node_features: NodeFeatures::empty(),
1073                 short_channel_id: chan_4.0.contents.short_channel_id,
1074                 channel_features: ChannelFeatures::empty(),
1075                 fee_msat: 1000000,
1076                 cltv_expiry_delta: TEST_FINAL_CLTV,
1077         });
1078         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;
1079         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;
1080         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1081
1082         let mut hops = Vec::with_capacity(3);
1083         hops.push(RouteHop {
1084                 pubkey: nodes[3].node.get_our_node_id(),
1085                 node_features: NodeFeatures::empty(),
1086                 short_channel_id: chan_4.0.contents.short_channel_id,
1087                 channel_features: ChannelFeatures::empty(),
1088                 fee_msat: 0,
1089                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1090         });
1091         hops.push(RouteHop {
1092                 pubkey: nodes[2].node.get_our_node_id(),
1093                 node_features: NodeFeatures::empty(),
1094                 short_channel_id: chan_3.0.contents.short_channel_id,
1095                 channel_features: ChannelFeatures::empty(),
1096                 fee_msat: 0,
1097                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1098         });
1099         hops.push(RouteHop {
1100                 pubkey: nodes[1].node.get_our_node_id(),
1101                 node_features: NodeFeatures::empty(),
1102                 short_channel_id: chan_2.0.contents.short_channel_id,
1103                 channel_features: ChannelFeatures::empty(),
1104                 fee_msat: 1000000,
1105                 cltv_expiry_delta: TEST_FINAL_CLTV,
1106         });
1107         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;
1108         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;
1109         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1110
1111         // Claim the rebalances...
1112         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1113         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1114
1115         // Add a duplicate new channel from 2 to 4
1116         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1117
1118         // Send some payments across both channels
1119         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1120         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1121         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1122
1123
1124         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1125         let events = nodes[0].node.get_and_clear_pending_msg_events();
1126         assert_eq!(events.len(), 0);
1127         nodes[0].logger.assert_log("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);
1128
1129         //TODO: Test that routes work again here as we've been notified that the channel is full
1130
1131         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1132         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1133         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1134
1135         // Close down the channels...
1136         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1137         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1138         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1139         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1140         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1141 }
1142
1143 #[test]
1144 fn holding_cell_htlc_counting() {
1145         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1146         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1147         // commitment dance rounds.
1148         let node_cfgs = create_node_cfgs(3);
1149         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1150         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1151         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1152         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1153
1154         let mut payments = Vec::new();
1155         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1156                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1157                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1158                 nodes[1].node.send_payment(route, payment_hash, None).unwrap();
1159                 payments.push((payment_preimage, payment_hash));
1160         }
1161         check_added_monitors!(nodes[1], 1);
1162
1163         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1164         assert_eq!(events.len(), 1);
1165         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1166         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1167
1168         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1169         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1170         // another HTLC.
1171         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1172         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1173         unwrap_send_err!(nodes[1].node.send_payment(route, payment_hash_1, None), true, APIError::ChannelUnavailable { err },
1174                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1175         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1176         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1177
1178         // This should also be true if we try to forward a payment.
1179         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1180         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1181         nodes[0].node.send_payment(route, payment_hash_2, None).unwrap();
1182         check_added_monitors!(nodes[0], 1);
1183
1184         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1185         assert_eq!(events.len(), 1);
1186         let payment_event = SendEvent::from_event(events.pop().unwrap());
1187         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1188
1189         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1190         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1191         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1192         // fails), the second will process the resulting failure and fail the HTLC backward.
1193         expect_pending_htlcs_forwardable!(nodes[1]);
1194         expect_pending_htlcs_forwardable!(nodes[1]);
1195         check_added_monitors!(nodes[1], 1);
1196
1197         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1198         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1199         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1200
1201         let events = nodes[0].node.get_and_clear_pending_msg_events();
1202         assert_eq!(events.len(), 1);
1203         match events[0] {
1204                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1205                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1206                 },
1207                 _ => panic!("Unexpected event"),
1208         }
1209
1210         let events = nodes[0].node.get_and_clear_pending_events();
1211         assert_eq!(events.len(), 1);
1212         match events[0] {
1213                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1214                         assert_eq!(payment_hash, payment_hash_2);
1215                         assert!(!rejected_by_dest);
1216                 },
1217                 _ => panic!("Unexpected event"),
1218         }
1219
1220         // Now forward all the pending HTLCs and claim them back
1221         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1222         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1223         check_added_monitors!(nodes[2], 1);
1224
1225         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1226         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1227         check_added_monitors!(nodes[1], 1);
1228         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1229
1230         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1231         check_added_monitors!(nodes[1], 1);
1232         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1233
1234         for ref update in as_updates.update_add_htlcs.iter() {
1235                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1236         }
1237         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1238         check_added_monitors!(nodes[2], 1);
1239         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1240         check_added_monitors!(nodes[2], 1);
1241         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1242
1243         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1244         check_added_monitors!(nodes[1], 1);
1245         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1246         check_added_monitors!(nodes[1], 1);
1247         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1248
1249         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1250         check_added_monitors!(nodes[2], 1);
1251
1252         expect_pending_htlcs_forwardable!(nodes[2]);
1253
1254         let events = nodes[2].node.get_and_clear_pending_events();
1255         assert_eq!(events.len(), payments.len());
1256         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1257                 match event {
1258                         &Event::PaymentReceived { ref payment_hash, .. } => {
1259                                 assert_eq!(*payment_hash, *hash);
1260                         },
1261                         _ => panic!("Unexpected event"),
1262                 };
1263         }
1264
1265         for (preimage, _) in payments.drain(..) {
1266                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1267         }
1268
1269         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1270 }
1271
1272 #[test]
1273 fn duplicate_htlc_test() {
1274         // Test that we accept duplicate payment_hash HTLCs across the network and that
1275         // claiming/failing them are all separate and don't affect each other
1276         let node_cfgs = create_node_cfgs(6);
1277         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1278         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1279
1280         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1281         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1282         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1283         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1284         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1285         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1286
1287         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1288
1289         *nodes[0].network_payment_count.borrow_mut() -= 1;
1290         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1291
1292         *nodes[0].network_payment_count.borrow_mut() -= 1;
1293         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1294
1295         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1296         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1297         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1298 }
1299
1300 #[test]
1301 fn test_duplicate_htlc_different_direction_onchain() {
1302         // Test that ChannelMonitor doesn't generate 2 preimage txn
1303         // when we have 2 HTLCs with same preimage that go across a node
1304         // in opposite directions.
1305         let node_cfgs = create_node_cfgs(2);
1306         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1307         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1308
1309         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1310
1311         // balancing
1312         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1313
1314         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1315
1316         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1317         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1318
1319         // Provide preimage to node 0 by claiming payment
1320         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1321         check_added_monitors!(nodes[0], 1);
1322
1323         // Broadcast node 1 commitment txn
1324         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
1325
1326         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1327         let mut has_both_htlcs = 0; // check htlcs match ones committed
1328         for outp in remote_txn[0].output.iter() {
1329                 if outp.value == 800_000 / 1000 {
1330                         has_both_htlcs += 1;
1331                 } else if outp.value == 900_000 / 1000 {
1332                         has_both_htlcs += 1;
1333                 }
1334         }
1335         assert_eq!(has_both_htlcs, 2);
1336
1337         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1338         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1339
1340         // Check we only broadcast 1 timeout tx
1341         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1342         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()) };
1343         assert_eq!(claim_txn.len(), 7);
1344         check_spends!(claim_txn[2], chan_1.3);
1345         check_spends!(claim_txn[3], claim_txn[2]);
1346         assert_eq!(claim_txn[0], claim_txn[5]);
1347         assert_eq!(claim_txn[1], claim_txn[6]);
1348         assert_eq!(htlc_pair.0.input.len(), 1);
1349         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1350         check_spends!(htlc_pair.0, remote_txn[0].clone());
1351         assert_eq!(htlc_pair.1.input.len(), 1);
1352         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1353         check_spends!(htlc_pair.1, remote_txn[0].clone());
1354
1355         let events = nodes[0].node.get_and_clear_pending_msg_events();
1356         assert_eq!(events.len(), 2);
1357         for e in events {
1358                 match e {
1359                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1360                         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, .. } } => {
1361                                 assert!(update_add_htlcs.is_empty());
1362                                 assert!(update_fail_htlcs.is_empty());
1363                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1364                                 assert!(update_fail_malformed_htlcs.is_empty());
1365                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1366                         },
1367                         _ => panic!("Unexpected event"),
1368                 }
1369         }
1370 }
1371
1372 fn do_channel_reserve_test(test_recv: bool) {
1373
1374         let node_cfgs = create_node_cfgs(3);
1375         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1376         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1377         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1378         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1379
1380         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1381         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1382
1383         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1384         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1385
1386         macro_rules! get_route_and_payment_hash {
1387                 ($recv_value: expr) => {{
1388                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1389                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1390                         (route, payment_hash, payment_preimage)
1391                 }}
1392         };
1393
1394         macro_rules! expect_forward {
1395                 ($node: expr) => {{
1396                         let mut events = $node.node.get_and_clear_pending_msg_events();
1397                         assert_eq!(events.len(), 1);
1398                         check_added_monitors!($node, 1);
1399                         let payment_event = SendEvent::from_event(events.remove(0));
1400                         payment_event
1401                 }}
1402         }
1403
1404         let feemsat = 239; // somehow we know?
1405         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1406
1407         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1408
1409         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1410         {
1411                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1412                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1413                 unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1414                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1415                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1416                 nodes[0].logger.assert_log("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);
1417         }
1418
1419         let mut htlc_id = 0;
1420         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1421         // nodes[0]'s wealth
1422         loop {
1423                 let amt_msat = recv_value_0 + total_fee_msat;
1424                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1425                         break;
1426                 }
1427                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1428                 htlc_id += 1;
1429
1430                 let (stat01_, stat11_, stat12_, stat22_) = (
1431                         get_channel_value_stat!(nodes[0], chan_1.2),
1432                         get_channel_value_stat!(nodes[1], chan_1.2),
1433                         get_channel_value_stat!(nodes[1], chan_2.2),
1434                         get_channel_value_stat!(nodes[2], chan_2.2),
1435                 );
1436
1437                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1438                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1439                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1440                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1441                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1442         }
1443
1444         {
1445                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1446                 // attempt to get channel_reserve violation
1447                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1448                 unwrap_send_err!(nodes[0].node.send_payment(route.clone(), our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1449                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1450                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1451                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1452         }
1453
1454         // adding pending output
1455         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1456         let amt_msat_1 = recv_value_1 + total_fee_msat;
1457
1458         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1459         let payment_event_1 = {
1460                 nodes[0].node.send_payment(route_1, our_payment_hash_1, None).unwrap();
1461                 check_added_monitors!(nodes[0], 1);
1462
1463                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1464                 assert_eq!(events.len(), 1);
1465                 SendEvent::from_event(events.remove(0))
1466         };
1467         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1468
1469         // channel reserve test with htlc pending output > 0
1470         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1471         {
1472                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1473                 unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1474                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1475                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1476                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1477         }
1478
1479         {
1480                 // test channel_reserve test on nodes[1] side
1481                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1482
1483                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1484                 let secp_ctx = Secp256k1::new();
1485                 let session_priv = SecretKey::from_slice(&{
1486                         let mut session_key = [0; 32];
1487                         let mut rng = thread_rng();
1488                         rng.fill_bytes(&mut session_key);
1489                         session_key
1490                 }).expect("RNG is bad!");
1491
1492                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1493                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1494                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], recv_value_2 + 1, None, cur_height).unwrap();
1495                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1496                 let msg = msgs::UpdateAddHTLC {
1497                         channel_id: chan_1.2,
1498                         htlc_id,
1499                         amount_msat: htlc_msat,
1500                         payment_hash: our_payment_hash,
1501                         cltv_expiry: htlc_cltv,
1502                         onion_routing_packet: onion_packet,
1503                 };
1504
1505                 if test_recv {
1506                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1507                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1508                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1509                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1510                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1511                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1512                         return;
1513                 }
1514         }
1515
1516         // split the rest to test holding cell
1517         let recv_value_21 = recv_value_2/2;
1518         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1519         {
1520                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1521                 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), stat.channel_reserve_msat);
1522         }
1523
1524         // now see if they go through on both sides
1525         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1526         // but this will stuck in the holding cell
1527         nodes[0].node.send_payment(route_21, our_payment_hash_21, None).unwrap();
1528         check_added_monitors!(nodes[0], 0);
1529         let events = nodes[0].node.get_and_clear_pending_events();
1530         assert_eq!(events.len(), 0);
1531
1532         // test with outbound holding cell amount > 0
1533         {
1534                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1535                 unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1536                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1537                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1538                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1539         }
1540
1541         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1542         // this will also stuck in the holding cell
1543         nodes[0].node.send_payment(route_22, our_payment_hash_22, None).unwrap();
1544         check_added_monitors!(nodes[0], 0);
1545         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1546         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1547
1548         // flush the pending htlc
1549         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1550         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1551         check_added_monitors!(nodes[1], 1);
1552
1553         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1554         check_added_monitors!(nodes[0], 1);
1555         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1556
1557         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1558         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1559         // No commitment_signed so get_event_msg's assert(len == 1) passes
1560         check_added_monitors!(nodes[0], 1);
1561
1562         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1563         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1564         check_added_monitors!(nodes[1], 1);
1565
1566         expect_pending_htlcs_forwardable!(nodes[1]);
1567
1568         let ref payment_event_11 = expect_forward!(nodes[1]);
1569         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1570         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1571
1572         expect_pending_htlcs_forwardable!(nodes[2]);
1573         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1574
1575         // flush the htlcs in the holding cell
1576         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1577         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1578         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1579         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1580         expect_pending_htlcs_forwardable!(nodes[1]);
1581
1582         let ref payment_event_3 = expect_forward!(nodes[1]);
1583         assert_eq!(payment_event_3.msgs.len(), 2);
1584         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1585         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1586
1587         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1588         expect_pending_htlcs_forwardable!(nodes[2]);
1589
1590         let events = nodes[2].node.get_and_clear_pending_events();
1591         assert_eq!(events.len(), 2);
1592         match events[0] {
1593                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1594                         assert_eq!(our_payment_hash_21, *payment_hash);
1595                         assert_eq!(*payment_secret, None);
1596                         assert_eq!(recv_value_21, amt);
1597                 },
1598                 _ => panic!("Unexpected event"),
1599         }
1600         match events[1] {
1601                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1602                         assert_eq!(our_payment_hash_22, *payment_hash);
1603                         assert_eq!(*payment_secret, None);
1604                         assert_eq!(recv_value_22, amt);
1605                 },
1606                 _ => panic!("Unexpected event"),
1607         }
1608
1609         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1610         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1611         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1612
1613         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);
1614         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1615         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1616         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1617
1618         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1619         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1620 }
1621
1622 #[test]
1623 fn channel_reserve_test() {
1624         do_channel_reserve_test(false);
1625         do_channel_reserve_test(true);
1626 }
1627
1628 #[test]
1629 fn channel_reserve_in_flight_removes() {
1630         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1631         // can send to its counterparty, but due to update ordering, the other side may not yet have
1632         // considered those HTLCs fully removed.
1633         // This tests that we don't count HTLCs which will not be included in the next remote
1634         // commitment transaction towards the reserve value (as it implies no commitment transaction
1635         // will be generated which violates the remote reserve value).
1636         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1637         // To test this we:
1638         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1639         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1640         //    you only consider the value of the first HTLC, it may not),
1641         //  * start routing a third HTLC from A to B,
1642         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1643         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1644         //  * deliver the first fulfill from B
1645         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1646         //    claim,
1647         //  * deliver A's response CS and RAA.
1648         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1649         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1650         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1651         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1652         let node_cfgs = create_node_cfgs(2);
1653         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1654         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1655         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1656
1657         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1658         // Route the first two HTLCs.
1659         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1660         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1661
1662         // Start routing the third HTLC (this is just used to get everyone in the right state).
1663         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1664         let send_1 = {
1665                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1666                 nodes[0].node.send_payment(route, payment_hash_3, None).unwrap();
1667                 check_added_monitors!(nodes[0], 1);
1668                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1669                 assert_eq!(events.len(), 1);
1670                 SendEvent::from_event(events.remove(0))
1671         };
1672
1673         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1674         // initial fulfill/CS.
1675         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1676         check_added_monitors!(nodes[1], 1);
1677         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1678
1679         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1680         // remove the second HTLC when we send the HTLC back from B to A.
1681         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1682         check_added_monitors!(nodes[1], 1);
1683         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1684
1685         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1686         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1687         check_added_monitors!(nodes[0], 1);
1688         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1689         expect_payment_sent!(nodes[0], payment_preimage_1);
1690
1691         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1692         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1693         check_added_monitors!(nodes[1], 1);
1694         // B is already AwaitingRAA, so cant generate a CS here
1695         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1696
1697         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1698         check_added_monitors!(nodes[1], 1);
1699         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1700
1701         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1702         check_added_monitors!(nodes[0], 1);
1703         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1704
1705         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1706         check_added_monitors!(nodes[1], 1);
1707         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1708
1709         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1710         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1711         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1712         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1713         // on-chain as necessary).
1714         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1715         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1716         check_added_monitors!(nodes[0], 1);
1717         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1718         expect_payment_sent!(nodes[0], payment_preimage_2);
1719
1720         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1721         check_added_monitors!(nodes[1], 1);
1722         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1723
1724         expect_pending_htlcs_forwardable!(nodes[1]);
1725         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1726
1727         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1728         // resolve the second HTLC from A's point of view.
1729         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1730         check_added_monitors!(nodes[0], 1);
1731         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1732
1733         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1734         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1735         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1736         let send_2 = {
1737                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1738                 nodes[1].node.send_payment(route, payment_hash_4, None).unwrap();
1739                 check_added_monitors!(nodes[1], 1);
1740                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1741                 assert_eq!(events.len(), 1);
1742                 SendEvent::from_event(events.remove(0))
1743         };
1744
1745         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1746         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1747         check_added_monitors!(nodes[0], 1);
1748         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1749
1750         // Now just resolve all the outstanding messages/HTLCs for completeness...
1751
1752         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1753         check_added_monitors!(nodes[1], 1);
1754         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1755
1756         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1757         check_added_monitors!(nodes[1], 1);
1758
1759         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1760         check_added_monitors!(nodes[0], 1);
1761         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1762
1763         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1764         check_added_monitors!(nodes[1], 1);
1765         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1766
1767         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1768         check_added_monitors!(nodes[0], 1);
1769
1770         expect_pending_htlcs_forwardable!(nodes[0]);
1771         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1772
1773         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1774         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1775 }
1776
1777 #[test]
1778 fn channel_monitor_network_test() {
1779         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1780         // tests that ChannelMonitor is able to recover from various states.
1781         let node_cfgs = create_node_cfgs(5);
1782         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1783         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1784
1785         // Create some initial channels
1786         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1787         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1788         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1789         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1790
1791         // Rebalance the network a bit by relaying one payment through all the channels...
1792         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1793         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1794         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1795         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1796
1797         // Simple case with no pending HTLCs:
1798         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1799         {
1800                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1801                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1802                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1803                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1804         }
1805         get_announce_close_broadcast_events(&nodes, 0, 1);
1806         assert_eq!(nodes[0].node.list_channels().len(), 0);
1807         assert_eq!(nodes[1].node.list_channels().len(), 1);
1808
1809         // One pending HTLC is discarded by the force-close:
1810         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1811
1812         // Simple case of one pending HTLC to HTLC-Timeout
1813         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1814         {
1815                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1816                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1817                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1818                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1819         }
1820         get_announce_close_broadcast_events(&nodes, 1, 2);
1821         assert_eq!(nodes[1].node.list_channels().len(), 0);
1822         assert_eq!(nodes[2].node.list_channels().len(), 1);
1823
1824         macro_rules! claim_funds {
1825                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1826                         {
1827                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1828                                 check_added_monitors!($node, 1);
1829
1830                                 let events = $node.node.get_and_clear_pending_msg_events();
1831                                 assert_eq!(events.len(), 1);
1832                                 match events[0] {
1833                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1834                                                 assert!(update_add_htlcs.is_empty());
1835                                                 assert!(update_fail_htlcs.is_empty());
1836                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1837                                         },
1838                                         _ => panic!("Unexpected event"),
1839                                 };
1840                         }
1841                 }
1842         }
1843
1844         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1845         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1846         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1847         let node2_commitment_txid;
1848         {
1849                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1850                 node2_commitment_txid = node_txn[0].txid();
1851
1852                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1853                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1854
1855                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1856                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1857
1858                 check_preimage_claim(&nodes[3], &node_txn);
1859         }
1860         get_announce_close_broadcast_events(&nodes, 2, 3);
1861         assert_eq!(nodes[2].node.list_channels().len(), 0);
1862         assert_eq!(nodes[3].node.list_channels().len(), 1);
1863
1864         { // Cheat and reset nodes[4]'s height to 1
1865                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1866                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1867         }
1868
1869         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1870         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1871         // One pending HTLC to time out:
1872         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1873         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1874         // buffer space).
1875
1876         {
1877                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1878                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1879                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1880                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1881                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1882                 }
1883
1884                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1885                 {
1886                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1887                         node_txn.retain(|tx| {
1888                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
1889                                         false
1890                                 } else { true }
1891                         });
1892                 }
1893
1894                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1895
1896                 // Claim the payment on nodes[4], giving it knowledge of the preimage
1897                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1898
1899                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1900
1901                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1902                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1903                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1904                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1905                 }
1906
1907                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1908
1909                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1910                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1911
1912                 check_preimage_claim(&nodes[4], &node_txn);
1913         }
1914         get_announce_close_broadcast_events(&nodes, 3, 4);
1915         assert_eq!(nodes[3].node.list_channels().len(), 0);
1916         assert_eq!(nodes[4].node.list_channels().len(), 0);
1917 }
1918
1919 #[test]
1920 fn test_justice_tx() {
1921         // Test justice txn built on revoked HTLC-Success tx, against both sides
1922         let mut alice_config = UserConfig::default();
1923         alice_config.channel_options.announced_channel = true;
1924         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1925         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1926         let mut bob_config = UserConfig::default();
1927         bob_config.channel_options.announced_channel = true;
1928         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1929         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1930         let user_cfgs = [Some(alice_config), Some(bob_config)];
1931         let node_cfgs = create_node_cfgs(2);
1932         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
1933         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1934         // Create some new channels:
1935         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1936
1937         // A pending HTLC which will be revoked:
1938         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1939         // Get the will-be-revoked local txn from nodes[0]
1940         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
1941         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1942         assert_eq!(revoked_local_txn[0].input.len(), 1);
1943         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1944         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1945         assert_eq!(revoked_local_txn[1].input.len(), 1);
1946         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1947         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1948         // Revoke the old state
1949         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1950
1951         {
1952                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1953                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1954                 {
1955                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1956                         assert_eq!(node_txn.len(), 3);
1957                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1958                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1959
1960                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1961                         node_txn.swap_remove(0);
1962                         node_txn.truncate(1);
1963                 }
1964                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1965
1966                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1967                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1968                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1969                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1970                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
1971         }
1972         get_announce_close_broadcast_events(&nodes, 0, 1);
1973
1974         assert_eq!(nodes[0].node.list_channels().len(), 0);
1975         assert_eq!(nodes[1].node.list_channels().len(), 0);
1976
1977         // We test justice_tx build by A on B's revoked HTLC-Success tx
1978         // Create some new channels:
1979         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1980         {
1981                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1982                 node_txn.clear();
1983         }
1984
1985         // A pending HTLC which will be revoked:
1986         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1987         // Get the will-be-revoked local txn from B
1988         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
1989         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1990         assert_eq!(revoked_local_txn[0].input.len(), 1);
1991         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1992         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1993         // Revoke the old state
1994         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
1995         {
1996                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1997                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1998                 {
1999                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2000                         assert_eq!(node_txn.len(), 3);
2001                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2002                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2003
2004                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2005                         node_txn.swap_remove(0);
2006                 }
2007                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2008
2009                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2010                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2011                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2012                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2013                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2014         }
2015         get_announce_close_broadcast_events(&nodes, 0, 1);
2016         assert_eq!(nodes[0].node.list_channels().len(), 0);
2017         assert_eq!(nodes[1].node.list_channels().len(), 0);
2018 }
2019
2020 #[test]
2021 fn revoked_output_claim() {
2022         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2023         // transaction is broadcast by its counterparty
2024         let node_cfgs = create_node_cfgs(2);
2025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2026         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2027         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2028         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2029         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2030         assert_eq!(revoked_local_txn.len(), 1);
2031         // Only output is the full channel value back to nodes[0]:
2032         assert_eq!(revoked_local_txn[0].output.len(), 1);
2033         // Send a payment through, updating everyone's latest commitment txn
2034         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2035
2036         // Inform nodes[1] that nodes[0] broadcast a stale tx
2037         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2038         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2039         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2040         assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2041
2042         assert_eq!(node_txn[0], node_txn[2]);
2043
2044         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2045         check_spends!(node_txn[1], chan_1.3.clone());
2046
2047         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2048         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2049         get_announce_close_broadcast_events(&nodes, 0, 1);
2050 }
2051
2052 #[test]
2053 fn claim_htlc_outputs_shared_tx() {
2054         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2055         let node_cfgs = create_node_cfgs(2);
2056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2057         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2058
2059         // Create some new channel:
2060         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2061
2062         // Rebalance the network to generate htlc in the two directions
2063         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2064         // 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
2065         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2066         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2067
2068         // Get the will-be-revoked local txn from node[0]
2069         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2070         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2071         assert_eq!(revoked_local_txn[0].input.len(), 1);
2072         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2073         assert_eq!(revoked_local_txn[1].input.len(), 1);
2074         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2075         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2076         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2077
2078         //Revoke the old state
2079         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2080
2081         {
2082                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2083                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2084                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2085                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2086
2087                 let events = nodes[1].node.get_and_clear_pending_events();
2088                 assert_eq!(events.len(), 1);
2089                 match events[0] {
2090                         Event::PaymentFailed { payment_hash, .. } => {
2091                                 assert_eq!(payment_hash, payment_hash_2);
2092                         },
2093                         _ => panic!("Unexpected event"),
2094                 }
2095
2096                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2097                 assert_eq!(node_txn.len(), 4);
2098
2099                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2100                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2101
2102                 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2103
2104                 let mut witness_lens = BTreeSet::new();
2105                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2106                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2107                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2108                 assert_eq!(witness_lens.len(), 3);
2109                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2110                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2111                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2112
2113                 // Next nodes[1] broadcasts its current local tx state:
2114                 assert_eq!(node_txn[1].input.len(), 1);
2115                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2116
2117                 assert_eq!(node_txn[2].input.len(), 1);
2118                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2119                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2120                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2121                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2122                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2123         }
2124         get_announce_close_broadcast_events(&nodes, 0, 1);
2125         assert_eq!(nodes[0].node.list_channels().len(), 0);
2126         assert_eq!(nodes[1].node.list_channels().len(), 0);
2127 }
2128
2129 #[test]
2130 fn claim_htlc_outputs_single_tx() {
2131         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2132         let node_cfgs = create_node_cfgs(2);
2133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2135
2136         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2137
2138         // Rebalance the network to generate htlc in the two directions
2139         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2140         // 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
2141         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2142         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2143         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2144
2145         // Get the will-be-revoked local txn from node[0]
2146         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2147
2148         //Revoke the old state
2149         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2150
2151         {
2152                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2153                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2154                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2155
2156                 // Expect pending failures, but we don't bother trying to update the channel state with them.
2157                 let events = nodes[0].node.get_and_clear_pending_events();
2158                 assert_eq!(events.len(), 1);
2159                 match events[0] {
2160                         Event::PendingHTLCsForwardable { .. } => { },
2161                         _ => panic!("Unexpected event"),
2162                 };
2163
2164                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2165
2166                 let events = nodes[1].node.get_and_clear_pending_events();
2167                 assert_eq!(events.len(), 1);
2168                 match events[0] {
2169                         Event::PaymentFailed { payment_hash, .. } => {
2170                                 assert_eq!(payment_hash, payment_hash_2);
2171                         },
2172                         _ => panic!("Unexpected event"),
2173                 }
2174
2175                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2176                 assert_eq!(node_txn.len(), 29); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan) + 5 * (1 local commitment tx + 1 htlc timeout tx)
2177
2178                 assert_eq!(node_txn[0], node_txn[7]);
2179                 assert_eq!(node_txn[1], node_txn[8]);
2180                 assert_eq!(node_txn[2], node_txn[9]);
2181                 assert_eq!(node_txn[3], node_txn[10]);
2182                 assert_eq!(node_txn[4], node_txn[11]);
2183                 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2184                 assert_eq!(node_txn[4], node_txn[6]);
2185
2186                 assert_eq!(node_txn[0].input.len(), 1);
2187                 assert_eq!(node_txn[1].input.len(), 1);
2188                 assert_eq!(node_txn[2].input.len(), 1);
2189
2190                 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2191                         if out_point.txid == tx.txid() {
2192                                 tx.output.get(out_point.vout as usize).cloned()
2193                         } else {
2194                                 None
2195                         }
2196                 }
2197                 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2198                 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2199                 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2200
2201                 let mut witness_lens = BTreeSet::new();
2202                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2203                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2204                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2205                 assert_eq!(witness_lens.len(), 3);
2206                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2207                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2208                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2209
2210                 assert_eq!(node_txn[3].input.len(), 1);
2211                 check_spends!(node_txn[3], chan_1.3.clone());
2212
2213                 assert_eq!(node_txn[4].input.len(), 1);
2214                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2215                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2216                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2217                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2218                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2219         }
2220         get_announce_close_broadcast_events(&nodes, 0, 1);
2221         assert_eq!(nodes[0].node.list_channels().len(), 0);
2222         assert_eq!(nodes[1].node.list_channels().len(), 0);
2223 }
2224
2225 #[test]
2226 fn test_htlc_on_chain_success() {
2227         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2228         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2229         // broadcasting the right event to other nodes in payment path.
2230         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2231         // A --------------------> B ----------------------> C (preimage)
2232         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2233         // commitment transaction was broadcast.
2234         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2235         // towards B.
2236         // B should be able to claim via preimage if A then broadcasts its local tx.
2237         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2238         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2239         // PaymentSent event).
2240
2241         let node_cfgs = create_node_cfgs(3);
2242         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2243         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2244
2245         // Create some initial channels
2246         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2247         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2248
2249         // Rebalance the network a bit by relaying one payment through all the channels...
2250         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2251         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2252
2253         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2254         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2255         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2256
2257         // Broadcast legit commitment tx from C on B's chain
2258         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2259         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2260         assert_eq!(commitment_tx.len(), 1);
2261         check_spends!(commitment_tx[0], chan_2.3.clone());
2262         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2263         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2264         check_added_monitors!(nodes[2], 2);
2265         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2266         assert!(updates.update_add_htlcs.is_empty());
2267         assert!(updates.update_fail_htlcs.is_empty());
2268         assert!(updates.update_fail_malformed_htlcs.is_empty());
2269         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2270
2271         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2272         check_closed_broadcast!(nodes[2], false);
2273         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2274         assert_eq!(node_txn.len(), 7);
2275         assert_eq!(node_txn[0], node_txn[3]);
2276         assert_eq!(node_txn[1], node_txn[4]);
2277         assert_eq!(node_txn[0], node_txn[5]);
2278         assert_eq!(node_txn[1], node_txn[6]);
2279         assert_eq!(node_txn[2], commitment_tx[0]);
2280         check_spends!(node_txn[0], commitment_tx[0].clone());
2281         check_spends!(node_txn[1], commitment_tx[0].clone());
2282         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2283         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2284         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2285         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2286         assert_eq!(node_txn[0].lock_time, 0);
2287         assert_eq!(node_txn[1].lock_time, 0);
2288
2289         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2290         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2291         let events = nodes[1].node.get_and_clear_pending_msg_events();
2292         {
2293                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2294                 assert_eq!(added_monitors.len(), 2);
2295                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2296                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2297                 added_monitors.clear();
2298         }
2299         assert_eq!(events.len(), 2);
2300         match events[0] {
2301                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2302                 _ => panic!("Unexpected event"),
2303         }
2304         match events[1] {
2305                 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, .. } } => {
2306                         assert!(update_add_htlcs.is_empty());
2307                         assert!(update_fail_htlcs.is_empty());
2308                         assert_eq!(update_fulfill_htlcs.len(), 1);
2309                         assert!(update_fail_malformed_htlcs.is_empty());
2310                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2311                 },
2312                 _ => panic!("Unexpected event"),
2313         };
2314         macro_rules! check_tx_local_broadcast {
2315                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2316                         // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2317                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2318                         assert_eq!(node_txn.len(), 7);
2319                         assert_eq!(node_txn[0], node_txn[5]);
2320                         assert_eq!(node_txn[1], node_txn[6]);
2321                         check_spends!(node_txn[0], $commitment_tx.clone());
2322                         check_spends!(node_txn[1], $commitment_tx.clone());
2323                         assert_ne!(node_txn[0].lock_time, 0);
2324                         assert_ne!(node_txn[1].lock_time, 0);
2325                         if $htlc_offered {
2326                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2327                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2328                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2329                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2330                         } else {
2331                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2332                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2333                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2334                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2335                         }
2336                         check_spends!(node_txn[2], $chan_tx.clone());
2337                         check_spends!(node_txn[3], node_txn[2].clone());
2338                         check_spends!(node_txn[4], node_txn[2].clone());
2339                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2340                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2341                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2342                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2343                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2344                         assert_ne!(node_txn[3].lock_time, 0);
2345                         assert_ne!(node_txn[4].lock_time, 0);
2346                         node_txn.clear();
2347                 } }
2348         }
2349         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2350         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2351         // timeout-claim of the output that nodes[2] just claimed via success.
2352         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2353
2354         // Broadcast legit commitment tx from A on B's chain
2355         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2356         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2357         check_spends!(commitment_tx[0], chan_1.3.clone());
2358         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2359         check_closed_broadcast!(nodes[1], false);
2360         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + 2*HTLC-Success), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2361         assert_eq!(node_txn.len(), 5);
2362         assert_eq!(node_txn[0], node_txn[4]);
2363         check_spends!(node_txn[0], commitment_tx[0].clone());
2364         assert_eq!(node_txn[0].input.len(), 2);
2365         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2366         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2367         assert_eq!(node_txn[0].lock_time, 0);
2368         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2369         check_spends!(node_txn[1], chan_1.3.clone());
2370         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2371         check_spends!(node_txn[2], node_txn[1]);
2372         check_spends!(node_txn[3], node_txn[1]);
2373         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2374         // we already checked the same situation with A.
2375
2376         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2377         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2378         check_closed_broadcast!(nodes[0], false);
2379         let events = nodes[0].node.get_and_clear_pending_events();
2380         assert_eq!(events.len(), 2);
2381         let mut first_claimed = false;
2382         for event in events {
2383                 match event {
2384                         Event::PaymentSent { payment_preimage } => {
2385                                 if payment_preimage == our_payment_preimage {
2386                                         assert!(!first_claimed);
2387                                         first_claimed = true;
2388                                 } else {
2389                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2390                                 }
2391                         },
2392                         _ => panic!("Unexpected event"),
2393                 }
2394         }
2395         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2396 }
2397
2398 #[test]
2399 fn test_htlc_on_chain_timeout() {
2400         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2401         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2402         // broadcasting the right event to other nodes in payment path.
2403         // A ------------------> B ----------------------> C (timeout)
2404         //    B's commitment tx                 C's commitment tx
2405         //            \                                  \
2406         //         B's HTLC timeout tx               B's timeout tx
2407
2408         let node_cfgs = create_node_cfgs(3);
2409         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2410         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2411
2412         // Create some intial channels
2413         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2414         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2415
2416         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2417         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2418         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2419
2420         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2421         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2422
2423         // Broadcast legit commitment tx from C on B's chain
2424         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2425         check_spends!(commitment_tx[0], chan_2.3.clone());
2426         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2427         check_added_monitors!(nodes[2], 0);
2428         expect_pending_htlcs_forwardable!(nodes[2]);
2429         check_added_monitors!(nodes[2], 1);
2430
2431         let events = nodes[2].node.get_and_clear_pending_msg_events();
2432         assert_eq!(events.len(), 1);
2433         match events[0] {
2434                 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, .. } } => {
2435                         assert!(update_add_htlcs.is_empty());
2436                         assert!(!update_fail_htlcs.is_empty());
2437                         assert!(update_fulfill_htlcs.is_empty());
2438                         assert!(update_fail_malformed_htlcs.is_empty());
2439                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2440                 },
2441                 _ => panic!("Unexpected event"),
2442         };
2443         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2444         check_closed_broadcast!(nodes[2], false);
2445         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2446         assert_eq!(node_txn.len(), 1);
2447         check_spends!(node_txn[0], chan_2.3.clone());
2448         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2449
2450         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2451         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2452         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2453         let timeout_tx;
2454         {
2455                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2456                 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2457                 assert_eq!(node_txn[0], node_txn[5]);
2458                 assert_eq!(node_txn[1], node_txn[6]);
2459                 assert_eq!(node_txn[2], node_txn[7]);
2460                 check_spends!(node_txn[0], commitment_tx[0].clone());
2461                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2462                 check_spends!(node_txn[1], chan_2.3.clone());
2463                 check_spends!(node_txn[2], node_txn[1].clone());
2464                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2465                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2466                 check_spends!(node_txn[3], chan_2.3.clone());
2467                 check_spends!(node_txn[4], node_txn[3].clone());
2468                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2469                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2470                 timeout_tx = node_txn[0].clone();
2471                 node_txn.clear();
2472         }
2473
2474         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2475         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2476         check_added_monitors!(nodes[1], 0);
2477         check_closed_broadcast!(nodes[1], false);
2478
2479         expect_pending_htlcs_forwardable!(nodes[1]);
2480         check_added_monitors!(nodes[1], 1);
2481         let events = nodes[1].node.get_and_clear_pending_msg_events();
2482         assert_eq!(events.len(), 1);
2483         match events[0] {
2484                 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, .. } } => {
2485                         assert!(update_add_htlcs.is_empty());
2486                         assert!(!update_fail_htlcs.is_empty());
2487                         assert!(update_fulfill_htlcs.is_empty());
2488                         assert!(update_fail_malformed_htlcs.is_empty());
2489                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2490                 },
2491                 _ => panic!("Unexpected event"),
2492         };
2493         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
2494         assert_eq!(node_txn.len(), 0);
2495
2496         // Broadcast legit commitment tx from B on A's chain
2497         let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2498         check_spends!(commitment_tx[0], chan_1.3.clone());
2499
2500         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2501         check_closed_broadcast!(nodes[0], false);
2502         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2503         assert_eq!(node_txn.len(), 4);
2504         assert_eq!(node_txn[0], node_txn[3]);
2505         check_spends!(node_txn[0], commitment_tx[0].clone());
2506         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2507         check_spends!(node_txn[1], chan_1.3.clone());
2508         check_spends!(node_txn[2], node_txn[1].clone());
2509         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2510         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2511 }
2512
2513 #[test]
2514 fn test_simple_commitment_revoked_fail_backward() {
2515         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2516         // and fail backward accordingly.
2517
2518         let node_cfgs = create_node_cfgs(3);
2519         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2520         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2521
2522         // Create some initial channels
2523         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2524         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2525
2526         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2527         // Get the will-be-revoked local txn from nodes[2]
2528         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2529         // Revoke the old state
2530         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2531
2532         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2533
2534         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2535         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2536         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2537         check_added_monitors!(nodes[1], 0);
2538         check_closed_broadcast!(nodes[1], false);
2539
2540         expect_pending_htlcs_forwardable!(nodes[1]);
2541         check_added_monitors!(nodes[1], 1);
2542         let events = nodes[1].node.get_and_clear_pending_msg_events();
2543         assert_eq!(events.len(), 1);
2544         match events[0] {
2545                 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, .. } } => {
2546                         assert!(update_add_htlcs.is_empty());
2547                         assert_eq!(update_fail_htlcs.len(), 1);
2548                         assert!(update_fulfill_htlcs.is_empty());
2549                         assert!(update_fail_malformed_htlcs.is_empty());
2550                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2551
2552                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2553                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2554
2555                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2556                         assert_eq!(events.len(), 1);
2557                         match events[0] {
2558                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2559                                 _ => panic!("Unexpected event"),
2560                         }
2561                         let events = nodes[0].node.get_and_clear_pending_events();
2562                         assert_eq!(events.len(), 1);
2563                         match events[0] {
2564                                 Event::PaymentFailed { .. } => {},
2565                                 _ => panic!("Unexpected event"),
2566                         }
2567                 },
2568                 _ => panic!("Unexpected event"),
2569         }
2570 }
2571
2572 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2573         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2574         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2575         // commitment transaction anymore.
2576         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2577         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2578         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2579         // technically disallowed and we should probably handle it reasonably.
2580         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2581         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2582         // transactions:
2583         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2584         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2585         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2586         //   and once they revoke the previous commitment transaction (allowing us to send a new
2587         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2588         let node_cfgs = create_node_cfgs(3);
2589         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2590         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2591
2592         // Create some initial channels
2593         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2594         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2595
2596         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2597         // Get the will-be-revoked local txn from nodes[2]
2598         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2599         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2600         // Revoke the old state
2601         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2602
2603         let value = if use_dust {
2604                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2605                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2606                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2607         } else { 3000000 };
2608
2609         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2610         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2611         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2612
2613         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2614         expect_pending_htlcs_forwardable!(nodes[2]);
2615         check_added_monitors!(nodes[2], 1);
2616         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2617         assert!(updates.update_add_htlcs.is_empty());
2618         assert!(updates.update_fulfill_htlcs.is_empty());
2619         assert!(updates.update_fail_malformed_htlcs.is_empty());
2620         assert_eq!(updates.update_fail_htlcs.len(), 1);
2621         assert!(updates.update_fee.is_none());
2622         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2623         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2624         // Drop the last RAA from 3 -> 2
2625
2626         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2627         expect_pending_htlcs_forwardable!(nodes[2]);
2628         check_added_monitors!(nodes[2], 1);
2629         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2630         assert!(updates.update_add_htlcs.is_empty());
2631         assert!(updates.update_fulfill_htlcs.is_empty());
2632         assert!(updates.update_fail_malformed_htlcs.is_empty());
2633         assert_eq!(updates.update_fail_htlcs.len(), 1);
2634         assert!(updates.update_fee.is_none());
2635         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2636         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2637         check_added_monitors!(nodes[1], 1);
2638         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2639         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2640         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2641         check_added_monitors!(nodes[2], 1);
2642
2643         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2644         expect_pending_htlcs_forwardable!(nodes[2]);
2645         check_added_monitors!(nodes[2], 1);
2646         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2647         assert!(updates.update_add_htlcs.is_empty());
2648         assert!(updates.update_fulfill_htlcs.is_empty());
2649         assert!(updates.update_fail_malformed_htlcs.is_empty());
2650         assert_eq!(updates.update_fail_htlcs.len(), 1);
2651         assert!(updates.update_fee.is_none());
2652         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2653         // At this point first_payment_hash has dropped out of the latest two commitment
2654         // transactions that nodes[1] is tracking...
2655         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2656         check_added_monitors!(nodes[1], 1);
2657         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2658         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2659         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2660         check_added_monitors!(nodes[2], 1);
2661
2662         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2663         // on nodes[2]'s RAA.
2664         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2665         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2666         nodes[1].node.send_payment(route, fourth_payment_hash, None).unwrap();
2667         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2668         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2669         check_added_monitors!(nodes[1], 0);
2670
2671         if deliver_bs_raa {
2672                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2673                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2674                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2675                 check_added_monitors!(nodes[1], 1);
2676                 let events = nodes[1].node.get_and_clear_pending_events();
2677                 assert_eq!(events.len(), 1);
2678                 match events[0] {
2679                         Event::PendingHTLCsForwardable { .. } => { },
2680                         _ => panic!("Unexpected event"),
2681                 };
2682                 // Deliberately don't process the pending fail-back so they all fail back at once after
2683                 // block connection just like the !deliver_bs_raa case
2684         }
2685
2686         let mut failed_htlcs = HashSet::new();
2687         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2688
2689         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2690         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2691         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2692
2693         let events = nodes[1].node.get_and_clear_pending_events();
2694         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2695         match events[0] {
2696                 Event::PaymentFailed { ref payment_hash, .. } => {
2697                         assert_eq!(*payment_hash, fourth_payment_hash);
2698                 },
2699                 _ => panic!("Unexpected event"),
2700         }
2701         if !deliver_bs_raa {
2702                 match events[1] {
2703                         Event::PendingHTLCsForwardable { .. } => { },
2704                         _ => panic!("Unexpected event"),
2705                 };
2706         }
2707         nodes[1].node.process_pending_htlc_forwards();
2708         check_added_monitors!(nodes[1], 1);
2709
2710         let events = nodes[1].node.get_and_clear_pending_msg_events();
2711         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2712         match events[if deliver_bs_raa { 1 } else { 0 }] {
2713                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2714                 _ => panic!("Unexpected event"),
2715         }
2716         if deliver_bs_raa {
2717                 match events[0] {
2718                         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, .. } } => {
2719                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2720                                 assert_eq!(update_add_htlcs.len(), 1);
2721                                 assert!(update_fulfill_htlcs.is_empty());
2722                                 assert!(update_fail_htlcs.is_empty());
2723                                 assert!(update_fail_malformed_htlcs.is_empty());
2724                         },
2725                         _ => panic!("Unexpected event"),
2726                 }
2727         }
2728         match events[if deliver_bs_raa { 2 } else { 1 }] {
2729                 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, .. } } => {
2730                         assert!(update_add_htlcs.is_empty());
2731                         assert_eq!(update_fail_htlcs.len(), 3);
2732                         assert!(update_fulfill_htlcs.is_empty());
2733                         assert!(update_fail_malformed_htlcs.is_empty());
2734                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2735
2736                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2737                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2738                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2739
2740                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2741
2742                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2743                         // If we delivered B's RAA we got an unknown preimage error, not something
2744                         // that we should update our routing table for.
2745                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2746                         for event in events {
2747                                 match event {
2748                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2749                                         _ => panic!("Unexpected event"),
2750                                 }
2751                         }
2752                         let events = nodes[0].node.get_and_clear_pending_events();
2753                         assert_eq!(events.len(), 3);
2754                         match events[0] {
2755                                 Event::PaymentFailed { ref payment_hash, .. } => {
2756                                         assert!(failed_htlcs.insert(payment_hash.0));
2757                                 },
2758                                 _ => panic!("Unexpected event"),
2759                         }
2760                         match events[1] {
2761                                 Event::PaymentFailed { ref payment_hash, .. } => {
2762                                         assert!(failed_htlcs.insert(payment_hash.0));
2763                                 },
2764                                 _ => panic!("Unexpected event"),
2765                         }
2766                         match events[2] {
2767                                 Event::PaymentFailed { ref payment_hash, .. } => {
2768                                         assert!(failed_htlcs.insert(payment_hash.0));
2769                                 },
2770                                 _ => panic!("Unexpected event"),
2771                         }
2772                 },
2773                 _ => panic!("Unexpected event"),
2774         }
2775
2776         assert!(failed_htlcs.contains(&first_payment_hash.0));
2777         assert!(failed_htlcs.contains(&second_payment_hash.0));
2778         assert!(failed_htlcs.contains(&third_payment_hash.0));
2779 }
2780
2781 #[test]
2782 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2783         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2784         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2785         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2786         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2787 }
2788
2789 #[test]
2790 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2791         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2792         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2793         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2794         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2795 }
2796
2797 #[test]
2798 fn test_htlc_ignore_latest_remote_commitment() {
2799         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2800         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2801         let node_cfgs = create_node_cfgs(2);
2802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2803         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2804         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2805
2806         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2807         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2808         check_closed_broadcast!(nodes[0], false);
2809
2810         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2811         assert_eq!(node_txn.len(), 2);
2812
2813         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2814         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2815         check_closed_broadcast!(nodes[1], false);
2816
2817         // Duplicate the block_connected call since this may happen due to other listeners
2818         // registering new transactions
2819         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2820 }
2821
2822 #[test]
2823 fn test_force_close_fail_back() {
2824         // Check which HTLCs are failed-backwards on channel force-closure
2825         let node_cfgs = create_node_cfgs(3);
2826         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2827         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2828         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2829         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2830
2831         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2832
2833         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2834
2835         let mut payment_event = {
2836                 nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
2837                 check_added_monitors!(nodes[0], 1);
2838
2839                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2840                 assert_eq!(events.len(), 1);
2841                 SendEvent::from_event(events.remove(0))
2842         };
2843
2844         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2845         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2846
2847         expect_pending_htlcs_forwardable!(nodes[1]);
2848
2849         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2850         assert_eq!(events_2.len(), 1);
2851         payment_event = SendEvent::from_event(events_2.remove(0));
2852         assert_eq!(payment_event.msgs.len(), 1);
2853
2854         check_added_monitors!(nodes[1], 1);
2855         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2856         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2857         check_added_monitors!(nodes[2], 1);
2858         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2859
2860         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2861         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2862         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2863
2864         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2865         check_closed_broadcast!(nodes[2], false);
2866         let tx = {
2867                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2868                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2869                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2870                 // back to nodes[1] upon timeout otherwise.
2871                 assert_eq!(node_txn.len(), 1);
2872                 node_txn.remove(0)
2873         };
2874
2875         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2876         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2877
2878         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2879         check_closed_broadcast!(nodes[1], false);
2880
2881         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2882         {
2883                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2884                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2885                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2886         }
2887         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2888         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2889         assert_eq!(node_txn.len(), 1);
2890         assert_eq!(node_txn[0].input.len(), 1);
2891         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2892         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2893         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2894
2895         check_spends!(node_txn[0], tx);
2896 }
2897
2898 #[test]
2899 fn test_unconf_chan() {
2900         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2901         let node_cfgs = create_node_cfgs(2);
2902         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2903         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2904         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2905
2906         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2907         assert_eq!(channel_state.by_id.len(), 1);
2908         assert_eq!(channel_state.short_to_id.len(), 1);
2909         mem::drop(channel_state);
2910
2911         let mut headers = Vec::new();
2912         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2913         headers.push(header.clone());
2914         for _i in 2..100 {
2915                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2916                 headers.push(header.clone());
2917         }
2918         let mut height = 99;
2919         while !headers.is_empty() {
2920                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2921                 height -= 1;
2922         }
2923         check_closed_broadcast!(nodes[0], false);
2924         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2925         assert_eq!(channel_state.by_id.len(), 0);
2926         assert_eq!(channel_state.short_to_id.len(), 0);
2927 }
2928
2929 #[test]
2930 fn test_simple_peer_disconnect() {
2931         // Test that we can reconnect when there are no lost messages
2932         let node_cfgs = create_node_cfgs(3);
2933         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2934         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2935         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2936         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2937
2938         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2939         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2940         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2941
2942         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2943         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2944         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2945         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2946
2947         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2948         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2949         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2950
2951         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2952         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2953         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2954         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2955
2956         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2957         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2958
2959         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2960         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2961
2962         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2963         {
2964                 let events = nodes[0].node.get_and_clear_pending_events();
2965                 assert_eq!(events.len(), 2);
2966                 match events[0] {
2967                         Event::PaymentSent { payment_preimage } => {
2968                                 assert_eq!(payment_preimage, payment_preimage_3);
2969                         },
2970                         _ => panic!("Unexpected event"),
2971                 }
2972                 match events[1] {
2973                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2974                                 assert_eq!(payment_hash, payment_hash_5);
2975                                 assert!(rejected_by_dest);
2976                         },
2977                         _ => panic!("Unexpected event"),
2978                 }
2979         }
2980
2981         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
2982         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2983 }
2984
2985 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2986         // Test that we can reconnect when in-flight HTLC updates get dropped
2987         let node_cfgs = create_node_cfgs(2);
2988         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2989         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2990         if messages_delivered == 0 {
2991                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
2992                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2993         } else {
2994                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2995         }
2996
2997         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2998         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2999
3000         let payment_event = {
3001                 nodes[0].node.send_payment(route.clone(), payment_hash_1, None).unwrap();
3002                 check_added_monitors!(nodes[0], 1);
3003
3004                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3005                 assert_eq!(events.len(), 1);
3006                 SendEvent::from_event(events.remove(0))
3007         };
3008         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3009
3010         if messages_delivered < 2 {
3011                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3012         } else {
3013                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3014                 if messages_delivered >= 3 {
3015                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3016                         check_added_monitors!(nodes[1], 1);
3017                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3018
3019                         if messages_delivered >= 4 {
3020                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3021                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3022                                 check_added_monitors!(nodes[0], 1);
3023
3024                                 if messages_delivered >= 5 {
3025                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3026                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3027                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3028                                         check_added_monitors!(nodes[0], 1);
3029
3030                                         if messages_delivered >= 6 {
3031                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3032                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3033                                                 check_added_monitors!(nodes[1], 1);
3034                                         }
3035                                 }
3036                         }
3037                 }
3038         }
3039
3040         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3041         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3042         if messages_delivered < 3 {
3043                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3044                 // received on either side, both sides will need to resend them.
3045                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3046         } else if messages_delivered == 3 {
3047                 // nodes[0] still wants its RAA + commitment_signed
3048                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3049         } else if messages_delivered == 4 {
3050                 // nodes[0] still wants its commitment_signed
3051                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3052         } else if messages_delivered == 5 {
3053                 // nodes[1] still wants its final RAA
3054                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3055         } else if messages_delivered == 6 {
3056                 // Everything was delivered...
3057                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3058         }
3059
3060         let events_1 = nodes[1].node.get_and_clear_pending_events();
3061         assert_eq!(events_1.len(), 1);
3062         match events_1[0] {
3063                 Event::PendingHTLCsForwardable { .. } => { },
3064                 _ => panic!("Unexpected event"),
3065         };
3066
3067         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3068         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3069         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3070
3071         nodes[1].node.process_pending_htlc_forwards();
3072
3073         let events_2 = nodes[1].node.get_and_clear_pending_events();
3074         assert_eq!(events_2.len(), 1);
3075         match events_2[0] {
3076                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3077                         assert_eq!(payment_hash_1, *payment_hash);
3078                         assert_eq!(*payment_secret, None);
3079                         assert_eq!(amt, 1000000);
3080                 },
3081                 _ => panic!("Unexpected event"),
3082         }
3083
3084         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3085         check_added_monitors!(nodes[1], 1);
3086
3087         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3088         assert_eq!(events_3.len(), 1);
3089         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3090                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3091                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3092                         assert!(updates.update_add_htlcs.is_empty());
3093                         assert!(updates.update_fail_htlcs.is_empty());
3094                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3095                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3096                         assert!(updates.update_fee.is_none());
3097                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3098                 },
3099                 _ => panic!("Unexpected event"),
3100         };
3101
3102         if messages_delivered >= 1 {
3103                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3104
3105                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3106                 assert_eq!(events_4.len(), 1);
3107                 match events_4[0] {
3108                         Event::PaymentSent { ref payment_preimage } => {
3109                                 assert_eq!(payment_preimage_1, *payment_preimage);
3110                         },
3111                         _ => panic!("Unexpected event"),
3112                 }
3113
3114                 if messages_delivered >= 2 {
3115                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3116                         check_added_monitors!(nodes[0], 1);
3117                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3118
3119                         if messages_delivered >= 3 {
3120                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3121                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3122                                 check_added_monitors!(nodes[1], 1);
3123
3124                                 if messages_delivered >= 4 {
3125                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3126                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3127                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3128                                         check_added_monitors!(nodes[1], 1);
3129
3130                                         if messages_delivered >= 5 {
3131                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3132                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3133                                                 check_added_monitors!(nodes[0], 1);
3134                                         }
3135                                 }
3136                         }
3137                 }
3138         }
3139
3140         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3141         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3142         if messages_delivered < 2 {
3143                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3144                 //TODO: Deduplicate PaymentSent events, then enable this if:
3145                 //if messages_delivered < 1 {
3146                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3147                         assert_eq!(events_4.len(), 1);
3148                         match events_4[0] {
3149                                 Event::PaymentSent { ref payment_preimage } => {
3150                                         assert_eq!(payment_preimage_1, *payment_preimage);
3151                                 },
3152                                 _ => panic!("Unexpected event"),
3153                         }
3154                 //}
3155         } else if messages_delivered == 2 {
3156                 // nodes[0] still wants its RAA + commitment_signed
3157                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3158         } else if messages_delivered == 3 {
3159                 // nodes[0] still wants its commitment_signed
3160                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3161         } else if messages_delivered == 4 {
3162                 // nodes[1] still wants its final RAA
3163                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3164         } else if messages_delivered == 5 {
3165                 // Everything was delivered...
3166                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3167         }
3168
3169         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3170         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3171         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3172
3173         // Channel should still work fine...
3174         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3175         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3176 }
3177
3178 #[test]
3179 fn test_drop_messages_peer_disconnect_a() {
3180         do_test_drop_messages_peer_disconnect(0);
3181         do_test_drop_messages_peer_disconnect(1);
3182         do_test_drop_messages_peer_disconnect(2);
3183         do_test_drop_messages_peer_disconnect(3);
3184 }
3185
3186 #[test]
3187 fn test_drop_messages_peer_disconnect_b() {
3188         do_test_drop_messages_peer_disconnect(4);
3189         do_test_drop_messages_peer_disconnect(5);
3190         do_test_drop_messages_peer_disconnect(6);
3191 }
3192
3193 #[test]
3194 fn test_funding_peer_disconnect() {
3195         // Test that we can lock in our funding tx while disconnected
3196         let node_cfgs = create_node_cfgs(2);
3197         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3198         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3199         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3200
3201         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3202         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3203
3204         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3205         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3206         assert_eq!(events_1.len(), 1);
3207         match events_1[0] {
3208                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3209                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3210                 },
3211                 _ => panic!("Unexpected event"),
3212         }
3213
3214         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3215
3216         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3217         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3218
3219         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3220         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3221         assert_eq!(events_2.len(), 2);
3222         let funding_locked = match events_2[0] {
3223                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3224                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3225                         msg.clone()
3226                 },
3227                 _ => panic!("Unexpected event"),
3228         };
3229         let bs_announcement_sigs = match events_2[1] {
3230                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3231                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3232                         msg.clone()
3233                 },
3234                 _ => panic!("Unexpected event"),
3235         };
3236
3237         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3238
3239         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3240         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3241         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3242         assert_eq!(events_3.len(), 2);
3243         let as_announcement_sigs = match events_3[0] {
3244                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3245                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3246                         msg.clone()
3247                 },
3248                 _ => panic!("Unexpected event"),
3249         };
3250         let (as_announcement, as_update) = match events_3[1] {
3251                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3252                         (msg.clone(), update_msg.clone())
3253                 },
3254                 _ => panic!("Unexpected event"),
3255         };
3256
3257         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3258         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3259         assert_eq!(events_4.len(), 1);
3260         let (_, bs_update) = match events_4[0] {
3261                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3262                         (msg.clone(), update_msg.clone())
3263                 },
3264                 _ => panic!("Unexpected event"),
3265         };
3266
3267         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3268         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3269         nodes[0].router.handle_channel_update(&as_update).unwrap();
3270
3271         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3272         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3273         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3274 }
3275
3276 #[test]
3277 fn test_drop_messages_peer_disconnect_dual_htlc() {
3278         // Test that we can handle reconnecting when both sides of a channel have pending
3279         // commitment_updates when we disconnect.
3280         let node_cfgs = create_node_cfgs(2);
3281         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3282         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3283         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3284
3285         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3286
3287         // Now try to send a second payment which will fail to send
3288         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3289         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3290
3291         nodes[0].node.send_payment(route.clone(), payment_hash_2, None).unwrap();
3292         check_added_monitors!(nodes[0], 1);
3293
3294         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3295         assert_eq!(events_1.len(), 1);
3296         match events_1[0] {
3297                 MessageSendEvent::UpdateHTLCs { .. } => {},
3298                 _ => panic!("Unexpected event"),
3299         }
3300
3301         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3302         check_added_monitors!(nodes[1], 1);
3303
3304         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3305         assert_eq!(events_2.len(), 1);
3306         match events_2[0] {
3307                 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 } } => {
3308                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3309                         assert!(update_add_htlcs.is_empty());
3310                         assert_eq!(update_fulfill_htlcs.len(), 1);
3311                         assert!(update_fail_htlcs.is_empty());
3312                         assert!(update_fail_malformed_htlcs.is_empty());
3313                         assert!(update_fee.is_none());
3314
3315                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3316                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3317                         assert_eq!(events_3.len(), 1);
3318                         match events_3[0] {
3319                                 Event::PaymentSent { ref payment_preimage } => {
3320                                         assert_eq!(*payment_preimage, payment_preimage_1);
3321                                 },
3322                                 _ => panic!("Unexpected event"),
3323                         }
3324
3325                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3326                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3327                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3328                         check_added_monitors!(nodes[0], 1);
3329                 },
3330                 _ => panic!("Unexpected event"),
3331         }
3332
3333         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3334         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3335
3336         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3337         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3338         assert_eq!(reestablish_1.len(), 1);
3339         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3340         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3341         assert_eq!(reestablish_2.len(), 1);
3342
3343         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3344         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3345         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3346         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3347
3348         assert!(as_resp.0.is_none());
3349         assert!(bs_resp.0.is_none());
3350
3351         assert!(bs_resp.1.is_none());
3352         assert!(bs_resp.2.is_none());
3353
3354         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3355
3356         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3357         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3358         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3359         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3360         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3361         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3362         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3363         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3364         // No commitment_signed so get_event_msg's assert(len == 1) passes
3365         check_added_monitors!(nodes[1], 1);
3366
3367         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3368         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3369         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3370         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3371         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3372         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3373         assert!(bs_second_commitment_signed.update_fee.is_none());
3374         check_added_monitors!(nodes[1], 1);
3375
3376         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3377         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3378         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3379         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3380         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3381         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3382         assert!(as_commitment_signed.update_fee.is_none());
3383         check_added_monitors!(nodes[0], 1);
3384
3385         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3386         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3387         // No commitment_signed so get_event_msg's assert(len == 1) passes
3388         check_added_monitors!(nodes[0], 1);
3389
3390         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3391         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3392         // No commitment_signed so get_event_msg's assert(len == 1) passes
3393         check_added_monitors!(nodes[1], 1);
3394
3395         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3396         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3397         check_added_monitors!(nodes[1], 1);
3398
3399         expect_pending_htlcs_forwardable!(nodes[1]);
3400
3401         let events_5 = nodes[1].node.get_and_clear_pending_events();
3402         assert_eq!(events_5.len(), 1);
3403         match events_5[0] {
3404                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3405                         assert_eq!(payment_hash_2, *payment_hash);
3406                         assert_eq!(*payment_secret, None);
3407                 },
3408                 _ => panic!("Unexpected event"),
3409         }
3410
3411         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3412         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3413         check_added_monitors!(nodes[0], 1);
3414
3415         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3416 }
3417
3418 #[test]
3419 fn test_htlc_timeout() {
3420         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3421         // to avoid our counterparty failing the channel.
3422         let node_cfgs = create_node_cfgs(2);
3423         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3424         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3425
3426         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3427         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 100000);
3428
3429         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3430         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3431         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3432         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
3433                 header.prev_blockhash = header.bitcoin_hash();
3434                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
3435                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
3436         }
3437
3438         expect_pending_htlcs_forwardable!(nodes[1]);
3439
3440         check_added_monitors!(nodes[1], 1);
3441         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3442         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3443         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3444         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3445         assert!(htlc_timeout_updates.update_fee.is_none());
3446
3447         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3448         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3449         let events = nodes[0].node.get_and_clear_pending_events();
3450         match events[0] {
3451                 Event::PaymentFailed { payment_hash, rejected_by_dest, error_code } => {
3452                         assert_eq!(payment_hash, our_payment_hash);
3453                         assert!(rejected_by_dest);
3454                         assert_eq!(error_code.unwrap(), 0x4000 | 15);
3455                 },
3456                 _ => panic!("Unexpected event"),
3457         }
3458 }
3459
3460 #[test]
3461 fn test_invalid_channel_announcement() {
3462         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3463         let secp_ctx = Secp256k1::new();
3464         let node_cfgs = create_node_cfgs(2);
3465         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3466         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3467
3468         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3469
3470         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3471         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3472         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3473         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3474
3475         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3476
3477         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().inner.funding_key);
3478         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().inner.funding_key);
3479
3480         let as_network_key = nodes[0].node.get_our_node_id();
3481         let bs_network_key = nodes[1].node.get_our_node_id();
3482
3483         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3484
3485         let mut chan_announcement;
3486
3487         macro_rules! dummy_unsigned_msg {
3488                 () => {
3489                         msgs::UnsignedChannelAnnouncement {
3490                                 features: ChannelFeatures::supported(),
3491                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3492                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3493                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3494                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3495                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3496                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3497                                 excess_data: Vec::new(),
3498                         };
3499                 }
3500         }
3501
3502         macro_rules! sign_msg {
3503                 ($unsigned_msg: expr) => {
3504                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3505                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
3506                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
3507                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3508                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3509                         chan_announcement = msgs::ChannelAnnouncement {
3510                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3511                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3512                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3513                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3514                                 contents: $unsigned_msg
3515                         }
3516                 }
3517         }
3518
3519         let unsigned_msg = dummy_unsigned_msg!();
3520         sign_msg!(unsigned_msg);
3521         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3522         let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3523
3524         // Configured with Network::Testnet
3525         let mut unsigned_msg = dummy_unsigned_msg!();
3526         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3527         sign_msg!(unsigned_msg);
3528         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3529
3530         let mut unsigned_msg = dummy_unsigned_msg!();
3531         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3532         sign_msg!(unsigned_msg);
3533         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3534 }
3535
3536 #[test]
3537 fn test_no_txn_manager_serialize_deserialize() {
3538         let node_cfgs = create_node_cfgs(2);
3539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3540         let new_chan_monitor: test_utils::TestChannelMonitor;
3541         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3542         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3543
3544         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3545
3546         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3547
3548         let nodes_0_serialized = nodes[0].node.encode();
3549         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3550         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3551
3552         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }));
3553         nodes[0].chan_monitor = &new_chan_monitor;
3554         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3555         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3556         assert!(chan_0_monitor_read.is_empty());
3557
3558         let mut nodes_0_read = &nodes_0_serialized[..];
3559         let config = UserConfig::default();
3560         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3561         let (_, nodes_0_deserialized_tmp) = {
3562                 let mut channel_monitors = HashMap::new();
3563                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3564                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3565                         default_config: config,
3566                         keys_manager,
3567                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3568                         monitor: nodes[0].chan_monitor,
3569                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3570                         logger: Arc::new(test_utils::TestLogger::new()),
3571                         channel_monitors: &mut channel_monitors,
3572                 }).unwrap()
3573         };
3574         nodes_0_deserialized = nodes_0_deserialized_tmp;
3575         assert!(nodes_0_read.is_empty());
3576
3577         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3578         nodes[0].node = &nodes_0_deserialized;
3579         nodes[0].block_notifier.register_listener(nodes[0].node);
3580         assert_eq!(nodes[0].node.list_channels().len(), 1);
3581         check_added_monitors!(nodes[0], 1);
3582
3583         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3584         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3585         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3586         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3587
3588         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3589         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3590         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3591         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3592
3593         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3594         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3595         for node in nodes.iter() {
3596                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3597                 node.router.handle_channel_update(&as_update).unwrap();
3598                 node.router.handle_channel_update(&bs_update).unwrap();
3599         }
3600
3601         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3602 }
3603
3604 #[test]
3605 fn test_simple_manager_serialize_deserialize() {
3606         let node_cfgs = create_node_cfgs(2);
3607         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3608         let new_chan_monitor: test_utils::TestChannelMonitor;
3609         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3610         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3611         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3612
3613         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3614         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3615
3616         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3617
3618         let nodes_0_serialized = nodes[0].node.encode();
3619         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3620         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3621
3622         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }));
3623         nodes[0].chan_monitor = &new_chan_monitor;
3624         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3625         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3626         assert!(chan_0_monitor_read.is_empty());
3627
3628         let mut nodes_0_read = &nodes_0_serialized[..];
3629         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3630         let (_, nodes_0_deserialized_tmp) = {
3631                 let mut channel_monitors = HashMap::new();
3632                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3633                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3634                         default_config: UserConfig::default(),
3635                         keys_manager,
3636                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3637                         monitor: nodes[0].chan_monitor,
3638                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3639                         logger: Arc::new(test_utils::TestLogger::new()),
3640                         channel_monitors: &mut channel_monitors,
3641                 }).unwrap()
3642         };
3643         nodes_0_deserialized = nodes_0_deserialized_tmp;
3644         assert!(nodes_0_read.is_empty());
3645
3646         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3647         nodes[0].node = &nodes_0_deserialized;
3648         check_added_monitors!(nodes[0], 1);
3649
3650         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3651
3652         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3653         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3654 }
3655
3656 #[test]
3657 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3658         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3659         let node_cfgs = create_node_cfgs(4);
3660         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3661         let new_chan_monitor: test_utils::TestChannelMonitor;
3662         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3663         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3664         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3665         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3666         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3667
3668         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3669
3670         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3671         let nodes_0_serialized = nodes[0].node.encode();
3672
3673         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3674         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3675         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3676         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3677
3678         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3679         // nodes[3])
3680         let mut node_0_monitors_serialized = Vec::new();
3681         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3682                 let mut writer = test_utils::TestVecWriter(Vec::new());
3683                 monitor.1.write_for_disk(&mut writer).unwrap();
3684                 node_0_monitors_serialized.push(writer.0);
3685         }
3686
3687         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }));
3688         nodes[0].chan_monitor = &new_chan_monitor;
3689         let mut node_0_monitors = Vec::new();
3690         for serialized in node_0_monitors_serialized.iter() {
3691                 let mut read = &serialized[..];
3692                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3693                 assert!(read.is_empty());
3694                 node_0_monitors.push(monitor);
3695         }
3696
3697         let mut nodes_0_read = &nodes_0_serialized[..];
3698         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3699         let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3700                 default_config: UserConfig::default(),
3701                 keys_manager,
3702                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3703                 monitor: nodes[0].chan_monitor,
3704                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3705                 logger: Arc::new(test_utils::TestLogger::new()),
3706                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3707         }).unwrap();
3708         nodes_0_deserialized = nodes_0_deserialized_tmp;
3709         assert!(nodes_0_read.is_empty());
3710
3711         { // Channel close should result in a commitment tx and an HTLC tx
3712                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3713                 assert_eq!(txn.len(), 2);
3714                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3715                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3716         }
3717
3718         for monitor in node_0_monitors.drain(..) {
3719                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3720                 check_added_monitors!(nodes[0], 1);
3721         }
3722         nodes[0].node = &nodes_0_deserialized;
3723
3724         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3725         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3726         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3727         //... and we can even still claim the payment!
3728         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3729
3730         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3731         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3732         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3733         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3734         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3735         assert_eq!(msg_events.len(), 1);
3736         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3737                 match action {
3738                         &ErrorAction::SendErrorMessage { ref msg } => {
3739                                 assert_eq!(msg.channel_id, channel_id);
3740                         },
3741                         _ => panic!("Unexpected event!"),
3742                 }
3743         }
3744 }
3745
3746 macro_rules! check_spendable_outputs {
3747         ($node: expr, $der_idx: expr) => {
3748                 {
3749                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3750                         let mut txn = Vec::new();
3751                         for event in events {
3752                                 match event {
3753                                         Event::SpendableOutputs { ref outputs } => {
3754                                                 for outp in outputs {
3755                                                         match *outp {
3756                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3757                                                                         let input = TxIn {
3758                                                                                 previous_output: outpoint.clone(),
3759                                                                                 script_sig: Script::new(),
3760                                                                                 sequence: 0,
3761                                                                                 witness: Vec::new(),
3762                                                                         };
3763                                                                         let outp = TxOut {
3764                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3765                                                                                 value: output.value,
3766                                                                         };
3767                                                                         let mut spend_tx = Transaction {
3768                                                                                 version: 2,
3769                                                                                 lock_time: 0,
3770                                                                                 input: vec![input],
3771                                                                                 output: vec![outp],
3772                                                                         };
3773                                                                         let secp_ctx = Secp256k1::new();
3774                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3775                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3776                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3777                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3778                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3779                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3780                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3781                                                                         txn.push(spend_tx);
3782                                                                 },
3783                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3784                                                                         let input = TxIn {
3785                                                                                 previous_output: outpoint.clone(),
3786                                                                                 script_sig: Script::new(),
3787                                                                                 sequence: *to_self_delay as u32,
3788                                                                                 witness: Vec::new(),
3789                                                                         };
3790                                                                         let outp = TxOut {
3791                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3792                                                                                 value: output.value,
3793                                                                         };
3794                                                                         let mut spend_tx = Transaction {
3795                                                                                 version: 2,
3796                                                                                 lock_time: 0,
3797                                                                                 input: vec![input],
3798                                                                                 output: vec![outp],
3799                                                                         };
3800                                                                         let secp_ctx = Secp256k1::new();
3801                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3802                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3803                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3804                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3805                                                                         spend_tx.input[0].witness.push(vec!(0));
3806                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3807                                                                         txn.push(spend_tx);
3808                                                                 },
3809                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3810                                                                         let secp_ctx = Secp256k1::new();
3811                                                                         let input = TxIn {
3812                                                                                 previous_output: outpoint.clone(),
3813                                                                                 script_sig: Script::new(),
3814                                                                                 sequence: 0,
3815                                                                                 witness: Vec::new(),
3816                                                                         };
3817                                                                         let outp = TxOut {
3818                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3819                                                                                 value: output.value,
3820                                                                         };
3821                                                                         let mut spend_tx = Transaction {
3822                                                                                 version: 2,
3823                                                                                 lock_time: 0,
3824                                                                                 input: vec![input],
3825                                                                                 output: vec![outp.clone()],
3826                                                                         };
3827                                                                         let secret = {
3828                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3829                                                                                         Ok(master_key) => {
3830                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3831                                                                                                         Ok(key) => key,
3832                                                                                                         Err(_) => panic!("Your RNG is busted"),
3833                                                                                                 }
3834                                                                                         }
3835                                                                                         Err(_) => panic!("Your rng is busted"),
3836                                                                                 }
3837                                                                         };
3838                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3839                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3840                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3841                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3842                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3843                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3844                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3845                                                                         txn.push(spend_tx);
3846                                                                 },
3847                                                         }
3848                                                 }
3849                                         },
3850                                         _ => panic!("Unexpected event"),
3851                                 };
3852                         }
3853                         txn
3854                 }
3855         }
3856 }
3857
3858 #[test]
3859 fn test_claim_sizeable_push_msat() {
3860         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3861         let node_cfgs = create_node_cfgs(2);
3862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3863         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3864
3865         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3866         nodes[1].node.force_close_channel(&chan.2);
3867         check_closed_broadcast!(nodes[1], false);
3868         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3869         assert_eq!(node_txn.len(), 1);
3870         check_spends!(node_txn[0], chan.3.clone());
3871         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
3872
3873         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3874         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3875         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3876         assert_eq!(spend_txn.len(), 1);
3877         check_spends!(spend_txn[0], node_txn[0].clone());
3878 }
3879
3880 #[test]
3881 fn test_claim_on_remote_sizeable_push_msat() {
3882         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3883         // to_remote output is encumbered by a P2WPKH
3884         let node_cfgs = create_node_cfgs(2);
3885         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3886         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3887
3888         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3889         nodes[0].node.force_close_channel(&chan.2);
3890         check_closed_broadcast!(nodes[0], false);
3891
3892         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3893         assert_eq!(node_txn.len(), 1);
3894         check_spends!(node_txn[0], chan.3.clone());
3895         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
3896
3897         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3898         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3899         check_closed_broadcast!(nodes[1], false);
3900         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3901         assert_eq!(spend_txn.len(), 2);
3902         assert_eq!(spend_txn[0], spend_txn[1]);
3903         check_spends!(spend_txn[0], node_txn[0].clone());
3904 }
3905
3906 #[test]
3907 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3908         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3909         // to_remote output is encumbered by a P2WPKH
3910
3911         let node_cfgs = create_node_cfgs(2);
3912         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3913         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3914
3915         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
3916         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3917         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3918         assert_eq!(revoked_local_txn[0].input.len(), 1);
3919         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3920
3921         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3922         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3923         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3924         check_closed_broadcast!(nodes[1], false);
3925
3926         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3927         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3928         assert_eq!(spend_txn.len(), 4);
3929         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3930         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3931         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3932         check_spends!(spend_txn[1], node_txn[0].clone());
3933 }
3934
3935 #[test]
3936 fn test_static_spendable_outputs_preimage_tx() {
3937         let node_cfgs = create_node_cfgs(2);
3938         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3939         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3940
3941         // Create some initial channels
3942         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3943
3944         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3945
3946         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3947         assert_eq!(commitment_tx[0].input.len(), 1);
3948         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3949
3950         // Settle A's commitment tx on B's chain
3951         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3952         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
3953         check_added_monitors!(nodes[1], 1);
3954         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3955         let events = nodes[1].node.get_and_clear_pending_msg_events();
3956         match events[0] {
3957                 MessageSendEvent::UpdateHTLCs { .. } => {},
3958                 _ => panic!("Unexpected event"),
3959         }
3960         match events[1] {
3961                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3962                 _ => panic!("Unexepected event"),
3963         }
3964
3965         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3966         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: 2 (1 preimage tx)
3967         assert_eq!(node_txn.len(), 4);
3968         check_spends!(node_txn[0], commitment_tx[0].clone());
3969         assert_eq!(node_txn[0], node_txn[3]);
3970         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3971 eprintln!("{:?}", node_txn[1]);
3972         check_spends!(node_txn[1], chan_1.3.clone());
3973         check_spends!(node_txn[2], node_txn[1]);
3974
3975         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3976         assert_eq!(spend_txn.len(), 2);
3977         assert_eq!(spend_txn[0], spend_txn[1]);
3978         check_spends!(spend_txn[0], node_txn[0].clone());
3979 }
3980
3981 #[test]
3982 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3983         let node_cfgs = create_node_cfgs(2);
3984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3985         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3986
3987         // Create some initial channels
3988         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3989
3990         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3991         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
3992         assert_eq!(revoked_local_txn[0].input.len(), 1);
3993         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3994
3995         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3996
3997         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3998         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3999         check_closed_broadcast!(nodes[1], false);
4000
4001         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4002         assert_eq!(node_txn.len(), 3);
4003         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
4004         assert_eq!(node_txn[0].input.len(), 2);
4005         check_spends!(node_txn[0], revoked_local_txn[0].clone());
4006
4007         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4008         assert_eq!(spend_txn.len(), 2);
4009         assert_eq!(spend_txn[0], spend_txn[1]);
4010         check_spends!(spend_txn[0], node_txn[0].clone());
4011 }
4012
4013 #[test]
4014 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4015         let node_cfgs = create_node_cfgs(2);
4016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4017         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4018
4019         // Create some initial channels
4020         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4021
4022         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4023         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4024         assert_eq!(revoked_local_txn[0].input.len(), 1);
4025         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4026
4027         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4028
4029         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4030         // A will generate HTLC-Timeout from revoked commitment tx
4031         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4032         check_closed_broadcast!(nodes[0], false);
4033
4034         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4035         assert_eq!(revoked_htlc_txn.len(), 3);
4036         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4037         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4038         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4039         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4040         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
4041
4042         // B will generate justice tx from A's revoked commitment/HTLC tx
4043         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4044         check_closed_broadcast!(nodes[1], false);
4045
4046         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4047         assert_eq!(node_txn.len(), 5);
4048         assert_eq!(node_txn[3].input.len(), 1);
4049         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4050
4051         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4052         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4053         assert_eq!(spend_txn.len(), 3);
4054         assert_eq!(spend_txn[0], spend_txn[1]);
4055         check_spends!(spend_txn[0], node_txn[0].clone());
4056         check_spends!(spend_txn[2], node_txn[3].clone());
4057 }
4058
4059 #[test]
4060 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4061         let node_cfgs = create_node_cfgs(2);
4062         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4063         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4064
4065         // Create some initial channels
4066         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4067
4068         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4069         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4070         assert_eq!(revoked_local_txn[0].input.len(), 1);
4071         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4072
4073         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4074
4075         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4076         // B will generate HTLC-Success from revoked commitment tx
4077         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4078         check_closed_broadcast!(nodes[1], false);
4079         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4080
4081         assert_eq!(revoked_htlc_txn.len(), 3);
4082         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4083         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4084         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4085         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4086
4087         // A will generate justice tx from B's revoked commitment/HTLC tx
4088         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4089         check_closed_broadcast!(nodes[0], false);
4090
4091         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4092         assert_eq!(node_txn.len(), 4);
4093         assert_eq!(node_txn[3].input.len(), 1);
4094         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4095
4096         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4097         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4098         assert_eq!(spend_txn.len(), 5);
4099         assert_eq!(spend_txn[0], spend_txn[2]);
4100         assert_eq!(spend_txn[1], spend_txn[3]);
4101         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4102         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
4103         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
4104 }
4105
4106 #[test]
4107 fn test_onchain_to_onchain_claim() {
4108         // Test that in case of channel closure, we detect the state of output thanks to
4109         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4110         // First, have C claim an HTLC against its own latest commitment transaction.
4111         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4112         // channel.
4113         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4114         // gets broadcast.
4115
4116         let node_cfgs = create_node_cfgs(3);
4117         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4118         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4119
4120         // Create some initial channels
4121         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4122         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4123
4124         // Rebalance the network a bit by relaying one payment through all the channels ...
4125         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4126         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4127
4128         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4129         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4130         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4131         check_spends!(commitment_tx[0], chan_2.3.clone());
4132         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4133         check_added_monitors!(nodes[2], 1);
4134         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4135         assert!(updates.update_add_htlcs.is_empty());
4136         assert!(updates.update_fail_htlcs.is_empty());
4137         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4138         assert!(updates.update_fail_malformed_htlcs.is_empty());
4139
4140         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4141         check_closed_broadcast!(nodes[2], false);
4142
4143         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4144         assert_eq!(c_txn.len(), 4);
4145         assert_eq!(c_txn[0], c_txn[2]);
4146         assert_eq!(c_txn[0], c_txn[3]);
4147         assert_eq!(commitment_tx[0], c_txn[1]);
4148         check_spends!(c_txn[1], chan_2.3.clone());
4149         check_spends!(c_txn[2], c_txn[1].clone());
4150         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4151         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4152         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4153         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4154
4155         // 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
4156         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4157         {
4158                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4159                 assert_eq!(b_txn.len(), 4);
4160                 assert_eq!(b_txn[0], b_txn[3]);
4161                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4162                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4163                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4164                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4165                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4166                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4167                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4168                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4169                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4170                 b_txn.clear();
4171         }
4172         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4173         check_added_monitors!(nodes[1], 1);
4174         match msg_events[0] {
4175                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4176                 _ => panic!("Unexpected event"),
4177         }
4178         match msg_events[1] {
4179                 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, .. } } => {
4180                         assert!(update_add_htlcs.is_empty());
4181                         assert!(update_fail_htlcs.is_empty());
4182                         assert_eq!(update_fulfill_htlcs.len(), 1);
4183                         assert!(update_fail_malformed_htlcs.is_empty());
4184                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4185                 },
4186                 _ => panic!("Unexpected event"),
4187         };
4188         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4189         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4190         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4191         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4192         assert_eq!(b_txn.len(), 4);
4193         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
4194         check_spends!(b_txn[2], b_txn[1]); // HTLC-Success tx, as a part of the local txn rebroadcast by ChannelManager in the force close
4195         assert_eq!(b_txn[0], b_txn[3]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
4196         check_spends!(b_txn[0], commitment_tx[0].clone());
4197         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4198         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4199         assert_eq!(b_txn[2].lock_time, 0); // Success tx
4200
4201         check_closed_broadcast!(nodes[1], false);
4202 }
4203
4204 #[test]
4205 fn test_duplicate_payment_hash_one_failure_one_success() {
4206         // Topology : A --> B --> C
4207         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4208         let node_cfgs = create_node_cfgs(3);
4209         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4210         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4211
4212         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4213         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4214
4215         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4216         *nodes[0].network_payment_count.borrow_mut() -= 1;
4217         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4218
4219         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4220         assert_eq!(commitment_txn[0].input.len(), 1);
4221         check_spends!(commitment_txn[0], chan_2.3.clone());
4222
4223         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4224         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4225         check_closed_broadcast!(nodes[1], false);
4226
4227         let htlc_timeout_tx;
4228         { // Extract one of the two HTLC-Timeout transaction
4229                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4230                 assert_eq!(node_txn.len(), 7);
4231                 assert_eq!(node_txn[0], node_txn[5]);
4232                 assert_eq!(node_txn[1], node_txn[6]);
4233                 check_spends!(node_txn[0], commitment_txn[0].clone());
4234                 assert_eq!(node_txn[0].input.len(), 1);
4235                 check_spends!(node_txn[1], commitment_txn[0].clone());
4236                 assert_eq!(node_txn[1].input.len(), 1);
4237                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4238                 check_spends!(node_txn[2], chan_2.3.clone());
4239                 check_spends!(node_txn[3], node_txn[2].clone());
4240                 check_spends!(node_txn[4], node_txn[2].clone());
4241                 htlc_timeout_tx = node_txn[1].clone();
4242         }
4243
4244         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4245         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4246         check_added_monitors!(nodes[2], 2);
4247         let events = nodes[2].node.get_and_clear_pending_msg_events();
4248         match events[0] {
4249                 MessageSendEvent::UpdateHTLCs { .. } => {},
4250                 _ => panic!("Unexpected event"),
4251         }
4252         match events[1] {
4253                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4254                 _ => panic!("Unexepected event"),
4255         }
4256         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4257         assert_eq!(htlc_success_txn.len(), 7);
4258         check_spends!(htlc_success_txn[2], chan_2.3.clone());
4259         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4260         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4261         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4262         assert_eq!(htlc_success_txn[0].input.len(), 1);
4263         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4264         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4265         assert_eq!(htlc_success_txn[1].input.len(), 1);
4266         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4267         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4268         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4269         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4270
4271         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4272         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4273         expect_pending_htlcs_forwardable!(nodes[1]);
4274         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4275         assert!(htlc_updates.update_add_htlcs.is_empty());
4276         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4277         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4278         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4279         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4280         check_added_monitors!(nodes[1], 1);
4281
4282         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4283         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4284         {
4285                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4286                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4287                 assert_eq!(events.len(), 1);
4288                 match events[0] {
4289                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4290                         },
4291                         _ => { panic!("Unexpected event"); }
4292                 }
4293         }
4294         let events = nodes[0].node.get_and_clear_pending_events();
4295         match events[0] {
4296                 Event::PaymentFailed { ref payment_hash, .. } => {
4297                         assert_eq!(*payment_hash, duplicate_payment_hash);
4298                 }
4299                 _ => panic!("Unexpected event"),
4300         }
4301
4302         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4303         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4304         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4305         assert!(updates.update_add_htlcs.is_empty());
4306         assert!(updates.update_fail_htlcs.is_empty());
4307         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4308         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4309         assert!(updates.update_fail_malformed_htlcs.is_empty());
4310         check_added_monitors!(nodes[1], 1);
4311
4312         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4313         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4314
4315         let events = nodes[0].node.get_and_clear_pending_events();
4316         match events[0] {
4317                 Event::PaymentSent { ref payment_preimage } => {
4318                         assert_eq!(*payment_preimage, our_payment_preimage);
4319                 }
4320                 _ => panic!("Unexpected event"),
4321         }
4322 }
4323
4324 #[test]
4325 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4326         let node_cfgs = create_node_cfgs(2);
4327         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4328         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4329
4330         // Create some initial channels
4331         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4332
4333         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4334         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4335         assert_eq!(local_txn[0].input.len(), 1);
4336         check_spends!(local_txn[0], chan_1.3.clone());
4337
4338         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4339         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4340         check_added_monitors!(nodes[1], 1);
4341         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4342         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4343         let events = nodes[1].node.get_and_clear_pending_msg_events();
4344         match events[0] {
4345                 MessageSendEvent::UpdateHTLCs { .. } => {},
4346                 _ => panic!("Unexpected event"),
4347         }
4348         match events[1] {
4349                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4350                 _ => panic!("Unexepected event"),
4351         }
4352         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4353         assert_eq!(node_txn[0].input.len(), 1);
4354         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4355         check_spends!(node_txn[0], local_txn[0].clone());
4356
4357         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4358         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4359         assert_eq!(spend_txn.len(), 2);
4360         check_spends!(spend_txn[0], node_txn[0].clone());
4361         check_spends!(spend_txn[1], node_txn[2].clone());
4362 }
4363
4364 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4365         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4366         // unrevoked commitment transaction.
4367         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4368         // a remote RAA before they could be failed backwards (and combinations thereof).
4369         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4370         // use the same payment hashes.
4371         // Thus, we use a six-node network:
4372         //
4373         // A \         / E
4374         //    - C - D -
4375         // B /         \ F
4376         // And test where C fails back to A/B when D announces its latest commitment transaction
4377         let node_cfgs = create_node_cfgs(6);
4378         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4379         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4380
4381         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4382         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4383         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4384         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4385         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4386
4387         // Rebalance and check output sanity...
4388         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4389         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4390         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 2);
4391
4392         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4393         // 0th HTLC:
4394         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
4395         // 1st HTLC:
4396         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
4397         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4398         // 2nd HTLC:
4399         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
4400         // 3rd HTLC:
4401         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
4402         // 4th HTLC:
4403         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4404         // 5th HTLC:
4405         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4406         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4407         // 6th HTLC:
4408         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4409         // 7th HTLC:
4410         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4411
4412         // 8th HTLC:
4413         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4414         // 9th HTLC:
4415         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4416         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
4417
4418         // 10th HTLC:
4419         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
4420         // 11th HTLC:
4421         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4422         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4423
4424         // Double-check that six of the new HTLC were added
4425         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4426         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4427         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn().len(), 1);
4428         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 8);
4429
4430         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4431         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4432         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4433         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4434         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4435         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4436         check_added_monitors!(nodes[4], 0);
4437         expect_pending_htlcs_forwardable!(nodes[4]);
4438         check_added_monitors!(nodes[4], 1);
4439
4440         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4441         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4442         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4443         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4444         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4445         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4446
4447         // Fail 3rd below-dust and 7th above-dust HTLCs
4448         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4449         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4450         check_added_monitors!(nodes[5], 0);
4451         expect_pending_htlcs_forwardable!(nodes[5]);
4452         check_added_monitors!(nodes[5], 1);
4453
4454         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4455         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4456         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4457         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4458
4459         let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4460
4461         expect_pending_htlcs_forwardable!(nodes[3]);
4462         check_added_monitors!(nodes[3], 1);
4463         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4464         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4465         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4466         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4467         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4468         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4469         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4470         if deliver_last_raa {
4471                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4472         } else {
4473                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4474         }
4475
4476         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4477         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4478         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4479         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4480         //
4481         // We now broadcast the latest commitment transaction, which *should* result in failures for
4482         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4483         // the non-broadcast above-dust HTLCs.
4484         //
4485         // Alternatively, we may broadcast the previous commitment transaction, which should only
4486         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4487         let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4488
4489         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4490         if announce_latest {
4491                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4492         } else {
4493                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4494         }
4495         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4496         check_closed_broadcast!(nodes[2], false);
4497         expect_pending_htlcs_forwardable!(nodes[2]);
4498         check_added_monitors!(nodes[2], 2);
4499
4500         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4501         assert_eq!(cs_msgs.len(), 2);
4502         let mut a_done = false;
4503         for msg in cs_msgs {
4504                 match msg {
4505                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4506                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4507                                 // should be failed-backwards here.
4508                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4509                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4510                                         for htlc in &updates.update_fail_htlcs {
4511                                                 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 });
4512                                         }
4513                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4514                                         assert!(!a_done);
4515                                         a_done = true;
4516                                         &nodes[0]
4517                                 } else {
4518                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4519                                         for htlc in &updates.update_fail_htlcs {
4520                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4521                                         }
4522                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4523                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4524                                         &nodes[1]
4525                                 };
4526                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4527                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4528                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4529                                 if announce_latest {
4530                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4531                                         if *node_id == nodes[0].node.get_our_node_id() {
4532                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4533                                         }
4534                                 }
4535                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4536                         },
4537                         _ => panic!("Unexpected event"),
4538                 }
4539         }
4540
4541         let as_events = nodes[0].node.get_and_clear_pending_events();
4542         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4543         let mut as_failds = HashSet::new();
4544         for event in as_events.iter() {
4545                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4546                         assert!(as_failds.insert(*payment_hash));
4547                         if *payment_hash != payment_hash_2 {
4548                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4549                         } else {
4550                                 assert!(!rejected_by_dest);
4551                         }
4552                 } else { panic!("Unexpected event"); }
4553         }
4554         assert!(as_failds.contains(&payment_hash_1));
4555         assert!(as_failds.contains(&payment_hash_2));
4556         if announce_latest {
4557                 assert!(as_failds.contains(&payment_hash_3));
4558                 assert!(as_failds.contains(&payment_hash_5));
4559         }
4560         assert!(as_failds.contains(&payment_hash_6));
4561
4562         let bs_events = nodes[1].node.get_and_clear_pending_events();
4563         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4564         let mut bs_failds = HashSet::new();
4565         for event in bs_events.iter() {
4566                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4567                         assert!(bs_failds.insert(*payment_hash));
4568                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4569                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4570                         } else {
4571                                 assert!(!rejected_by_dest);
4572                         }
4573                 } else { panic!("Unexpected event"); }
4574         }
4575         assert!(bs_failds.contains(&payment_hash_1));
4576         assert!(bs_failds.contains(&payment_hash_2));
4577         if announce_latest {
4578                 assert!(bs_failds.contains(&payment_hash_4));
4579         }
4580         assert!(bs_failds.contains(&payment_hash_5));
4581
4582         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4583         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4584         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4585         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4586         // PaymentFailureNetworkUpdates.
4587         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4588         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4589         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4590         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4591         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4592                 match event {
4593                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4594                         _ => panic!("Unexpected event"),
4595                 }
4596         }
4597 }
4598
4599 #[test]
4600 fn test_fail_backwards_latest_remote_announce_a() {
4601         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4602 }
4603
4604 #[test]
4605 fn test_fail_backwards_latest_remote_announce_b() {
4606         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4607 }
4608
4609 #[test]
4610 fn test_fail_backwards_previous_remote_announce() {
4611         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4612         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4613         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4614 }
4615
4616 #[test]
4617 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4618         let node_cfgs = create_node_cfgs(2);
4619         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4620         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4621
4622         // Create some initial channels
4623         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4624
4625         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4626         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4627         assert_eq!(local_txn[0].input.len(), 1);
4628         check_spends!(local_txn[0], chan_1.3.clone());
4629
4630         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4631         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4632         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4633         check_closed_broadcast!(nodes[0], false);
4634
4635         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4636         assert_eq!(node_txn[0].input.len(), 1);
4637         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4638         check_spends!(node_txn[0], local_txn[0].clone());
4639
4640         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4641         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4642         assert_eq!(spend_txn.len(), 8);
4643         assert_eq!(spend_txn[0], spend_txn[2]);
4644         assert_eq!(spend_txn[0], spend_txn[4]);
4645         assert_eq!(spend_txn[0], spend_txn[6]);
4646         assert_eq!(spend_txn[1], spend_txn[3]);
4647         assert_eq!(spend_txn[1], spend_txn[5]);
4648         assert_eq!(spend_txn[1], spend_txn[7]);
4649         check_spends!(spend_txn[0], local_txn[0].clone());
4650         check_spends!(spend_txn[1], node_txn[0].clone());
4651 }
4652
4653 #[test]
4654 fn test_static_output_closing_tx() {
4655         let node_cfgs = create_node_cfgs(2);
4656         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4657         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4658
4659         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4660
4661         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4662         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4663
4664         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4665         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4666         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4667         assert_eq!(spend_txn.len(), 1);
4668         check_spends!(spend_txn[0], closing_tx.clone());
4669
4670         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4671         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4672         assert_eq!(spend_txn.len(), 1);
4673         check_spends!(spend_txn[0], closing_tx);
4674 }
4675
4676 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4677         let node_cfgs = create_node_cfgs(2);
4678         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4679         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4680         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4681
4682         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4683
4684         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4685         // present in B's local commitment transaction, but none of A's commitment transactions.
4686         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
4687         check_added_monitors!(nodes[1], 1);
4688
4689         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4690         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4691         let events = nodes[0].node.get_and_clear_pending_events();
4692         assert_eq!(events.len(), 1);
4693         match events[0] {
4694                 Event::PaymentSent { payment_preimage } => {
4695                         assert_eq!(payment_preimage, our_payment_preimage);
4696                 },
4697                 _ => panic!("Unexpected event"),
4698         }
4699
4700         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4701         check_added_monitors!(nodes[0], 1);
4702         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4703         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4704         check_added_monitors!(nodes[1], 1);
4705
4706         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4707         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4708                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4709                 header.prev_blockhash = header.bitcoin_hash();
4710         }
4711         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4712         check_closed_broadcast!(nodes[1], false);
4713 }
4714
4715 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4716         let node_cfgs = create_node_cfgs(2);
4717         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4718         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4719         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4720
4721         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV).unwrap();
4722         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4723         nodes[0].node.send_payment(route, payment_hash, None).unwrap();
4724         check_added_monitors!(nodes[0], 1);
4725
4726         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4727
4728         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4729         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4730         // to "time out" the HTLC.
4731
4732         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4733
4734         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4735                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4736                 header.prev_blockhash = header.bitcoin_hash();
4737         }
4738         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4739         check_closed_broadcast!(nodes[0], false);
4740 }
4741
4742 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4743         let node_cfgs = create_node_cfgs(3);
4744         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4745         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4746         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4747
4748         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4749         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4750         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4751         // actually revoked.
4752         let htlc_value = if use_dust { 50000 } else { 3000000 };
4753         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4754         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
4755         expect_pending_htlcs_forwardable!(nodes[1]);
4756         check_added_monitors!(nodes[1], 1);
4757
4758         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4759         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4760         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4761         check_added_monitors!(nodes[0], 1);
4762         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4763         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4764         check_added_monitors!(nodes[1], 1);
4765         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4766         check_added_monitors!(nodes[1], 1);
4767         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4768
4769         if check_revoke_no_close {
4770                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4771                 check_added_monitors!(nodes[0], 1);
4772         }
4773
4774         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4775         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4776                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4777                 header.prev_blockhash = header.bitcoin_hash();
4778         }
4779         if !check_revoke_no_close {
4780                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4781                 check_closed_broadcast!(nodes[0], false);
4782         } else {
4783                 let events = nodes[0].node.get_and_clear_pending_events();
4784                 assert_eq!(events.len(), 1);
4785                 match events[0] {
4786                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4787                                 assert_eq!(payment_hash, our_payment_hash);
4788                                 assert!(rejected_by_dest);
4789                         },
4790                         _ => panic!("Unexpected event"),
4791                 }
4792         }
4793 }
4794
4795 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4796 // There are only a few cases to test here:
4797 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4798 //    broadcastable commitment transactions result in channel closure,
4799 //  * its included in an unrevoked-but-previous remote commitment transaction,
4800 //  * its included in the latest remote or local commitment transactions.
4801 // We test each of the three possible commitment transactions individually and use both dust and
4802 // non-dust HTLCs.
4803 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4804 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4805 // tested for at least one of the cases in other tests.
4806 #[test]
4807 fn htlc_claim_single_commitment_only_a() {
4808         do_htlc_claim_local_commitment_only(true);
4809         do_htlc_claim_local_commitment_only(false);
4810
4811         do_htlc_claim_current_remote_commitment_only(true);
4812         do_htlc_claim_current_remote_commitment_only(false);
4813 }
4814
4815 #[test]
4816 fn htlc_claim_single_commitment_only_b() {
4817         do_htlc_claim_previous_remote_commitment_only(true, false);
4818         do_htlc_claim_previous_remote_commitment_only(false, false);
4819         do_htlc_claim_previous_remote_commitment_only(true, true);
4820         do_htlc_claim_previous_remote_commitment_only(false, true);
4821 }
4822
4823 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>)
4824         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4825                                 F2: FnMut(),
4826 {
4827         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);
4828 }
4829
4830 // test_case
4831 // 0: node1 fails backward
4832 // 1: final node fails backward
4833 // 2: payment completed but the user rejects the payment
4834 // 3: final node fails backward (but tamper onion payloads from node0)
4835 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4836 // 200: trigger error in the final node and tamper returning fail_htlc
4837 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>)
4838         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4839                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4840                                 F3: FnMut(),
4841 {
4842
4843         // reset block height
4844         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4845         for ix in 0..nodes.len() {
4846                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4847         }
4848
4849         macro_rules! expect_event {
4850                 ($node: expr, $event_type: path) => {{
4851                         let events = $node.node.get_and_clear_pending_events();
4852                         assert_eq!(events.len(), 1);
4853                         match events[0] {
4854                                 $event_type { .. } => {},
4855                                 _ => panic!("Unexpected event"),
4856                         }
4857                 }}
4858         }
4859
4860         macro_rules! expect_htlc_forward {
4861                 ($node: expr) => {{
4862                         expect_event!($node, Event::PendingHTLCsForwardable);
4863                         $node.node.process_pending_htlc_forwards();
4864                 }}
4865         }
4866
4867         // 0 ~~> 2 send payment
4868         nodes[0].node.send_payment(route.clone(), payment_hash.clone(), None).unwrap();
4869         check_added_monitors!(nodes[0], 1);
4870         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4871         // temper update_add (0 => 1)
4872         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4873         if test_case == 0 || test_case == 3 || test_case == 100 {
4874                 callback_msg(&mut update_add_0);
4875                 callback_node();
4876         }
4877         // 0 => 1 update_add & CS
4878         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4879         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4880
4881         let update_1_0 = match test_case {
4882                 0|100 => { // intermediate node failure; fail backward to 0
4883                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4884                         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));
4885                         update_1_0
4886                 },
4887                 1|2|3|200 => { // final node failure; forwarding to 2
4888                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4889                         // forwarding on 1
4890                         if test_case != 200 {
4891                                 callback_node();
4892                         }
4893                         expect_htlc_forward!(&nodes[1]);
4894
4895                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4896                         check_added_monitors!(&nodes[1], 1);
4897                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4898                         // tamper update_add (1 => 2)
4899                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4900                         if test_case != 3 && test_case != 200 {
4901                                 callback_msg(&mut update_add_1);
4902                         }
4903
4904                         // 1 => 2
4905                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4906                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4907
4908                         if test_case == 2 || test_case == 200 {
4909                                 expect_htlc_forward!(&nodes[2]);
4910                                 expect_event!(&nodes[2], Event::PaymentReceived);
4911                                 callback_node();
4912                                 expect_pending_htlcs_forwardable!(nodes[2]);
4913                         }
4914
4915                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4916                         if test_case == 2 || test_case == 200 {
4917                                 check_added_monitors!(&nodes[2], 1);
4918                         }
4919                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4920
4921                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4922                         if test_case == 200 {
4923                                 callback_fail(&mut fail_msg);
4924                         }
4925
4926                         // 2 => 1
4927                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4928                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4929
4930                         // backward fail on 1
4931                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4932                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4933                         update_1_0
4934                 },
4935                 _ => unreachable!(),
4936         };
4937
4938         // 1 => 0 commitment_signed_dance
4939         if update_1_0.update_fail_htlcs.len() > 0 {
4940                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4941                 if test_case == 100 {
4942                         callback_fail(&mut fail_msg);
4943                 }
4944                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4945         } else {
4946                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4947         };
4948
4949         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4950
4951         let events = nodes[0].node.get_and_clear_pending_events();
4952         assert_eq!(events.len(), 1);
4953         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4954                 assert_eq!(*rejected_by_dest, !expected_retryable);
4955                 assert_eq!(*error_code, expected_error_code);
4956         } else {
4957                 panic!("Uexpected event");
4958         }
4959
4960         let events = nodes[0].node.get_and_clear_pending_msg_events();
4961         if expected_channel_update.is_some() {
4962                 assert_eq!(events.len(), 1);
4963                 match events[0] {
4964                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4965                                 match update {
4966                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4967                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4968                                                         panic!("channel_update not found!");
4969                                                 }
4970                                         },
4971                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4972                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4973                                                         assert!(*short_channel_id == *expected_short_channel_id);
4974                                                         assert!(*is_permanent == *expected_is_permanent);
4975                                                 } else {
4976                                                         panic!("Unexpected message event");
4977                                                 }
4978                                         },
4979                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4980                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4981                                                         assert!(*node_id == *expected_node_id);
4982                                                         assert!(*is_permanent == *expected_is_permanent);
4983                                                 } else {
4984                                                         panic!("Unexpected message event");
4985                                                 }
4986                                         },
4987                                 }
4988                         },
4989                         _ => panic!("Unexpected message event"),
4990                 }
4991         } else {
4992                 assert_eq!(events.len(), 0);
4993         }
4994 }
4995
4996 impl msgs::ChannelUpdate {
4997         fn dummy() -> msgs::ChannelUpdate {
4998                 use secp256k1::ffi::Signature as FFISignature;
4999                 use secp256k1::Signature;
5000                 msgs::ChannelUpdate {
5001                         signature: Signature::from(FFISignature::new()),
5002                         contents: msgs::UnsignedChannelUpdate {
5003                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5004                                 short_channel_id: 0,
5005                                 timestamp: 0,
5006                                 flags: 0,
5007                                 cltv_expiry_delta: 0,
5008                                 htlc_minimum_msat: 0,
5009                                 fee_base_msat: 0,
5010                                 fee_proportional_millionths: 0,
5011                                 excess_data: vec![],
5012                         }
5013                 }
5014         }
5015 }
5016
5017 struct BogusOnionHopData {
5018         data: Vec<u8>
5019 }
5020 impl BogusOnionHopData {
5021         fn new(orig: msgs::OnionHopData) -> Self {
5022                 Self { data: orig.encode() }
5023         }
5024 }
5025 impl Writeable for BogusOnionHopData {
5026         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5027                 writer.write_all(&self.data[..])
5028         }
5029 }
5030
5031 #[test]
5032 fn test_onion_failure() {
5033         use ln::msgs::ChannelUpdate;
5034         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5035         use secp256k1;
5036
5037         const BADONION: u16 = 0x8000;
5038         const PERM: u16 = 0x4000;
5039         const NODE: u16 = 0x2000;
5040         const UPDATE: u16 = 0x1000;
5041
5042         let node_cfgs = create_node_cfgs(3);
5043         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5044         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5045         for node in nodes.iter() {
5046                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5047         }
5048         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported())];
5049         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5050         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5051         // positve case
5052         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5053
5054         // intermediate node failure
5055         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5056                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5057                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5058                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5059                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, None, cur_height).unwrap();
5060                 let mut new_payloads = Vec::new();
5061                 for payload in onion_payloads.drain(..) {
5062                         new_payloads.push(BogusOnionHopData::new(payload));
5063                 }
5064                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5065                 // describing a length-1 TLV payload, which is obviously bogus.
5066                 new_payloads[0].data[0] = 1;
5067                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5068         }, ||{}, 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
5069
5070         // final node failure
5071         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5072                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5073                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5074                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5075                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, None, cur_height).unwrap();
5076                 let mut new_payloads = Vec::new();
5077                 for payload in onion_payloads.drain(..) {
5078                         new_payloads.push(BogusOnionHopData::new(payload));
5079                 }
5080                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5081                 // length-1 TLV payload, which is obviously bogus.
5082                 new_payloads[1].data[0] = 1;
5083                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5084         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5085
5086         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5087         // receiving simulated fail messages
5088         // intermediate node failure
5089         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5090                 // trigger error
5091                 msg.amount_msat -= 1;
5092         }, |msg| {
5093                 // and tamper returning error message
5094                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5095                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5096                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5097         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5098
5099         // final node failure
5100         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5101                 // and tamper returning error message
5102                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5103                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5104                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5105         }, ||{
5106                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5107         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5108
5109         // intermediate node failure
5110         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5111                 msg.amount_msat -= 1;
5112         }, |msg| {
5113                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5114                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5115                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5116         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5117
5118         // final node failure
5119         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5120                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5121                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5122                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5123         }, ||{
5124                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5125         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5126
5127         // intermediate node failure
5128         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5129                 msg.amount_msat -= 1;
5130         }, |msg| {
5131                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5132                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5133                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5134         }, ||{
5135                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5136         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5137
5138         // final node failure
5139         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5140                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5141                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5142                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5143         }, ||{
5144                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5145         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5146
5147         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5148                 Some(BADONION|PERM|4), None);
5149
5150         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5151                 Some(BADONION|PERM|5), None);
5152
5153         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5154                 Some(BADONION|PERM|6), None);
5155
5156         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5157                 msg.amount_msat -= 1;
5158         }, |msg| {
5159                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5160                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5161                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5162         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5163
5164         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5165                 msg.amount_msat -= 1;
5166         }, |msg| {
5167                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5168                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5169                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5170                 // short_channel_id from the processing node
5171         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5172
5173         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5174                 msg.amount_msat -= 1;
5175         }, |msg| {
5176                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5177                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5178                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5179                 // short_channel_id from the processing node
5180         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5181
5182         let mut bogus_route = route.clone();
5183         bogus_route.paths[0][1].short_channel_id -= 1;
5184         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5185           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5186
5187         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5188         let mut bogus_route = route.clone();
5189         let route_len = bogus_route.paths[0].len();
5190         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5191         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5192
5193         //TODO: with new config API, we will be able to generate both valid and
5194         //invalid channel_update cases.
5195         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5196                 msg.amount_msat -= 1;
5197         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5198
5199         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5200                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5201                 msg.cltv_expiry -= 1;
5202         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5203
5204         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5205                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5206                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5207
5208                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5209         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5210
5211         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5212                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5213         }, false, Some(PERM|15), None);
5214
5215         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5216                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5217                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5218
5219                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5220         }, || {}, true, Some(17), None);
5221
5222         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5223                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5224                         for f in pending_forwards.iter_mut() {
5225                                 match f {
5226                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5227                                                 forward_info.outgoing_cltv_value += 1,
5228                                         _ => {},
5229                                 }
5230                         }
5231                 }
5232         }, true, Some(18), None);
5233
5234         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5235                 // violate amt_to_forward > msg.amount_msat
5236                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5237                         for f in pending_forwards.iter_mut() {
5238                                 match f {
5239                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5240                                                 forward_info.amt_to_forward -= 1,
5241                                         _ => {},
5242                                 }
5243                         }
5244                 }
5245         }, true, Some(19), None);
5246
5247         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5248                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5249                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5250                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5251         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5252         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5253
5254         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5255                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5256                 let mut route = route.clone();
5257                 let height = 1;
5258                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5259                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5260                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, None, height).unwrap();
5261                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5262                 msg.cltv_expiry = htlc_cltv;
5263                 msg.onion_routing_packet = onion_packet;
5264         }, ||{}, true, Some(21), None);
5265 }
5266
5267 #[test]
5268 #[should_panic]
5269 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5270         let node_cfgs = create_node_cfgs(2);
5271         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5272         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5273         //Force duplicate channel ids
5274         for node in nodes.iter() {
5275                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5276         }
5277
5278         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5279         let channel_value_satoshis=10000;
5280         let push_msat=10001;
5281         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5282         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5283         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5284
5285         //Create a second channel with a channel_id collision
5286         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5287 }
5288
5289 #[test]
5290 fn bolt2_open_channel_sending_node_checks_part2() {
5291         let node_cfgs = create_node_cfgs(2);
5292         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5293         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5294
5295         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5296         let channel_value_satoshis=2^24;
5297         let push_msat=10001;
5298         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5299
5300         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5301         let channel_value_satoshis=10000;
5302         // Test when push_msat is equal to 1000 * funding_satoshis.
5303         let push_msat=1000*channel_value_satoshis+1;
5304         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5305
5306         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5307         let channel_value_satoshis=10000;
5308         let push_msat=10001;
5309         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_ok()); //Create a valid channel
5310         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5311         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5312
5313         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5314         // 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
5315         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5316
5317         // 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.
5318         assert!(BREAKDOWN_TIMEOUT>0);
5319         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5320
5321         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5322         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5323         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5324
5325         // 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.
5326         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5327         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5328         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5329         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5330         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5331 }
5332
5333 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5334 // 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.
5335 //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.
5336
5337 #[test]
5338 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5339         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5340         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5341         let node_cfgs = create_node_cfgs(2);
5342         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5343         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5344         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5345         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5346         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5347
5348         route.paths[0][0].fee_msat = 0;
5349
5350         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
5351                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5352         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5353         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5354 }
5355
5356 #[test]
5357 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5358         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5359         //It is enforced when constructing a route.
5360         let node_cfgs = create_node_cfgs(2);
5361         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5362         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5363         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5364         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5365         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5366
5367         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::RouteError { err },
5368                 assert_eq!(err, "Channel CLTV overflowed?!"));
5369 }
5370
5371 #[test]
5372 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5373         //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.
5374         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5375         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5376         let node_cfgs = create_node_cfgs(2);
5377         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5378         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5379         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5380         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5381
5382         for i in 0..max_accepted_htlcs {
5383                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5384                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5385                 let payment_event = {
5386                         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5387                         check_added_monitors!(nodes[0], 1);
5388
5389                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5390                         assert_eq!(events.len(), 1);
5391                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5392                                 assert_eq!(htlcs[0].htlc_id, i);
5393                         } else {
5394                                 assert!(false);
5395                         }
5396                         SendEvent::from_event(events.remove(0))
5397                 };
5398                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5399                 check_added_monitors!(nodes[1], 0);
5400                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5401
5402                 expect_pending_htlcs_forwardable!(nodes[1]);
5403                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5404         }
5405         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5406         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5407         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
5408                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5409
5410         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5411         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5412 }
5413
5414 #[test]
5415 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5416         //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.
5417         let node_cfgs = create_node_cfgs(2);
5418         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5419         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5420         let channel_value = 100000;
5421         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5422         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5423
5424         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5425
5426         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5427         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5428         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
5429                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5430
5431         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5432         nodes[0].logger.assert_log("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);
5433
5434         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5435 }
5436
5437 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5438 #[test]
5439 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5440         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5441         let node_cfgs = create_node_cfgs(2);
5442         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5443         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5444         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5445         let htlc_minimum_msat: u64;
5446         {
5447                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5448                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5449                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5450         }
5451         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5452         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5453         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5454         check_added_monitors!(nodes[0], 1);
5455         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5456         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5457         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5458         assert!(nodes[1].node.list_channels().is_empty());
5459         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5460         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5461 }
5462
5463 #[test]
5464 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5465         //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
5466         let node_cfgs = create_node_cfgs(2);
5467         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5468         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5469         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5470
5471         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5472
5473         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5474         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5475         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5476         check_added_monitors!(nodes[0], 1);
5477         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5478
5479         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5480         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5481
5482         assert!(nodes[1].node.list_channels().is_empty());
5483         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5484         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5485 }
5486
5487 #[test]
5488 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5489         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5490         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5491         let node_cfgs = create_node_cfgs(2);
5492         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5493         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5494         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5495         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5496         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5497
5498         let session_priv = SecretKey::from_slice(&{
5499                 let mut session_key = [0; 32];
5500                 let mut rng = thread_rng();
5501                 rng.fill_bytes(&mut session_key);
5502                 session_key
5503         }).expect("RNG is bad!");
5504
5505         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5506         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5507         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, None, cur_height).unwrap();
5508         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5509
5510         let mut msg = msgs::UpdateAddHTLC {
5511                 channel_id: chan.2,
5512                 htlc_id: 0,
5513                 amount_msat: 1000,
5514                 payment_hash: our_payment_hash,
5515                 cltv_expiry: htlc_cltv,
5516                 onion_routing_packet: onion_packet.clone(),
5517         };
5518
5519         for i in 0..super::channel::OUR_MAX_HTLCS {
5520                 msg.htlc_id = i as u64;
5521                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5522         }
5523         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5524         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5525
5526         assert!(nodes[1].node.list_channels().is_empty());
5527         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5528         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5529 }
5530
5531 #[test]
5532 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5533         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5534         let node_cfgs = create_node_cfgs(2);
5535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5537         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5538         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5539         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5540         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5541         check_added_monitors!(nodes[0], 1);
5542         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5543         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5544         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5545
5546         assert!(nodes[1].node.list_channels().is_empty());
5547         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5548         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5549 }
5550
5551 #[test]
5552 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5553         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5554         let node_cfgs = create_node_cfgs(2);
5555         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5556         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5557         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5558         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5559         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5560         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5561         check_added_monitors!(nodes[0], 1);
5562         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5563         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5564         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5565
5566         assert!(nodes[1].node.list_channels().is_empty());
5567         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5568         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5569 }
5570
5571 #[test]
5572 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5573         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5574         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5575         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5576         let node_cfgs = create_node_cfgs(2);
5577         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5578         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5579         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5580         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5581         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5582         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5583         check_added_monitors!(nodes[0], 1);
5584         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5585         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5586
5587         //Disconnect and Reconnect
5588         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5589         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5590         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5591         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5592         assert_eq!(reestablish_1.len(), 1);
5593         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5594         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5595         assert_eq!(reestablish_2.len(), 1);
5596         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5597         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5598         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5599         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5600
5601         //Resend HTLC
5602         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5603         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5604         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5605         check_added_monitors!(nodes[1], 1);
5606         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5607
5608         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5609
5610         assert!(nodes[1].node.list_channels().is_empty());
5611         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5612         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5613 }
5614
5615 #[test]
5616 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5617         //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.
5618
5619         let node_cfgs = create_node_cfgs(2);
5620         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5621         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5622         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5623
5624         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5625         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5626         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5627         check_added_monitors!(nodes[0], 1);
5628         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5629         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5630
5631         let update_msg = msgs::UpdateFulfillHTLC{
5632                 channel_id: chan.2,
5633                 htlc_id: 0,
5634                 payment_preimage: our_payment_preimage,
5635         };
5636
5637         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5638
5639         assert!(nodes[0].node.list_channels().is_empty());
5640         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5641         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5642 }
5643
5644 #[test]
5645 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5646         //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.
5647
5648         let node_cfgs = create_node_cfgs(2);
5649         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5650         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5651         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5652
5653         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5654         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5655         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5656         check_added_monitors!(nodes[0], 1);
5657         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5658         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5659
5660         let update_msg = msgs::UpdateFailHTLC{
5661                 channel_id: chan.2,
5662                 htlc_id: 0,
5663                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5664         };
5665
5666         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5667
5668         assert!(nodes[0].node.list_channels().is_empty());
5669         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5670         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5671 }
5672
5673 #[test]
5674 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5675         //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.
5676
5677         let node_cfgs = create_node_cfgs(2);
5678         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5679         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5680         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5681
5682         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5683         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5684         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5685         check_added_monitors!(nodes[0], 1);
5686         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5687         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5688
5689         let update_msg = msgs::UpdateFailMalformedHTLC{
5690                 channel_id: chan.2,
5691                 htlc_id: 0,
5692                 sha256_of_onion: [1; 32],
5693                 failure_code: 0x8000,
5694         };
5695
5696         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5697
5698         assert!(nodes[0].node.list_channels().is_empty());
5699         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5700         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5701 }
5702
5703 #[test]
5704 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5705         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5706
5707         let node_cfgs = create_node_cfgs(2);
5708         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5709         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5710         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5711
5712         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5713
5714         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
5715         check_added_monitors!(nodes[1], 1);
5716
5717         let events = nodes[1].node.get_and_clear_pending_msg_events();
5718         assert_eq!(events.len(), 1);
5719         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5720                 match events[0] {
5721                         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, .. } } => {
5722                                 assert!(update_add_htlcs.is_empty());
5723                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5724                                 assert!(update_fail_htlcs.is_empty());
5725                                 assert!(update_fail_malformed_htlcs.is_empty());
5726                                 assert!(update_fee.is_none());
5727                                 update_fulfill_htlcs[0].clone()
5728                         },
5729                         _ => panic!("Unexpected event"),
5730                 }
5731         };
5732
5733         update_fulfill_msg.htlc_id = 1;
5734
5735         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5736
5737         assert!(nodes[0].node.list_channels().is_empty());
5738         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5739         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5740 }
5741
5742 #[test]
5743 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5744         //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.
5745
5746         let node_cfgs = create_node_cfgs(2);
5747         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5748         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5749         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5750
5751         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5752
5753         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
5754         check_added_monitors!(nodes[1], 1);
5755
5756         let events = nodes[1].node.get_and_clear_pending_msg_events();
5757         assert_eq!(events.len(), 1);
5758         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5759                 match events[0] {
5760                         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, .. } } => {
5761                                 assert!(update_add_htlcs.is_empty());
5762                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5763                                 assert!(update_fail_htlcs.is_empty());
5764                                 assert!(update_fail_malformed_htlcs.is_empty());
5765                                 assert!(update_fee.is_none());
5766                                 update_fulfill_htlcs[0].clone()
5767                         },
5768                         _ => panic!("Unexpected event"),
5769                 }
5770         };
5771
5772         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5773
5774         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5775
5776         assert!(nodes[0].node.list_channels().is_empty());
5777         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5778         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5779 }
5780
5781
5782 #[test]
5783 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5784         //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.
5785
5786         let node_cfgs = create_node_cfgs(2);
5787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5788         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5789         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5790         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5791         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5792         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5793         check_added_monitors!(nodes[0], 1);
5794
5795         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5796         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5797
5798         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5799         check_added_monitors!(nodes[1], 0);
5800         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5801
5802         let events = nodes[1].node.get_and_clear_pending_msg_events();
5803
5804         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5805                 match events[0] {
5806                         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, .. } } => {
5807                                 assert!(update_add_htlcs.is_empty());
5808                                 assert!(update_fulfill_htlcs.is_empty());
5809                                 assert!(update_fail_htlcs.is_empty());
5810                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5811                                 assert!(update_fee.is_none());
5812                                 update_fail_malformed_htlcs[0].clone()
5813                         },
5814                         _ => panic!("Unexpected event"),
5815                 }
5816         };
5817         update_msg.failure_code &= !0x8000;
5818         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5819
5820         assert!(nodes[0].node.list_channels().is_empty());
5821         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5822         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5823 }
5824
5825 #[test]
5826 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5827         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5828         //    * 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.
5829
5830         let node_cfgs = create_node_cfgs(3);
5831         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5832         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5833         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5834         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5835
5836         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5837         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5838
5839         //First hop
5840         let mut payment_event = {
5841                 nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5842                 check_added_monitors!(nodes[0], 1);
5843                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5844                 assert_eq!(events.len(), 1);
5845                 SendEvent::from_event(events.remove(0))
5846         };
5847         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5848         check_added_monitors!(nodes[1], 0);
5849         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5850         expect_pending_htlcs_forwardable!(nodes[1]);
5851         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5852         assert_eq!(events_2.len(), 1);
5853         check_added_monitors!(nodes[1], 1);
5854         payment_event = SendEvent::from_event(events_2.remove(0));
5855         assert_eq!(payment_event.msgs.len(), 1);
5856
5857         //Second Hop
5858         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5859         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5860         check_added_monitors!(nodes[2], 0);
5861         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5862
5863         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5864         assert_eq!(events_3.len(), 1);
5865         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5866                 match events_3[0] {
5867                         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 } } => {
5868                                 assert!(update_add_htlcs.is_empty());
5869                                 assert!(update_fulfill_htlcs.is_empty());
5870                                 assert!(update_fail_htlcs.is_empty());
5871                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5872                                 assert!(update_fee.is_none());
5873                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5874                         },
5875                         _ => panic!("Unexpected event"),
5876                 }
5877         };
5878
5879         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5880
5881         check_added_monitors!(nodes[1], 0);
5882         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5883         expect_pending_htlcs_forwardable!(nodes[1]);
5884         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5885         assert_eq!(events_4.len(), 1);
5886
5887         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5888         match events_4[0] {
5889                 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, .. } } => {
5890                         assert!(update_add_htlcs.is_empty());
5891                         assert!(update_fulfill_htlcs.is_empty());
5892                         assert_eq!(update_fail_htlcs.len(), 1);
5893                         assert!(update_fail_malformed_htlcs.is_empty());
5894                         assert!(update_fee.is_none());
5895                 },
5896                 _ => panic!("Unexpected event"),
5897         };
5898
5899         check_added_monitors!(nodes[1], 1);
5900 }
5901
5902 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5903         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5904         // 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
5905         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5906
5907         let node_cfgs = create_node_cfgs(2);
5908         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5909         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5910         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5911
5912         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5913
5914         // We route 2 dust-HTLCs between A and B
5915         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5916         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5917         route_payment(&nodes[0], &[&nodes[1]], 1000000);
5918
5919         // Cache one local commitment tx as previous
5920         let as_prev_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5921
5922         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5923         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
5924         check_added_monitors!(nodes[1], 0);
5925         expect_pending_htlcs_forwardable!(nodes[1]);
5926         check_added_monitors!(nodes[1], 1);
5927
5928         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5929         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5930         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5931         check_added_monitors!(nodes[0], 1);
5932
5933         // Cache one local commitment tx as lastest
5934         let as_last_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5935
5936         let events = nodes[0].node.get_and_clear_pending_msg_events();
5937         match events[0] {
5938                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5939                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5940                 },
5941                 _ => panic!("Unexpected event"),
5942         }
5943         match events[1] {
5944                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5945                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5946                 },
5947                 _ => panic!("Unexpected event"),
5948         }
5949
5950         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5951         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5952         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5953
5954         if announce_latest {
5955                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5956         } else {
5957                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5958         }
5959
5960         let events = nodes[0].node.get_and_clear_pending_msg_events();
5961         assert_eq!(events.len(), 1);
5962         match events[0] {
5963                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5964                 _ => panic!("Unexpected event"),
5965         }
5966
5967         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5968         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5969         let events = nodes[0].node.get_and_clear_pending_events();
5970         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5971         assert_eq!(events.len(), 2);
5972         let mut first_failed = false;
5973         for event in events {
5974                 match event {
5975                         Event::PaymentFailed { payment_hash, .. } => {
5976                                 if payment_hash == payment_hash_1 {
5977                                         assert!(!first_failed);
5978                                         first_failed = true;
5979                                 } else {
5980                                         assert_eq!(payment_hash, payment_hash_2);
5981                                 }
5982                         }
5983                         _ => panic!("Unexpected event"),
5984                 }
5985         }
5986 }
5987
5988 #[test]
5989 fn test_failure_delay_dust_htlc_local_commitment() {
5990         do_test_failure_delay_dust_htlc_local_commitment(true);
5991         do_test_failure_delay_dust_htlc_local_commitment(false);
5992 }
5993
5994 #[test]
5995 fn test_no_failure_dust_htlc_local_commitment() {
5996         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5997         // prone to error, we test here that a dummy transaction don't fail them.
5998
5999         let node_cfgs = create_node_cfgs(2);
6000         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6001         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6002         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6003
6004         // Rebalance a bit
6005         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6006
6007         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6008         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6009
6010         // We route 2 dust-HTLCs between A and B
6011         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6012         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6013
6014         // Build a dummy invalid transaction trying to spend a commitment tx
6015         let input = TxIn {
6016                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6017                 script_sig: Script::new(),
6018                 sequence: 0,
6019                 witness: Vec::new(),
6020         };
6021
6022         let outp = TxOut {
6023                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6024                 value: 10000,
6025         };
6026
6027         let dummy_tx = Transaction {
6028                 version: 2,
6029                 lock_time: 0,
6030                 input: vec![input],
6031                 output: vec![outp]
6032         };
6033
6034         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6035         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6036         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6037         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6038         // We broadcast a few more block to check everything is all right
6039         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6040         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6041         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6042
6043         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6044         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6045 }
6046
6047 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6048         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6049         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6050         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6051         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6052         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6053         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6054
6055         let node_cfgs = create_node_cfgs(3);
6056         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6057         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6058         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6059
6060         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6061
6062         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6063         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6064
6065         let as_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6066         let bs_commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6067
6068         // We revoked bs_commitment_tx
6069         if revoked {
6070                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6071                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6072         }
6073
6074         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6075         let mut timeout_tx = Vec::new();
6076         if local {
6077                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6078                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6079                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6080                 assert_eq!(events.len(), 1);
6081                 match events[0] {
6082                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6083                         _ => panic!("Unexpected event"),
6084                 }
6085                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6086                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6087                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6088                 let events = nodes[0].node.get_and_clear_pending_events();
6089                 assert_eq!(events.len(), 1);
6090                 match events[0] {
6091                         Event::PaymentFailed { payment_hash, .. } => {
6092                                 assert_eq!(payment_hash, dust_hash);
6093                         },
6094                         _ => panic!("Unexpected event"),
6095                 }
6096                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6097                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6098                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6099                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6100                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6101                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6102                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6103                 let events = nodes[0].node.get_and_clear_pending_events();
6104                 assert_eq!(events.len(), 1);
6105                 match events[0] {
6106                         Event::PaymentFailed { payment_hash, .. } => {
6107                                 assert_eq!(payment_hash, non_dust_hash);
6108                         },
6109                         _ => panic!("Unexpected event"),
6110                 }
6111         } else {
6112                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6113                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6114                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6115                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6116                 assert_eq!(events.len(), 1);
6117                 match events[0] {
6118                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6119                         _ => panic!("Unexpected event"),
6120                 }
6121                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6122                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6123                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6124                 if !revoked {
6125                         let events = nodes[0].node.get_and_clear_pending_events();
6126                         assert_eq!(events.len(), 1);
6127                         match events[0] {
6128                                 Event::PaymentFailed { payment_hash, .. } => {
6129                                         assert_eq!(payment_hash, dust_hash);
6130                                 },
6131                                 _ => panic!("Unexpected event"),
6132                         }
6133                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6134                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6135                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6136                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6137                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6138                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6139                         let events = nodes[0].node.get_and_clear_pending_events();
6140                         assert_eq!(events.len(), 1);
6141                         match events[0] {
6142                                 Event::PaymentFailed { payment_hash, .. } => {
6143                                         assert_eq!(payment_hash, non_dust_hash);
6144                                 },
6145                                 _ => panic!("Unexpected event"),
6146                         }
6147                 } else {
6148                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6149                         // commitment tx
6150                         let events = nodes[0].node.get_and_clear_pending_events();
6151                         assert_eq!(events.len(), 2);
6152                         let first;
6153                         match events[0] {
6154                                 Event::PaymentFailed { payment_hash, .. } => {
6155                                         if payment_hash == dust_hash { first = true; }
6156                                         else { first = false; }
6157                                 },
6158                                 _ => panic!("Unexpected event"),
6159                         }
6160                         match events[1] {
6161                                 Event::PaymentFailed { payment_hash, .. } => {
6162                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6163                                         else { assert_eq!(payment_hash, dust_hash); }
6164                                 },
6165                                 _ => panic!("Unexpected event"),
6166                         }
6167                 }
6168         }
6169 }
6170
6171 #[test]
6172 fn test_sweep_outbound_htlc_failure_update() {
6173         do_test_sweep_outbound_htlc_failure_update(false, true);
6174         do_test_sweep_outbound_htlc_failure_update(false, false);
6175         do_test_sweep_outbound_htlc_failure_update(true, false);
6176 }
6177
6178 #[test]
6179 fn test_upfront_shutdown_script() {
6180         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6181         // enforce it at shutdown message
6182
6183         let mut config = UserConfig::default();
6184         config.channel_options.announced_channel = true;
6185         config.peer_channel_config_limits.force_announced_channel_preference = false;
6186         config.channel_options.commit_upfront_shutdown_pubkey = false;
6187         let user_cfgs = [None, Some(config), None];
6188         let node_cfgs = create_node_cfgs(3);
6189         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6190         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6191
6192         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6193         let flags = InitFeatures::supported();
6194         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6195         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6196         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6197         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6198         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6199         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6200         let events = nodes[2].node.get_and_clear_pending_msg_events();
6201         assert_eq!(events.len(), 2);
6202         match events[0] {
6203                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6204                 _ => panic!("Unexpected event"),
6205         }
6206         if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6207                 match action {
6208                         &ErrorAction::SendErrorMessage { ref msg } => {
6209                                 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6210                         },
6211                         _ => { assert!(false); }
6212                 }
6213         } else { assert!(false); }
6214
6215         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6216         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6217         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6218         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6219         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6220         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6221         let events = nodes[2].node.get_and_clear_pending_msg_events();
6222         assert_eq!(events.len(), 1);
6223         match events[0] {
6224                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6225                 _ => panic!("Unexpected event"),
6226         }
6227
6228         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6229         let mut flags_no = InitFeatures::supported();
6230         flags_no.unset_upfront_shutdown_script();
6231         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6232         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6233         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6234         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6235         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6236         let events = nodes[1].node.get_and_clear_pending_msg_events();
6237         assert_eq!(events.len(), 1);
6238         match events[0] {
6239                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6240                 _ => panic!("Unexpected event"),
6241         }
6242
6243         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6244         // channel smoothly, opt-out is from channel initiator here
6245         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6246         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6247         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6248         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6249         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6250         let events = nodes[0].node.get_and_clear_pending_msg_events();
6251         assert_eq!(events.len(), 1);
6252         match events[0] {
6253                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6254                 _ => panic!("Unexpected event"),
6255         }
6256
6257         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6258         //// channel smoothly
6259         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6260         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6261         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6262         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6263         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6264         let events = nodes[0].node.get_and_clear_pending_msg_events();
6265         assert_eq!(events.len(), 2);
6266         match events[0] {
6267                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6268                 _ => panic!("Unexpected event"),
6269         }
6270         match events[1] {
6271                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6272                 _ => panic!("Unexpected event"),
6273         }
6274 }
6275
6276 #[test]
6277 fn test_user_configurable_csv_delay() {
6278         // We test our channel constructors yield errors when we pass them absurd csv delay
6279
6280         let mut low_our_to_self_config = UserConfig::default();
6281         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6282         let mut high_their_to_self_config = UserConfig::default();
6283         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6284         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6285         let node_cfgs = create_node_cfgs(2);
6286         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6287         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6288
6289         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6290         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6291         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, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6292                 match error {
6293                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6294                         _ => panic!("Unexpected event"),
6295                 }
6296         } else { assert!(false) }
6297
6298         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6299         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6300         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6301         open_channel.to_self_delay = 200;
6302         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::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6303                 match error {
6304                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6305                         _ => panic!("Unexpected event"),
6306                 }
6307         } else { assert!(false); }
6308
6309         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6310         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6311         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6312         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6313         accept_channel.to_self_delay = 200;
6314         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6315         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6316                 match action {
6317                         &ErrorAction::SendErrorMessage { ref msg } => {
6318                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6319                         },
6320                         _ => { assert!(false); }
6321                 }
6322         } else { assert!(false); }
6323
6324         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6325         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6326         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6327         open_channel.to_self_delay = 200;
6328         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::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6329                 match error {
6330                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6331                         _ => panic!("Unexpected event"),
6332                 }
6333         } else { assert!(false); }
6334 }
6335
6336 #[test]
6337 fn test_data_loss_protect() {
6338         // We want to be sure that :
6339         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6340         // * we close channel in case of detecting other being fallen behind
6341         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6342         let monitor;
6343         let node_state_0;
6344         let node_cfgs = create_node_cfgs(2);
6345         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6346         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6347
6348         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6349
6350         // Cache node A state before any channel update
6351         let previous_node_state = nodes[0].node.encode();
6352         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6353         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6354
6355         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6356         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6357
6358         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6359         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6360
6361         // Restore node A from previous state
6362         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6363         let mut chan_monitor = <(Sha256dHash, ChannelMonitor)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6364         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6365         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6366         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6367         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone());
6368         node_state_0 = {
6369                 let mut channel_monitors = HashMap::new();
6370                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6371                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6372                         keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6373                         fee_estimator: feeest.clone(),
6374                         monitor: &monitor,
6375                         logger: Arc::clone(&logger),
6376                         tx_broadcaster,
6377                         default_config: UserConfig::default(),
6378                         channel_monitors: &mut channel_monitors,
6379                 }).unwrap().1
6380         };
6381         nodes[0].node = &node_state_0;
6382         assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6383         nodes[0].chan_monitor = &monitor;
6384         nodes[0].chain_monitor = chain_monitor;
6385
6386         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6387         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6388         nodes[0].block_notifier.register_listener(nodes[0].node);
6389
6390         check_added_monitors!(nodes[0], 1);
6391
6392         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6393         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6394
6395         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6396
6397         // Check we update monitor following learning of per_commitment_point from B
6398         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6399         check_added_monitors!(nodes[0], 1);
6400
6401         {
6402                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6403                 assert_eq!(node_txn.len(), 0);
6404         }
6405
6406         let mut reestablish_1 = Vec::with_capacity(1);
6407         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6408                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6409                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6410                         reestablish_1.push(msg.clone());
6411                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6412                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6413                         match action {
6414                                 &ErrorAction::SendErrorMessage { ref msg } => {
6415                                         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");
6416                                 },
6417                                 _ => panic!("Unexpected event!"),
6418                         }
6419                 } else {
6420                         panic!("Unexpected event")
6421                 }
6422         }
6423
6424         // Check we close channel detecting A is fallen-behind
6425         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6426         let events = nodes[1].node.get_and_clear_pending_msg_events();
6427         assert_eq!(events.len(), 2);
6428         match events[0] {
6429                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6430                 _ => panic!("Unexpected event"),
6431         }
6432         match events [1] {
6433                 MessageSendEvent::HandleError { ref action, .. } => {
6434                         match action {
6435                                 &ErrorAction::SendErrorMessage { ref msg } => {
6436                                         assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6437                                 _ => panic!("Unexpected event!"),
6438                         }
6439                 },
6440                 _ => panic!("Unexpected event"),
6441         }
6442
6443         // Check A is able to claim to_remote output
6444         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6445         assert_eq!(node_txn.len(), 1);
6446         check_spends!(node_txn[0], chan.3.clone());
6447         assert_eq!(node_txn[0].output.len(), 2);
6448         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6449         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6450         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6451         assert_eq!(spend_txn.len(), 1);
6452         check_spends!(spend_txn[0], node_txn[0].clone());
6453 }
6454
6455 #[test]
6456 fn test_check_htlc_underpaying() {
6457         // Send payment through A -> B but A is maliciously
6458         // sending a probe payment (i.e less than expected value0
6459         // to B, B should refuse payment.
6460
6461         let node_cfgs = create_node_cfgs(2);
6462         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6463         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6464
6465         // Create some initial channels
6466         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6467
6468         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6469
6470         // Node 3 is expecting payment of 100_000 but receive 10_000,
6471         // fail htlc like we didn't know the preimage.
6472         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6473         nodes[1].node.process_pending_htlc_forwards();
6474
6475         let events = nodes[1].node.get_and_clear_pending_msg_events();
6476         assert_eq!(events.len(), 1);
6477         let (update_fail_htlc, commitment_signed) = match events[0] {
6478                 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 } } => {
6479                         assert!(update_add_htlcs.is_empty());
6480                         assert!(update_fulfill_htlcs.is_empty());
6481                         assert_eq!(update_fail_htlcs.len(), 1);
6482                         assert!(update_fail_malformed_htlcs.is_empty());
6483                         assert!(update_fee.is_none());
6484                         (update_fail_htlcs[0].clone(), commitment_signed)
6485                 },
6486                 _ => panic!("Unexpected event"),
6487         };
6488         check_added_monitors!(nodes[1], 1);
6489
6490         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6491         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6492
6493         let events = nodes[0].node.get_and_clear_pending_events();
6494         assert_eq!(events.len(), 1);
6495         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6496                 assert_eq!(*rejected_by_dest, true);
6497                 assert_eq!(error_code.unwrap(), 0x4000|15);
6498         } else {
6499                 panic!("Unexpected event");
6500         }
6501         nodes[1].node.get_and_clear_pending_events();
6502 }
6503
6504 #[test]
6505 fn test_announce_disable_channels() {
6506         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6507         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6508
6509         let node_cfgs = create_node_cfgs(2);
6510         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6511         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6512
6513         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6514         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6515         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6516
6517         // Disconnect peers
6518         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6519         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6520
6521         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6522         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6523         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6524         assert_eq!(msg_events.len(), 3);
6525         for e in msg_events {
6526                 match e {
6527                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6528                                 let short_id = msg.contents.short_channel_id;
6529                                 // Check generated channel_update match list in PendingChannelUpdate
6530                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6531                                         panic!("Generated ChannelUpdate for wrong chan!");
6532                                 }
6533                         },
6534                         _ => panic!("Unexpected event"),
6535                 }
6536         }
6537         // Reconnect peers
6538         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6539         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6540         assert_eq!(reestablish_1.len(), 3);
6541         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6542         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6543         assert_eq!(reestablish_2.len(), 3);
6544
6545         // Reestablish chan_1
6546         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6547         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6548         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6549         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6550         // Reestablish chan_2
6551         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6552         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6553         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6554         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6555         // Reestablish chan_3
6556         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6557         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6558         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6559         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6560
6561         nodes[0].node.timer_chan_freshness_every_min();
6562         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6563 }
6564
6565 #[test]
6566 fn test_bump_penalty_txn_on_revoked_commitment() {
6567         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6568         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6569
6570         let node_cfgs = create_node_cfgs(2);
6571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6572         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6573
6574         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6575         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6576         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6577         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6578
6579         let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6580         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6581         assert_eq!(revoked_txn[0].output.len(), 4);
6582         assert_eq!(revoked_txn[0].input.len(), 1);
6583         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6584         let revoked_txid = revoked_txn[0].txid();
6585
6586         let mut penalty_sum = 0;
6587         for outp in revoked_txn[0].output.iter() {
6588                 if outp.script_pubkey.is_v0_p2wsh() {
6589                         penalty_sum += outp.value;
6590                 }
6591         }
6592
6593         // Connect blocks to change height_timer range to see if we use right soonest_timelock
6594         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6595
6596         // Actually revoke tx by claiming a HTLC
6597         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6598         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6599         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6600
6601         // One or more justice tx should have been broadcast, check it
6602         let penalty_1;
6603         let feerate_1;
6604         {
6605                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6606                 assert_eq!(node_txn.len(), 4); // justice tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6607                 assert_eq!(node_txn[0], node_txn[3]);
6608                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6609                 assert_eq!(node_txn[0].output.len(), 1);
6610                 check_spends!(node_txn[0], revoked_txn[0].clone());
6611                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6612                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6613                 penalty_1 = node_txn[0].txid();
6614                 node_txn.clear();
6615         };
6616
6617         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6618         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
6619         let mut penalty_2 = penalty_1;
6620         let mut feerate_2 = 0;
6621         {
6622                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6623                 assert_eq!(node_txn.len(), 1);
6624                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6625                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6626                         assert_eq!(node_txn[0].output.len(), 1);
6627                         check_spends!(node_txn[0], revoked_txn[0].clone());
6628                         penalty_2 = node_txn[0].txid();
6629                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6630                         assert_ne!(penalty_2, penalty_1);
6631                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
6632                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6633                         // Verify 25% bump heuristic
6634                         assert!(feerate_2 * 100 >= feerate_1 * 125);
6635                         node_txn.clear();
6636                 }
6637         }
6638         assert_ne!(feerate_2, 0);
6639
6640         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6641         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6642         let penalty_3;
6643         let mut feerate_3 = 0;
6644         {
6645                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6646                 assert_eq!(node_txn.len(), 1);
6647                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6648                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6649                         assert_eq!(node_txn[0].output.len(), 1);
6650                         check_spends!(node_txn[0], revoked_txn[0].clone());
6651                         penalty_3 = node_txn[0].txid();
6652                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6653                         assert_ne!(penalty_3, penalty_2);
6654                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
6655                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6656                         // Verify 25% bump heuristic
6657                         assert!(feerate_3 * 100 >= feerate_2 * 125);
6658                         node_txn.clear();
6659                 }
6660         }
6661         assert_ne!(feerate_3, 0);
6662
6663         nodes[1].node.get_and_clear_pending_events();
6664         nodes[1].node.get_and_clear_pending_msg_events();
6665 }
6666
6667 #[test]
6668 fn test_bump_penalty_txn_on_revoked_htlcs() {
6669         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6670         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6671
6672         let node_cfgs = create_node_cfgs(2);
6673         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6674         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6675
6676         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6677         // Lock HTLC in both directions
6678         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6679         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6680
6681         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6682         assert_eq!(revoked_local_txn[0].input.len(), 1);
6683         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6684
6685         // Revoke local commitment tx
6686         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6687
6688         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6689         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6690         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6691         check_closed_broadcast!(nodes[1], false);
6692
6693         let mut received = ::std::usize::MAX;
6694         let mut offered = ::std::usize::MAX;
6695         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6696         assert_eq!(revoked_htlc_txn.len(), 6);
6697         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6698                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6699                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6700                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6701                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6702                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6703                 received = 0;
6704                 offered = 1;
6705         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6706                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6707                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6708                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6709                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6710                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6711                 received = 1;
6712                 offered = 0;
6713         }
6714
6715         // Broadcast set of revoked txn on A
6716         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  true, header.bitcoin_hash());
6717
6718         // Expect pending failures, but we don't bother trying to update the channel state with them.
6719         let events = nodes[0].node.get_and_clear_pending_events();
6720         assert_eq!(events.len(), 1);
6721         match events[0] {
6722                 Event::PendingHTLCsForwardable { .. } => { },
6723                 _ => panic!("Unexpected event"),
6724         };
6725
6726         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6727         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
6728         let first;
6729         let second;
6730         let feerate_1;
6731         let feerate_2;
6732         {
6733                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6734                 assert_eq!(node_txn.len(), 9); // 3 penalty txn on revoked commitment tx * 2 (block-rescan) + A commitment tx + 2 penalty tnx on revoked HTLC txn
6735                 // Verify claim tx are spending revoked HTLC txn
6736                 assert_eq!(node_txn[7].input.len(), 1);
6737                 assert_eq!(node_txn[7].output.len(), 1);
6738                 check_spends!(node_txn[7], revoked_htlc_txn[0].clone());
6739                 first = node_txn[7].txid();
6740                 assert_eq!(node_txn[8].input.len(), 1);
6741                 assert_eq!(node_txn[8].output.len(), 1);
6742                 check_spends!(node_txn[8], revoked_htlc_txn[1].clone());
6743                 second = node_txn[8].txid();
6744                 // Store both feerates for later comparison
6745                 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[7].output[0].value;
6746                 feerate_1 = fee_1 * 1000 / node_txn[7].get_weight() as u64;
6747                 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[8].output[0].value;
6748                 feerate_2 = fee_2 * 1000 / node_txn[8].get_weight() as u64;
6749                 node_txn.clear();
6750         }
6751
6752         // Connect three more block to see if bumped penalty are issued for HTLC txn
6753         let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6754         let penalty_local_tx;
6755         {
6756                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6757                 assert_eq!(node_txn.len(), 3); // 2 bumped penalty txn on offered/received HTLC outputs of revoked commitment tx + 1 penalty tx on to_local of revoked commitment tx + 2 bumped penalty tx on revoked HTLC txn
6758
6759                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6760                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6761
6762                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6763
6764                 penalty_local_tx = node_txn[2].clone();
6765                 node_txn.clear();
6766         };
6767         // Few more blocks to broadcast and confirm penalty_local_tx
6768         let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6769         nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6770         let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6771         {
6772                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6773                 assert_eq!(node_txn.len(), 1);
6774                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6775                 node_txn.clear();
6776         }
6777         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6778         let node_txn = {
6779                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6780                 assert_eq!(node_txn.len(), 2);
6781
6782                 let mut penalty_offered = ::std::usize::MAX;
6783                 let mut penalty_received = ::std::usize::MAX;
6784
6785                 {
6786                         for (i, tx) in node_txn.iter().enumerate() {
6787                                 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6788                                         penalty_offered = i;
6789                                 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6790                                         penalty_received = i;
6791                                 }
6792                         }
6793                 }
6794
6795                 assert_eq!(node_txn[penalty_received].input.len(), 1);
6796                 assert_eq!(node_txn[penalty_received].output.len(), 1);
6797                 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6798                 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6799                 // Verify bumped tx is different and 25% bump heuristic
6800                 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6801                 assert_ne!(first, node_txn[penalty_offered].txid());
6802                 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6803                 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6804                 assert!(new_feerate * 100 > feerate_1 * 125);
6805
6806                 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6807                 assert_ne!(second, node_txn[penalty_received].txid());
6808                 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6809                 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6810                 assert!(new_feerate * 100 > feerate_2 * 125);
6811                 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
6812                 node_txn.clear();
6813                 txn
6814         };
6815         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6816         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6817         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
6818         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
6819         {
6820                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6821                 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
6822                 node_txn.clear();
6823         }
6824         check_closed_broadcast!(nodes[0], false);
6825 }
6826
6827 #[test]
6828 fn test_bump_penalty_txn_on_remote_commitment() {
6829         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6830         // we're able to claim outputs on remote commitment transaction before timelocks expiration
6831
6832         // Create 2 HTLCs
6833         // Provide preimage for one
6834         // Check aggregation
6835
6836         let node_cfgs = create_node_cfgs(2);
6837         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6838         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6839
6840         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6841         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6842         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6843
6844         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6845         let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6846         assert_eq!(remote_txn[0].output.len(), 4);
6847         assert_eq!(remote_txn[0].input.len(), 1);
6848         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6849
6850         // Claim a HTLC without revocation (provide B monitor with preimage)
6851         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
6852         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6853         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6854         check_added_monitors!(nodes[1], 1);
6855
6856         // One or more claim tx should have been broadcast, check it
6857         let timeout;
6858         let preimage;
6859         let feerate_timeout;
6860         let feerate_preimage;
6861         {
6862                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6863                 assert_eq!(node_txn.len(), 7); // 2 * claim tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout + HTLC-success (broadcasted from ChannelManager)
6864                 assert_eq!(node_txn[0], node_txn[5]);
6865                 assert_eq!(node_txn[1], node_txn[6]);
6866                 assert_eq!(node_txn[0].input.len(), 1);
6867                 assert_eq!(node_txn[1].input.len(), 1);
6868                 check_spends!(node_txn[0], remote_txn[0].clone());
6869                 check_spends!(node_txn[1], remote_txn[0].clone());
6870                 check_spends!(node_txn[2], chan.3);
6871                 check_spends!(node_txn[3], node_txn[2]);
6872                 check_spends!(node_txn[4], node_txn[2]);
6873                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6874                         timeout = node_txn[0].txid();
6875                         let index = node_txn[0].input[0].previous_output.vout;
6876                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6877                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6878
6879                         preimage = node_txn[1].txid();
6880                         let index = node_txn[1].input[0].previous_output.vout;
6881                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6882                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6883                 } else {
6884                         timeout = node_txn[1].txid();
6885                         let index = node_txn[1].input[0].previous_output.vout;
6886                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6887                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6888
6889                         preimage = node_txn[0].txid();
6890                         let index = node_txn[0].input[0].previous_output.vout;
6891                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6892                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6893                 }
6894                 node_txn.clear();
6895         };
6896         assert_ne!(feerate_timeout, 0);
6897         assert_ne!(feerate_preimage, 0);
6898
6899         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6900         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
6901         {
6902                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6903                 assert_eq!(node_txn.len(), 2);
6904                 assert_eq!(node_txn[0].input.len(), 1);
6905                 assert_eq!(node_txn[1].input.len(), 1);
6906                 check_spends!(node_txn[0], remote_txn[0].clone());
6907                 check_spends!(node_txn[1], remote_txn[0].clone());
6908                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6909                         let index = node_txn[0].input[0].previous_output.vout;
6910                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6911                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6912                         assert!(new_feerate * 100 > feerate_timeout * 125);
6913                         assert_ne!(timeout, node_txn[0].txid());
6914
6915                         let index = node_txn[1].input[0].previous_output.vout;
6916                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6917                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6918                         assert!(new_feerate * 100 > feerate_preimage * 125);
6919                         assert_ne!(preimage, node_txn[1].txid());
6920                 } else {
6921                         let index = node_txn[1].input[0].previous_output.vout;
6922                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6923                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6924                         assert!(new_feerate * 100 > feerate_timeout * 125);
6925                         assert_ne!(timeout, node_txn[1].txid());
6926
6927                         let index = node_txn[0].input[0].previous_output.vout;
6928                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6929                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6930                         assert!(new_feerate * 100 > feerate_preimage * 125);
6931                         assert_ne!(preimage, node_txn[0].txid());
6932                 }
6933                 node_txn.clear();
6934         }
6935
6936         nodes[1].node.get_and_clear_pending_events();
6937         nodes[1].node.get_and_clear_pending_msg_events();
6938 }
6939
6940 #[test]
6941 fn test_set_outpoints_partial_claiming() {
6942         // - remote party claim tx, new bump tx
6943         // - disconnect remote claiming tx, new bump
6944         // - disconnect tx, see no tx anymore
6945         let node_cfgs = create_node_cfgs(2);
6946         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6947         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6948
6949         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6950         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6951         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6952
6953         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6954         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6955         assert_eq!(remote_txn.len(), 3);
6956         assert_eq!(remote_txn[0].output.len(), 4);
6957         assert_eq!(remote_txn[0].input.len(), 1);
6958         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6959         check_spends!(remote_txn[1], remote_txn[0].clone());
6960         check_spends!(remote_txn[2], remote_txn[0].clone());
6961
6962         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6963         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6964         // Provide node A with both preimage
6965         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
6966         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
6967         check_added_monitors!(nodes[0], 2);
6968         nodes[0].node.get_and_clear_pending_events();
6969         nodes[0].node.get_and_clear_pending_msg_events();
6970
6971         // Connect blocks on node A commitment transaction
6972         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6973         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6974         // Verify node A broadcast tx claiming both HTLCs
6975         {
6976                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6977                 assert_eq!(node_txn.len(), 5);
6978                 assert_eq!(node_txn[0], node_txn[4]);
6979                 check_spends!(node_txn[0], remote_txn[0].clone());
6980                 check_spends!(node_txn[1], chan.3.clone());
6981                 check_spends!(node_txn[2], node_txn[1]);
6982                 check_spends!(node_txn[3], node_txn[1]);
6983                 assert_eq!(node_txn[0].input.len(), 2);
6984                 node_txn.clear();
6985         }
6986         nodes[0].node.get_and_clear_pending_msg_events();
6987
6988         // Connect blocks on node B
6989         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6990         // Verify node B broadcast 2 HTLC-timeout txn
6991         let partial_claim_tx = {
6992                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6993                 assert_eq!(node_txn.len(), 3);
6994                 check_spends!(node_txn[1], node_txn[0].clone());
6995                 check_spends!(node_txn[2], node_txn[0].clone());
6996                 assert_eq!(node_txn[1].input.len(), 1);
6997                 assert_eq!(node_txn[2].input.len(), 1);
6998                 node_txn[1].clone()
6999         };
7000         nodes[1].node.get_and_clear_pending_msg_events();
7001
7002         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7003         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7004         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7005         {
7006                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7007                 assert_eq!(node_txn.len(), 1);
7008                 check_spends!(node_txn[0], remote_txn[0].clone());
7009                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7010                 node_txn.clear();
7011         }
7012         nodes[0].node.get_and_clear_pending_msg_events();
7013
7014         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7015         nodes[0].block_notifier.block_disconnected(&header, 102);
7016         {
7017                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7018                 assert_eq!(node_txn.len(), 1);
7019                 check_spends!(node_txn[0], remote_txn[0].clone());
7020                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7021                 node_txn.clear();
7022         }
7023
7024         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7025         nodes[0].block_notifier.block_disconnected(&header, 101);
7026         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7027         {
7028                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7029                 assert_eq!(node_txn.len(), 0);
7030                 node_txn.clear();
7031         }
7032 }
7033
7034 #[test]
7035 fn test_counterparty_raa_skip_no_crash() {
7036         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7037         // commitment transaction, we would have happily carried on and provided them the next
7038         // commitment transaction based on one RAA forward. This would probably eventually have led to
7039         // channel closure, but it would not have resulted in funds loss. Still, our
7040         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7041         // check simply that the channel is closed in response to such an RAA, but don't check whether
7042         // we decide to punish our counterparty for revoking their funds (as we don't currently
7043         // implement that).
7044         let node_cfgs = create_node_cfgs(2);
7045         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7046         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7047         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7048
7049         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().local_keys.commitment_seed().clone();
7050         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7051                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, (1 << 48) - 3)).unwrap());
7052         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, (1 << 48) - 1);
7053
7054         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7055                 &msgs::RevokeAndACK { channel_id: chan.2, per_commitment_secret, next_per_commitment_point });
7056         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Got a revoke when we weren't expecting one");
7057 }
7058
7059 #[test]
7060 fn test_bump_txn_sanitize_tracking_maps() {
7061         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7062         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7063
7064         let node_cfgs = create_node_cfgs(2);
7065         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7066         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7067
7068         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7069         // Lock HTLC in both directions
7070         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7071         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7072
7073         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7074         assert_eq!(revoked_local_txn[0].input.len(), 1);
7075         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7076
7077         // Revoke local commitment tx
7078         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7079
7080         // Broadcast set of revoked txn on A
7081         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7082
7083         // Expect pending failures, but we don't bother trying to update the channel state with them.
7084         let events = nodes[0].node.get_and_clear_pending_events();
7085         assert_eq!(events.len(), 1);
7086         match events[0] {
7087                 Event::PendingHTLCsForwardable { .. } => { },
7088                 _ => panic!("Unexpected event"),
7089         };
7090
7091         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7092         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7093         check_closed_broadcast!(nodes[0], false);
7094         let penalty_txn = {
7095                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7096                 assert_eq!(node_txn.len(), 7);
7097                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7098                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7099                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7100                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7101                 node_txn.clear();
7102                 penalty_txn
7103         };
7104         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7105         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7106         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7107         {
7108                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7109                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7110                         assert!(monitor.pending_claim_requests.is_empty());
7111                         assert!(monitor.claimable_outpoints.is_empty());
7112                 }
7113         }
7114 }
7115
7116 #[test]
7117 fn test_simple_payment_secret() {
7118         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7119         // features, however.
7120         let node_cfgs = create_node_cfgs(3);
7121         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7122         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7123
7124         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7125         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7126
7127         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7128         let (_, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7129         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7130         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.0));
7131         // Claiming with all the correct values but the wrong secret should result in nothing...
7132         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7133         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some([42; 32]), 100_000), false);
7134         // ...but with the right secret we should be able to claim all the way back
7135         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.0), 100_000);
7136 }
7137
7138 #[test]
7139 fn test_simple_mpp() {
7140         // Simple test of sending a multi-path payment.
7141         let node_cfgs = create_node_cfgs(4);
7142         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7143         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7144
7145         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7146         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7147         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7148         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7149
7150         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7151         let (_, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7152         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7153         let path = route.paths[0].clone();
7154         route.paths.push(path);
7155         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7156         route.paths[0][0].short_channel_id = chan_1_id;
7157         route.paths[0][1].short_channel_id = chan_3_id;
7158         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7159         route.paths[1][0].short_channel_id = chan_2_id;
7160         route.paths[1][1].short_channel_id = chan_4_id;
7161         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.0));
7162         // Claiming with all the correct values but the wrong secret should result in nothing...
7163         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7164         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some([42; 32]), 200_000), false);
7165         // ...but with the right secret we should be able to claim all the way back
7166         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret.0), 200_000);
7167 }