_ 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, 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).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).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_1_conf_open() {
 383         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 384         // tests that we properly send one in that case.
 385         let mut alice_config = UserConfig::default();
 386         alice_config.own_channel_config.minimum_depth = 1;
 387         alice_config.channel_options.announced_channel = true;
 388         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 389         let mut bob_config = UserConfig::default();
 390         bob_config.own_channel_config.minimum_depth = 1;
 391         bob_config.channel_options.announced_channel = true;
 392         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 393         let node_cfgs = create_node_cfgs(2);
 394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 396
 397         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
 398         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 399         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 400
 401         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 402         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 403         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 404
 405         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 406         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 407         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 408
 409         for node in nodes {
 410                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
 411                 node.router.handle_channel_update(&as_update).unwrap();
 412                 node.router.handle_channel_update(&bs_update).unwrap();
 413         }
 414 }
 415
 416 #[test]
 417 fn test_update_fee_vanilla() {
 418         let node_cfgs = create_node_cfgs(2);
 419         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 420         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 421         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 422         let channel_id = chan.2;
 423
 424         let feerate = get_feerate!(nodes[0], channel_id);
 425         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 426         check_added_monitors!(nodes[0], 1);
 427
 428         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 429         assert_eq!(events_0.len(), 1);
 430         let (update_msg, commitment_signed) = match events_0[0] {
 431                         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 } } => {
 432                         (update_fee.as_ref(), commitment_signed)
 433                 },
 434                 _ => panic!("Unexpected event"),
 435         };
 436         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 437
 438         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 439         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 440         check_added_monitors!(nodes[1], 1);
 441
 442         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 443         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 444         check_added_monitors!(nodes[0], 1);
 445
 446         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 447         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 448         // No commitment_signed so get_event_msg's assert(len == 1) passes
 449         check_added_monitors!(nodes[0], 1);
 450
 451         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 452         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 453         check_added_monitors!(nodes[1], 1);
 454 }
 455
 456 #[test]
 457 fn test_update_fee_that_funder_cannot_afford() {
 458         let node_cfgs = create_node_cfgs(2);
 459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 461         let channel_value = 1888;
 462         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 463         let channel_id = chan.2;
 464
 465         let feerate = 260;
 466         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 467         check_added_monitors!(nodes[0], 1);
 468         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 469
 470         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 471
 472         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 473
 474         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 475         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 476         {
 477                 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
 478                 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
 479
 480                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 481                 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
 482                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 483                 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
 484                 actual_fee = channel_value - actual_fee;
 485                 assert_eq!(total_fee, actual_fee);
 486         } //drop the mutex
 487
 488         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 489         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 490         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 491         check_added_monitors!(nodes[0], 1);
 492
 493         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 494
 495         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 496
 497         //While producing the commitment_signed response after handling a received update_fee request the
 498         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 499         //Should produce and error.
 500         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 501         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 502
 503         //clear the message we could not handle
 504         nodes[1].node.get_and_clear_pending_msg_events();
 505 }
 506
 507 #[test]
 508 fn test_update_fee_with_fundee_update_add_htlc() {
 509         let node_cfgs = create_node_cfgs(2);
 510         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 511         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 512         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 513         let channel_id = chan.2;
 514
 515         // balancing
 516         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 517
 518         let feerate = get_feerate!(nodes[0], channel_id);
 519         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 520         check_added_monitors!(nodes[0], 1);
 521
 522         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 523         assert_eq!(events_0.len(), 1);
 524         let (update_msg, commitment_signed) = match events_0[0] {
 525                         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 } } => {
 526                         (update_fee.as_ref(), commitment_signed)
 527                 },
 528                 _ => panic!("Unexpected event"),
 529         };
 530         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 531         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 532         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 533         check_added_monitors!(nodes[1], 1);
 534
 535         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 536
 537         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 538
 539         // nothing happens since node[1] is in AwaitingRemoteRevoke
 540         nodes[1].node.send_payment(route, our_payment_hash).unwrap();
 541         {
 542                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 543                 assert_eq!(added_monitors.len(), 0);
 544                 added_monitors.clear();
 545         }
 546         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 547         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 548         // node[1] has nothing to do
 549
 550         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 551         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 552         check_added_monitors!(nodes[0], 1);
 553
 554         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 555         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 556         // No commitment_signed so get_event_msg's assert(len == 1) passes
 557         check_added_monitors!(nodes[0], 1);
 558         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 559         check_added_monitors!(nodes[1], 1);
 560         // AwaitingRemoteRevoke ends here
 561
 562         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 563         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 564         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 565         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 566         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 567         assert_eq!(commitment_update.update_fee.is_none(), true);
 568
 569         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 570         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 571         check_added_monitors!(nodes[0], 1);
 572         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 573
 574         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 575         check_added_monitors!(nodes[1], 1);
 576         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 577
 578         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 579         check_added_monitors!(nodes[1], 1);
 580         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 581         // No commitment_signed so get_event_msg's assert(len == 1) passes
 582
 583         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 584         check_added_monitors!(nodes[0], 1);
 585         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 586
 587         expect_pending_htlcs_forwardable!(nodes[0]);
 588
 589         let events = nodes[0].node.get_and_clear_pending_events();
 590         assert_eq!(events.len(), 1);
 591         match events[0] {
 592                 Event::PaymentReceived { .. } => { },
 593                 _ => panic!("Unexpected event"),
 594         };
 595
 596         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 597
 598         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 599         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 600         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 601 }
 602
 603 #[test]
 604 fn test_update_fee() {
 605         let node_cfgs = create_node_cfgs(2);
 606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 607         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 608         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 609         let channel_id = chan.2;
 610
 611         // A                                        B
 612         // (1) update_fee/commitment_signed      ->
 613         //                                       <- (2) revoke_and_ack
 614         //                                       .- send (3) commitment_signed
 615         // (4) update_fee/commitment_signed      ->
 616         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 617         //                                       <- (3) commitment_signed delivered
 618         // send (6) revoke_and_ack               -.
 619         //                                       <- (5) deliver revoke_and_ack
 620         // (6) deliver revoke_and_ack            ->
 621         //                                       .- send (7) commitment_signed in response to (4)
 622         //                                       <- (7) deliver commitment_signed
 623         // revoke_and_ack                        ->
 624
 625         // Create and deliver (1)...
 626         let feerate = get_feerate!(nodes[0], channel_id);
 627         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 628         check_added_monitors!(nodes[0], 1);
 629
 630         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 631         assert_eq!(events_0.len(), 1);
 632         let (update_msg, commitment_signed) = match events_0[0] {
 633                         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 } } => {
 634                         (update_fee.as_ref(), commitment_signed)
 635                 },
 636                 _ => panic!("Unexpected event"),
 637         };
 638         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 639
 640         // Generate (2) and (3):
 641         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 642         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 643         check_added_monitors!(nodes[1], 1);
 644
 645         // Deliver (2):
 646         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 647         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 648         check_added_monitors!(nodes[0], 1);
 649
 650         // Create and deliver (4)...
 651         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 652         check_added_monitors!(nodes[0], 1);
 653         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 654         assert_eq!(events_0.len(), 1);
 655         let (update_msg, commitment_signed) = match events_0[0] {
 656                         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 } } => {
 657                         (update_fee.as_ref(), commitment_signed)
 658                 },
 659                 _ => panic!("Unexpected event"),
 660         };
 661
 662         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 663         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 664         check_added_monitors!(nodes[1], 1);
 665         // ... creating (5)
 666         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 667         // No commitment_signed so get_event_msg's assert(len == 1) passes
 668
 669         // Handle (3), creating (6):
 670         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 671         check_added_monitors!(nodes[0], 1);
 672         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 673         // No commitment_signed so get_event_msg's assert(len == 1) passes
 674
 675         // Deliver (5):
 676         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 677         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 678         check_added_monitors!(nodes[0], 1);
 679
 680         // Deliver (6), creating (7):
 681         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 682         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 683         assert!(commitment_update.update_add_htlcs.is_empty());
 684         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 685         assert!(commitment_update.update_fail_htlcs.is_empty());
 686         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 687         assert!(commitment_update.update_fee.is_none());
 688         check_added_monitors!(nodes[1], 1);
 689
 690         // Deliver (7)
 691         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 692         check_added_monitors!(nodes[0], 1);
 693         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 694         // No commitment_signed so get_event_msg's assert(len == 1) passes
 695
 696         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 697         check_added_monitors!(nodes[1], 1);
 698         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 699
 700         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 701         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 702         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 703 }
 704
 705 #[test]
 706 fn pre_funding_lock_shutdown_test() {
 707         // Test sending a shutdown prior to funding_locked after funding generation
 708         let node_cfgs = create_node_cfgs(2);
 709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 710         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 711         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 712         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 713         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 714         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 715
 716         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 717         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 718         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 719         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 720         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 721
 722         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 723         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 724         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 725         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 726         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 727         assert!(node_0_none.is_none());
 728
 729         assert!(nodes[0].node.list_channels().is_empty());
 730         assert!(nodes[1].node.list_channels().is_empty());
 731 }
 732
 733 #[test]
 734 fn updates_shutdown_wait() {
 735         // Test sending a shutdown with outstanding updates pending
 736         let node_cfgs = create_node_cfgs(3);
 737         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 738         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 739         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 740         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 741         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 742         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 743
 744         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 745
 746         nodes[0].node.close_channel(&chan_1.2).unwrap();
 747         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 748         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 749         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 750         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 751
 752         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 753         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 754
 755         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 756         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
 757         else { panic!("New sends should fail!") };
 758         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
 759         else { panic!("New sends should fail!") };
 760
 761         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 762         check_added_monitors!(nodes[2], 1);
 763         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 764         assert!(updates.update_add_htlcs.is_empty());
 765         assert!(updates.update_fail_htlcs.is_empty());
 766         assert!(updates.update_fail_malformed_htlcs.is_empty());
 767         assert!(updates.update_fee.is_none());
 768         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 769         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 770         check_added_monitors!(nodes[1], 1);
 771         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 772         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 773
 774         assert!(updates_2.update_add_htlcs.is_empty());
 775         assert!(updates_2.update_fail_htlcs.is_empty());
 776         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 777         assert!(updates_2.update_fee.is_none());
 778         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 779         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 780         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 781
 782         let events = nodes[0].node.get_and_clear_pending_events();
 783         assert_eq!(events.len(), 1);
 784         match events[0] {
 785                 Event::PaymentSent { ref payment_preimage } => {
 786                         assert_eq!(our_payment_preimage, *payment_preimage);
 787                 },
 788                 _ => panic!("Unexpected event"),
 789         }
 790
 791         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 792         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 793         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 794         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 795         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 796         assert!(node_0_none.is_none());
 797
 798         assert!(nodes[0].node.list_channels().is_empty());
 799
 800         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 801         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 802         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 803         assert!(nodes[1].node.list_channels().is_empty());
 804         assert!(nodes[2].node.list_channels().is_empty());
 805 }
 806
 807 #[test]
 808 fn htlc_fail_async_shutdown() {
 809         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 810         let node_cfgs = create_node_cfgs(3);
 811         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 812         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 813         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 814         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 815
 816         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 817         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 818         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
 819         check_added_monitors!(nodes[0], 1);
 820         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 821         assert_eq!(updates.update_add_htlcs.len(), 1);
 822         assert!(updates.update_fulfill_htlcs.is_empty());
 823         assert!(updates.update_fail_htlcs.is_empty());
 824         assert!(updates.update_fail_malformed_htlcs.is_empty());
 825         assert!(updates.update_fee.is_none());
 826
 827         nodes[1].node.close_channel(&chan_1.2).unwrap();
 828         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 829         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 830         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 831
 832         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 833         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 834         check_added_monitors!(nodes[1], 1);
 835         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 836         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 837
 838         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 839         assert!(updates_2.update_add_htlcs.is_empty());
 840         assert!(updates_2.update_fulfill_htlcs.is_empty());
 841         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 842         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 843         assert!(updates_2.update_fee.is_none());
 844
 845         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 846         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 847
 848         let events = nodes[0].node.get_and_clear_pending_events();
 849         assert_eq!(events.len(), 1);
 850         match events[0] {
 851                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 852                         assert_eq!(our_payment_hash, *payment_hash);
 853                         assert!(!rejected_by_dest);
 854                 },
 855                 _ => panic!("Unexpected event"),
 856         }
 857
 858         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 859         assert_eq!(msg_events.len(), 2);
 860         let node_0_closing_signed = match msg_events[0] {
 861                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 862                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 863                         (*msg).clone()
 864                 },
 865                 _ => panic!("Unexpected event"),
 866         };
 867         match msg_events[1] {
 868                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 869                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 870                 },
 871                 _ => panic!("Unexpected event"),
 872         }
 873
 874         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 875         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 876         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 877         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 878         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 879         assert!(node_0_none.is_none());
 880
 881         assert!(nodes[0].node.list_channels().is_empty());
 882
 883         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 884         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 885         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 886         assert!(nodes[1].node.list_channels().is_empty());
 887         assert!(nodes[2].node.list_channels().is_empty());
 888 }
 889
 890 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 891         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 892         // messages delivered prior to disconnect
 893         let node_cfgs = create_node_cfgs(3);
 894         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 895         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 896         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 897         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 898
 899         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 900
 901         nodes[1].node.close_channel(&chan_1.2).unwrap();
 902         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 903         if recv_count > 0 {
 904                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 905                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 906                 if recv_count > 1 {
 907                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 908                 }
 909         }
 910
 911         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 912         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 913
 914         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 915         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 916         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 917         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 918
 919         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
 920         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 921         assert!(node_1_shutdown == node_1_2nd_shutdown);
 922
 923         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
 924         let node_0_2nd_shutdown = if recv_count > 0 {
 925                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 926                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 927                 node_0_2nd_shutdown
 928         } else {
 929                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 930                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 931                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 932         };
 933         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
 934
 935         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 936         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 937
 938         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 939         check_added_monitors!(nodes[2], 1);
 940         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 941         assert!(updates.update_add_htlcs.is_empty());
 942         assert!(updates.update_fail_htlcs.is_empty());
 943         assert!(updates.update_fail_malformed_htlcs.is_empty());
 944         assert!(updates.update_fee.is_none());
 945         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 946         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 947         check_added_monitors!(nodes[1], 1);
 948         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 949         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 950
 951         assert!(updates_2.update_add_htlcs.is_empty());
 952         assert!(updates_2.update_fail_htlcs.is_empty());
 953         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 954         assert!(updates_2.update_fee.is_none());
 955         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 956         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 957         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 958
 959         let events = nodes[0].node.get_and_clear_pending_events();
 960         assert_eq!(events.len(), 1);
 961         match events[0] {
 962                 Event::PaymentSent { ref payment_preimage } => {
 963                         assert_eq!(our_payment_preimage, *payment_preimage);
 964                 },
 965                 _ => panic!("Unexpected event"),
 966         }
 967
 968         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 969         if recv_count > 0 {
 970                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 971                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 972                 assert!(node_1_closing_signed.is_some());
 973         }
 974
 975         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 976         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 977
 978         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 979         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 980         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 981         if recv_count == 0 {
 982                 // If all closing_signeds weren't delivered we can just resume where we left off...
 983                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 984
 985                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 986                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 987                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 988
 989                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 990                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 991                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 992
 993                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
 994                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 995
 996                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
 997                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 998                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
 999
1000                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1001                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1002                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1003                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1004                 assert!(node_0_none.is_none());
1005         } else {
1006                 // If one node, however, received + responded with an identical closing_signed we end
1007                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1008                 // There isn't really anything better we can do simply, but in the future we might
1009                 // explore storing a set of recently-closed channels that got disconnected during
1010                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1011                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1012                 // transaction.
1013                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1014
1015                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1016                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1017                 assert_eq!(msg_events.len(), 1);
1018                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1019                         match action {
1020                                 &ErrorAction::SendErrorMessage { ref msg } => {
1021                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1022                                         assert_eq!(msg.channel_id, chan_1.2);
1023                                 },
1024                                 _ => panic!("Unexpected event!"),
1025                         }
1026                 } else { panic!("Needed SendErrorMessage close"); }
1027
1028                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1029                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1030                 // closing_signed so we do it ourselves
1031                 check_closed_broadcast!(nodes[0], false);
1032         }
1033
1034         assert!(nodes[0].node.list_channels().is_empty());
1035
1036         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1037         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1038         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1039         assert!(nodes[1].node.list_channels().is_empty());
1040         assert!(nodes[2].node.list_channels().is_empty());
1041 }
1042
1043 #[test]
1044 fn test_shutdown_rebroadcast() {
1045         do_test_shutdown_rebroadcast(0);
1046         do_test_shutdown_rebroadcast(1);
1047         do_test_shutdown_rebroadcast(2);
1048 }
1049
1050 #[test]
1051 fn fake_network_test() {
1052         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1053         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1054         let node_cfgs = create_node_cfgs(4);
1055         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1056         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1057
1058         // Create some initial channels
1059         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1060         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1061         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1062
1063         // Rebalance the network a bit by relaying one payment through all the channels...
1064         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1065         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1066         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1067         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1068
1069         // Send some more payments
1070         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1071         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1072         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1073
1074         // Test failure packets
1075         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1076         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1077
1078         // Add a new channel that skips 3
1079         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1080
1081         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1082         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1083         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1084         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1085         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1086         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1087         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1088
1089         // Do some rebalance loop payments, simultaneously
1090         let mut hops = Vec::with_capacity(3);
1091         hops.push(RouteHop {
1092                 pubkey: nodes[2].node.get_our_node_id(),
1093                 node_features: NodeFeatures::empty(),
1094                 short_channel_id: chan_2.0.contents.short_channel_id,
1095                 channel_features: ChannelFeatures::empty(),
1096                 fee_msat: 0,
1097                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1098         });
1099         hops.push(RouteHop {
1100                 pubkey: nodes[3].node.get_our_node_id(),
1101                 node_features: NodeFeatures::empty(),
1102                 short_channel_id: chan_3.0.contents.short_channel_id,
1103                 channel_features: ChannelFeatures::empty(),
1104                 fee_msat: 0,
1105                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1106         });
1107         hops.push(RouteHop {
1108                 pubkey: nodes[1].node.get_our_node_id(),
1109                 node_features: NodeFeatures::empty(),
1110                 short_channel_id: chan_4.0.contents.short_channel_id,
1111                 channel_features: ChannelFeatures::empty(),
1112                 fee_msat: 1000000,
1113                 cltv_expiry_delta: TEST_FINAL_CLTV,
1114         });
1115         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;
1116         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;
1117         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1118
1119         let mut hops = Vec::with_capacity(3);
1120         hops.push(RouteHop {
1121                 pubkey: nodes[3].node.get_our_node_id(),
1122                 node_features: NodeFeatures::empty(),
1123                 short_channel_id: chan_4.0.contents.short_channel_id,
1124                 channel_features: ChannelFeatures::empty(),
1125                 fee_msat: 0,
1126                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1127         });
1128         hops.push(RouteHop {
1129                 pubkey: nodes[2].node.get_our_node_id(),
1130                 node_features: NodeFeatures::empty(),
1131                 short_channel_id: chan_3.0.contents.short_channel_id,
1132                 channel_features: ChannelFeatures::empty(),
1133                 fee_msat: 0,
1134                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1135         });
1136         hops.push(RouteHop {
1137                 pubkey: nodes[1].node.get_our_node_id(),
1138                 node_features: NodeFeatures::empty(),
1139                 short_channel_id: chan_2.0.contents.short_channel_id,
1140                 channel_features: ChannelFeatures::empty(),
1141                 fee_msat: 1000000,
1142                 cltv_expiry_delta: TEST_FINAL_CLTV,
1143         });
1144         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;
1145         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;
1146         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1147
1148         // Claim the rebalances...
1149         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1150         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1151
1152         // Add a duplicate new channel from 2 to 4
1153         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1154
1155         // Send some payments across both channels
1156         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1157         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1158         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1159
1160
1161         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1162         let events = nodes[0].node.get_and_clear_pending_msg_events();
1163         assert_eq!(events.len(), 0);
1164         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);
1165
1166         //TODO: Test that routes work again here as we've been notified that the channel is full
1167
1168         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1169         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1170         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1171
1172         // Close down the channels...
1173         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1174         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1175         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1176         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1177         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1178 }
1179
1180 #[test]
1181 fn holding_cell_htlc_counting() {
1182         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1183         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1184         // commitment dance rounds.
1185         let node_cfgs = create_node_cfgs(3);
1186         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1187         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1188         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1189         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1190
1191         let mut payments = Vec::new();
1192         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1193                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1194                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1195                 nodes[1].node.send_payment(route, payment_hash).unwrap();
1196                 payments.push((payment_preimage, payment_hash));
1197         }
1198         check_added_monitors!(nodes[1], 1);
1199
1200         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1201         assert_eq!(events.len(), 1);
1202         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1203         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1204
1205         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1206         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1207         // another HTLC.
1208         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1209         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1210         if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1211                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1212         } else { panic!("Unexpected event"); }
1213         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1214         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1215
1216         // This should also be true if we try to forward a payment.
1217         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1218         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1219         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1220         check_added_monitors!(nodes[0], 1);
1221
1222         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1223         assert_eq!(events.len(), 1);
1224         let payment_event = SendEvent::from_event(events.pop().unwrap());
1225         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1226
1227         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1228         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1229         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1230         // fails), the second will process the resulting failure and fail the HTLC backward.
1231         expect_pending_htlcs_forwardable!(nodes[1]);
1232         expect_pending_htlcs_forwardable!(nodes[1]);
1233         check_added_monitors!(nodes[1], 1);
1234
1235         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1236         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1237         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1238
1239         let events = nodes[0].node.get_and_clear_pending_msg_events();
1240         assert_eq!(events.len(), 1);
1241         match events[0] {
1242                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1243                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1244                 },
1245                 _ => panic!("Unexpected event"),
1246         }
1247
1248         let events = nodes[0].node.get_and_clear_pending_events();
1249         assert_eq!(events.len(), 1);
1250         match events[0] {
1251                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1252                         assert_eq!(payment_hash, payment_hash_2);
1253                         assert!(!rejected_by_dest);
1254                 },
1255                 _ => panic!("Unexpected event"),
1256         }
1257
1258         // Now forward all the pending HTLCs and claim them back
1259         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1260         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1261         check_added_monitors!(nodes[2], 1);
1262
1263         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1264         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1265         check_added_monitors!(nodes[1], 1);
1266         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1267
1268         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1269         check_added_monitors!(nodes[1], 1);
1270         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1271
1272         for ref update in as_updates.update_add_htlcs.iter() {
1273                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1274         }
1275         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1276         check_added_monitors!(nodes[2], 1);
1277         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1278         check_added_monitors!(nodes[2], 1);
1279         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1280
1281         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1282         check_added_monitors!(nodes[1], 1);
1283         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1284         check_added_monitors!(nodes[1], 1);
1285         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1286
1287         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1288         check_added_monitors!(nodes[2], 1);
1289
1290         expect_pending_htlcs_forwardable!(nodes[2]);
1291
1292         let events = nodes[2].node.get_and_clear_pending_events();
1293         assert_eq!(events.len(), payments.len());
1294         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1295                 match event {
1296                         &Event::PaymentReceived { ref payment_hash, .. } => {
1297                                 assert_eq!(*payment_hash, *hash);
1298                         },
1299                         _ => panic!("Unexpected event"),
1300                 };
1301         }
1302
1303         for (preimage, _) in payments.drain(..) {
1304                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1305         }
1306
1307         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1308 }
1309
1310 #[test]
1311 fn duplicate_htlc_test() {
1312         // Test that we accept duplicate payment_hash HTLCs across the network and that
1313         // claiming/failing them are all separate and don't affect each other
1314         let node_cfgs = create_node_cfgs(6);
1315         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1316         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1317
1318         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1319         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1320         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1321         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1322         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1323         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1324
1325         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1326
1327         *nodes[0].network_payment_count.borrow_mut() -= 1;
1328         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1329
1330         *nodes[0].network_payment_count.borrow_mut() -= 1;
1331         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1332
1333         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1334         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1335         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1336 }
1337
1338 #[test]
1339 fn test_duplicate_htlc_different_direction_onchain() {
1340         // Test that ChannelMonitor doesn't generate 2 preimage txn
1341         // when we have 2 HTLCs with same preimage that go across a node
1342         // in opposite directions.
1343         let node_cfgs = create_node_cfgs(2);
1344         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1345         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1346
1347         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1348
1349         // balancing
1350         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1351
1352         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1353
1354         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1355         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1356
1357         // Provide preimage to node 0 by claiming payment
1358         nodes[0].node.claim_funds(payment_preimage, 800_000);
1359         check_added_monitors!(nodes[0], 1);
1360
1361         // Broadcast node 1 commitment txn
1362         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();
1363
1364         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1365         let mut has_both_htlcs = 0; // check htlcs match ones committed
1366         for outp in remote_txn[0].output.iter() {
1367                 if outp.value == 800_000 / 1000 {
1368                         has_both_htlcs += 1;
1369                 } else if outp.value == 900_000 / 1000 {
1370                         has_both_htlcs += 1;
1371                 }
1372         }
1373         assert_eq!(has_both_htlcs, 2);
1374
1375         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1376         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1377
1378         // Check we only broadcast 1 timeout tx
1379         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1380         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()) };
1381         assert_eq!(claim_txn.len(), 5);
1382         check_spends!(claim_txn[2], chan_1.3);
1383         check_spends!(claim_txn[3], claim_txn[2]);
1384         assert_eq!(htlc_pair.0.input.len(), 1);
1385         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1386         check_spends!(htlc_pair.0, remote_txn[0].clone());
1387         assert_eq!(htlc_pair.1.input.len(), 1);
1388         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1389         check_spends!(htlc_pair.1, remote_txn[0].clone());
1390
1391         let events = nodes[0].node.get_and_clear_pending_msg_events();
1392         assert_eq!(events.len(), 2);
1393         for e in events {
1394                 match e {
1395                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1396                         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, .. } } => {
1397                                 assert!(update_add_htlcs.is_empty());
1398                                 assert!(update_fail_htlcs.is_empty());
1399                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1400                                 assert!(update_fail_malformed_htlcs.is_empty());
1401                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1402                         },
1403                         _ => panic!("Unexpected event"),
1404                 }
1405         }
1406 }
1407
1408 fn do_channel_reserve_test(test_recv: bool) {
1409
1410         let node_cfgs = create_node_cfgs(3);
1411         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1412         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1413         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1414         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1415
1416         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1417         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1418
1419         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1420         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1421
1422         macro_rules! get_route_and_payment_hash {
1423                 ($recv_value: expr) => {{
1424                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1425                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1426                         (route, payment_hash, payment_preimage)
1427                 }}
1428         };
1429
1430         macro_rules! expect_forward {
1431                 ($node: expr) => {{
1432                         let mut events = $node.node.get_and_clear_pending_msg_events();
1433                         assert_eq!(events.len(), 1);
1434                         check_added_monitors!($node, 1);
1435                         let payment_event = SendEvent::from_event(events.remove(0));
1436                         payment_event
1437                 }}
1438         }
1439
1440         let feemsat = 239; // somehow we know?
1441         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1442
1443         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1444
1445         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1446         {
1447                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1448                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1449                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1450                 match err {
1451                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1452                         _ => panic!("Unknown error variants"),
1453                 }
1454                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1455                 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);
1456         }
1457
1458         let mut htlc_id = 0;
1459         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1460         // nodes[0]'s wealth
1461         loop {
1462                 let amt_msat = recv_value_0 + total_fee_msat;
1463                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1464                         break;
1465                 }
1466                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1467                 htlc_id += 1;
1468
1469                 let (stat01_, stat11_, stat12_, stat22_) = (
1470                         get_channel_value_stat!(nodes[0], chan_1.2),
1471                         get_channel_value_stat!(nodes[1], chan_1.2),
1472                         get_channel_value_stat!(nodes[1], chan_2.2),
1473                         get_channel_value_stat!(nodes[2], chan_2.2),
1474                 );
1475
1476                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1477                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1478                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1479                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1480                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1481         }
1482
1483         {
1484                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1485                 // attempt to get channel_reserve violation
1486                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1487                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1488                 match err {
1489                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1490                         _ => panic!("Unknown error variants"),
1491                 }
1492                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1493                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1494         }
1495
1496         // adding pending output
1497         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1498         let amt_msat_1 = recv_value_1 + total_fee_msat;
1499
1500         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1501         let payment_event_1 = {
1502                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1503                 check_added_monitors!(nodes[0], 1);
1504
1505                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1506                 assert_eq!(events.len(), 1);
1507                 SendEvent::from_event(events.remove(0))
1508         };
1509         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1510
1511         // channel reserve test with htlc pending output > 0
1512         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1513         {
1514                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1515                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1516                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1517                         _ => panic!("Unknown error variants"),
1518                 }
1519                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1520                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1521         }
1522
1523         {
1524                 // test channel_reserve test on nodes[1] side
1525                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1526
1527                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1528                 let secp_ctx = Secp256k1::new();
1529                 let session_priv = SecretKey::from_slice(&{
1530                         let mut session_key = [0; 32];
1531                         let mut rng = thread_rng();
1532                         rng.fill_bytes(&mut session_key);
1533                         session_key
1534                 }).expect("RNG is bad!");
1535
1536                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1537                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1538                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1539                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1540                 let msg = msgs::UpdateAddHTLC {
1541                         channel_id: chan_1.2,
1542                         htlc_id,
1543                         amount_msat: htlc_msat,
1544                         payment_hash: our_payment_hash,
1545                         cltv_expiry: htlc_cltv,
1546                         onion_routing_packet: onion_packet,
1547                 };
1548
1549                 if test_recv {
1550                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1551                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1552                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1553                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1554                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1555                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1556                         return;
1557                 }
1558         }
1559
1560         // split the rest to test holding cell
1561         let recv_value_21 = recv_value_2/2;
1562         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1563         {
1564                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1565                 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);
1566         }
1567
1568         // now see if they go through on both sides
1569         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1570         // but this will stuck in the holding cell
1571         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1572         check_added_monitors!(nodes[0], 0);
1573         let events = nodes[0].node.get_and_clear_pending_events();
1574         assert_eq!(events.len(), 0);
1575
1576         // test with outbound holding cell amount > 0
1577         {
1578                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1579                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1580                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1581                         _ => panic!("Unknown error variants"),
1582                 }
1583                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1584                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1585         }
1586
1587         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1588         // this will also stuck in the holding cell
1589         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1590         check_added_monitors!(nodes[0], 0);
1591         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1592         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1593
1594         // flush the pending htlc
1595         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1596         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1597         check_added_monitors!(nodes[1], 1);
1598
1599         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1600         check_added_monitors!(nodes[0], 1);
1601         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1602
1603         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1604         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1605         // No commitment_signed so get_event_msg's assert(len == 1) passes
1606         check_added_monitors!(nodes[0], 1);
1607
1608         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1609         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1610         check_added_monitors!(nodes[1], 1);
1611
1612         expect_pending_htlcs_forwardable!(nodes[1]);
1613
1614         let ref payment_event_11 = expect_forward!(nodes[1]);
1615         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1616         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1617
1618         expect_pending_htlcs_forwardable!(nodes[2]);
1619         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1620
1621         // flush the htlcs in the holding cell
1622         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1623         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1624         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1625         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1626         expect_pending_htlcs_forwardable!(nodes[1]);
1627
1628         let ref payment_event_3 = expect_forward!(nodes[1]);
1629         assert_eq!(payment_event_3.msgs.len(), 2);
1630         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1631         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1632
1633         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1634         expect_pending_htlcs_forwardable!(nodes[2]);
1635
1636         let events = nodes[2].node.get_and_clear_pending_events();
1637         assert_eq!(events.len(), 2);
1638         match events[0] {
1639                 Event::PaymentReceived { ref payment_hash, amt } => {
1640                         assert_eq!(our_payment_hash_21, *payment_hash);
1641                         assert_eq!(recv_value_21, amt);
1642                 },
1643                 _ => panic!("Unexpected event"),
1644         }
1645         match events[1] {
1646                 Event::PaymentReceived { ref payment_hash, amt } => {
1647                         assert_eq!(our_payment_hash_22, *payment_hash);
1648                         assert_eq!(recv_value_22, amt);
1649                 },
1650                 _ => panic!("Unexpected event"),
1651         }
1652
1653         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1654         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1655         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1656
1657         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);
1658         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1659         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1660         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1661
1662         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1663         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1664 }
1665
1666 #[test]
1667 fn channel_reserve_test() {
1668         do_channel_reserve_test(false);
1669         do_channel_reserve_test(true);
1670 }
1671
1672 #[test]
1673 fn channel_reserve_in_flight_removes() {
1674         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1675         // can send to its counterparty, but due to update ordering, the other side may not yet have
1676         // considered those HTLCs fully removed.
1677         // This tests that we don't count HTLCs which will not be included in the next remote
1678         // commitment transaction towards the reserve value (as it implies no commitment transaction
1679         // will be generated which violates the remote reserve value).
1680         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1681         // To test this we:
1682         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1683         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1684         //    you only consider the value of the first HTLC, it may not),
1685         //  * start routing a third HTLC from A to B,
1686         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1687         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1688         //  * deliver the first fulfill from B
1689         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1690         //    claim,
1691         //  * deliver A's response CS and RAA.
1692         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1693         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1694         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1695         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1696         let node_cfgs = create_node_cfgs(2);
1697         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1698         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1699         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1700
1701         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1702         // Route the first two HTLCs.
1703         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1704         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1705
1706         // Start routing the third HTLC (this is just used to get everyone in the right state).
1707         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1708         let send_1 = {
1709                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1710                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1711                 check_added_monitors!(nodes[0], 1);
1712                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1713                 assert_eq!(events.len(), 1);
1714                 SendEvent::from_event(events.remove(0))
1715         };
1716
1717         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1718         // initial fulfill/CS.
1719         assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1720         check_added_monitors!(nodes[1], 1);
1721         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1722
1723         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1724         // remove the second HTLC when we send the HTLC back from B to A.
1725         assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1726         check_added_monitors!(nodes[1], 1);
1727         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1728
1729         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1730         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1731         check_added_monitors!(nodes[0], 1);
1732         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1733         expect_payment_sent!(nodes[0], payment_preimage_1);
1734
1735         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1736         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1737         check_added_monitors!(nodes[1], 1);
1738         // B is already AwaitingRAA, so cant generate a CS here
1739         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1740
1741         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1742         check_added_monitors!(nodes[1], 1);
1743         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1744
1745         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1746         check_added_monitors!(nodes[0], 1);
1747         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1748
1749         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1750         check_added_monitors!(nodes[1], 1);
1751         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1752
1753         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1754         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1755         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1756         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1757         // on-chain as necessary).
1758         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1759         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1760         check_added_monitors!(nodes[0], 1);
1761         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1762         expect_payment_sent!(nodes[0], payment_preimage_2);
1763
1764         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1765         check_added_monitors!(nodes[1], 1);
1766         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1767
1768         expect_pending_htlcs_forwardable!(nodes[1]);
1769         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1770
1771         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1772         // resolve the second HTLC from A's point of view.
1773         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1774         check_added_monitors!(nodes[0], 1);
1775         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1776
1777         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1778         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1779         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1780         let send_2 = {
1781                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1782                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1783                 check_added_monitors!(nodes[1], 1);
1784                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1785                 assert_eq!(events.len(), 1);
1786                 SendEvent::from_event(events.remove(0))
1787         };
1788
1789         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1790         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1791         check_added_monitors!(nodes[0], 1);
1792         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1793
1794         // Now just resolve all the outstanding messages/HTLCs for completeness...
1795
1796         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1797         check_added_monitors!(nodes[1], 1);
1798         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1799
1800         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1801         check_added_monitors!(nodes[1], 1);
1802
1803         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1804         check_added_monitors!(nodes[0], 1);
1805         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1806
1807         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1808         check_added_monitors!(nodes[1], 1);
1809         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1810
1811         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1812         check_added_monitors!(nodes[0], 1);
1813
1814         expect_pending_htlcs_forwardable!(nodes[0]);
1815         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1816
1817         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1818         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1819 }
1820
1821 #[test]
1822 fn channel_monitor_network_test() {
1823         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1824         // tests that ChannelMonitor is able to recover from various states.
1825         let node_cfgs = create_node_cfgs(5);
1826         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1827         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1828
1829         // Create some initial channels
1830         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1831         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1832         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1833         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1834
1835         // Rebalance the network a bit by relaying one payment through all the channels...
1836         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1837         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1838         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1839         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1840
1841         // Simple case with no pending HTLCs:
1842         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1843         {
1844                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1845                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1846                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1847                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1848         }
1849         get_announce_close_broadcast_events(&nodes, 0, 1);
1850         assert_eq!(nodes[0].node.list_channels().len(), 0);
1851         assert_eq!(nodes[1].node.list_channels().len(), 1);
1852
1853         // One pending HTLC is discarded by the force-close:
1854         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1855
1856         // Simple case of one pending HTLC to HTLC-Timeout
1857         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1858         {
1859                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1860                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1861                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1862                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1863         }
1864         get_announce_close_broadcast_events(&nodes, 1, 2);
1865         assert_eq!(nodes[1].node.list_channels().len(), 0);
1866         assert_eq!(nodes[2].node.list_channels().len(), 1);
1867
1868         macro_rules! claim_funds {
1869                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1870                         {
1871                                 assert!($node.node.claim_funds($preimage, $amount));
1872                                 check_added_monitors!($node, 1);
1873
1874                                 let events = $node.node.get_and_clear_pending_msg_events();
1875                                 assert_eq!(events.len(), 1);
1876                                 match events[0] {
1877                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1878                                                 assert!(update_add_htlcs.is_empty());
1879                                                 assert!(update_fail_htlcs.is_empty());
1880                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1881                                         },
1882                                         _ => panic!("Unexpected event"),
1883                                 };
1884                         }
1885                 }
1886         }
1887
1888         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1889         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1890         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1891         let node2_commitment_txid;
1892         {
1893                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1894                 node2_commitment_txid = node_txn[0].txid();
1895
1896                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1897                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1898
1899                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1900                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1901
1902                 check_preimage_claim(&nodes[3], &node_txn);
1903         }
1904         get_announce_close_broadcast_events(&nodes, 2, 3);
1905         assert_eq!(nodes[2].node.list_channels().len(), 0);
1906         assert_eq!(nodes[3].node.list_channels().len(), 1);
1907
1908         { // Cheat and reset nodes[4]'s height to 1
1909                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1910                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1911         }
1912
1913         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1914         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1915         // One pending HTLC to time out:
1916         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1917         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1918         // buffer space).
1919
1920         {
1921                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1922                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1923                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1924                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1925                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1926                 }
1927
1928                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1929                 {
1930                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1931                         node_txn.retain(|tx| {
1932                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
1933                                         false
1934                                 } else { true }
1935                         });
1936                 }
1937
1938                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1939
1940                 // Claim the payment on nodes[4], giving it knowledge of the preimage
1941                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1942
1943                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1944
1945                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1946                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1947                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1948                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1949                 }
1950
1951                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1952
1953                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1954                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1955
1956                 check_preimage_claim(&nodes[4], &node_txn);
1957         }
1958         get_announce_close_broadcast_events(&nodes, 3, 4);
1959         assert_eq!(nodes[3].node.list_channels().len(), 0);
1960         assert_eq!(nodes[4].node.list_channels().len(), 0);
1961 }
1962
1963 #[test]
1964 fn test_justice_tx() {
1965         // Test justice txn built on revoked HTLC-Success tx, against both sides
1966         let mut alice_config = UserConfig::default();
1967         alice_config.channel_options.announced_channel = true;
1968         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1969         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1970         let mut bob_config = UserConfig::default();
1971         bob_config.channel_options.announced_channel = true;
1972         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1973         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1974         let user_cfgs = [Some(alice_config), Some(bob_config)];
1975         let node_cfgs = create_node_cfgs(2);
1976         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
1977         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1978         // Create some new channels:
1979         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1980
1981         // A pending HTLC which will be revoked:
1982         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1983         // Get the will-be-revoked local txn from nodes[0]
1984         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();
1985         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1986         assert_eq!(revoked_local_txn[0].input.len(), 1);
1987         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1988         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1989         assert_eq!(revoked_local_txn[1].input.len(), 1);
1990         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1991         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1992         // Revoke the old state
1993         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1994
1995         {
1996                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1997                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1998                 {
1999                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2000                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2001                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2002
2003                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2004                         node_txn.swap_remove(0);
2005                         node_txn.truncate(1);
2006                 }
2007                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2008
2009                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2010                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2011                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2012                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2013                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2014         }
2015         get_announce_close_broadcast_events(&nodes, 0, 1);
2016
2017         assert_eq!(nodes[0].node.list_channels().len(), 0);
2018         assert_eq!(nodes[1].node.list_channels().len(), 0);
2019
2020         // We test justice_tx build by A on B's revoked HTLC-Success tx
2021         // Create some new channels:
2022         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2023         {
2024                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2025                 node_txn.clear();
2026         }
2027
2028         // A pending HTLC which will be revoked:
2029         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2030         // Get the will-be-revoked local txn from B
2031         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();
2032         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2033         assert_eq!(revoked_local_txn[0].input.len(), 1);
2034         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2035         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2036         // Revoke the old state
2037         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2038         {
2039                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2040                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2041                 {
2042                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2043                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2044                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2045
2046                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2047                         node_txn.swap_remove(0);
2048                 }
2049                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2050
2051                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2052                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2053                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2054                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2055                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2056         }
2057         get_announce_close_broadcast_events(&nodes, 0, 1);
2058         assert_eq!(nodes[0].node.list_channels().len(), 0);
2059         assert_eq!(nodes[1].node.list_channels().len(), 0);
2060 }
2061
2062 #[test]
2063 fn revoked_output_claim() {
2064         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2065         // transaction is broadcast by its counterparty
2066         let node_cfgs = create_node_cfgs(2);
2067         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2068         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2069         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2070         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2071         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();
2072         assert_eq!(revoked_local_txn.len(), 1);
2073         // Only output is the full channel value back to nodes[0]:
2074         assert_eq!(revoked_local_txn[0].output.len(), 1);
2075         // Send a payment through, updating everyone's latest commitment txn
2076         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2077
2078         // Inform nodes[1] that nodes[0] broadcast a stale tx
2079         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2080         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2081         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2082         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2083
2084         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2085         check_spends!(node_txn[1], chan_1.3.clone());
2086
2087         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2088         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2089         get_announce_close_broadcast_events(&nodes, 0, 1);
2090 }
2091
2092 #[test]
2093 fn claim_htlc_outputs_shared_tx() {
2094         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2095         let node_cfgs = create_node_cfgs(2);
2096         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2097         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2098
2099         // Create some new channel:
2100         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2101
2102         // Rebalance the network to generate htlc in the two directions
2103         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2104         // 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
2105         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2106         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2107
2108         // Get the will-be-revoked local txn from node[0]
2109         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();
2110         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2111         assert_eq!(revoked_local_txn[0].input.len(), 1);
2112         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2113         assert_eq!(revoked_local_txn[1].input.len(), 1);
2114         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2115         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2116         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2117
2118         //Revoke the old state
2119         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2120
2121         {
2122                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2123                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2124                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2125                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2126
2127                 let events = nodes[1].node.get_and_clear_pending_events();
2128                 assert_eq!(events.len(), 1);
2129                 match events[0] {
2130                         Event::PaymentFailed { payment_hash, .. } => {
2131                                 assert_eq!(payment_hash, payment_hash_2);
2132                         },
2133                         _ => panic!("Unexpected event"),
2134                 }
2135
2136                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2137                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2138
2139                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2140                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2141
2142                 let mut witness_lens = BTreeSet::new();
2143                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2144                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2145                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2146                 assert_eq!(witness_lens.len(), 3);
2147                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2148                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2149                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2150
2151                 // Next nodes[1] broadcasts its current local tx state:
2152                 assert_eq!(node_txn[1].input.len(), 1);
2153                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2154
2155                 assert_eq!(node_txn[2].input.len(), 1);
2156                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2157                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2158                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2159                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2160                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2161         }
2162         get_announce_close_broadcast_events(&nodes, 0, 1);
2163         assert_eq!(nodes[0].node.list_channels().len(), 0);
2164         assert_eq!(nodes[1].node.list_channels().len(), 0);
2165 }
2166
2167 #[test]
2168 fn claim_htlc_outputs_single_tx() {
2169         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2170         let node_cfgs = create_node_cfgs(2);
2171         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2172         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2173
2174         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2175
2176         // Rebalance the network to generate htlc in the two directions
2177         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2178         // 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
2179         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2180         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2181         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2182
2183         // Get the will-be-revoked local txn from node[0]
2184         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();
2185
2186         //Revoke the old state
2187         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2188
2189         {
2190                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2191                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2192                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2193                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2194
2195                 let events = nodes[1].node.get_and_clear_pending_events();
2196                 assert_eq!(events.len(), 1);
2197                 match events[0] {
2198                         Event::PaymentFailed { payment_hash, .. } => {
2199                                 assert_eq!(payment_hash, payment_hash_2);
2200                         },
2201                         _ => panic!("Unexpected event"),
2202                 }
2203
2204                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2205                 assert_eq!(node_txn.len(), 26);
2206                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2207                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2208                 // ChannelMonitor: bumped justice tx * 7 (7), after one increase, bumps on HTLC aren't generated not being substantial anymore
2209                 // ChannelMonitor: local commitment + local HTLC-timeout (14)
2210
2211
2212                 assert_eq!(node_txn[3], node_txn[5]);
2213                 assert_eq!(node_txn[3], node_txn[7]);
2214                 assert_eq!(node_txn[3], node_txn[9]);
2215                 assert_eq!(node_txn[3], node_txn[14]);
2216                 assert_eq!(node_txn[3], node_txn[17]);
2217                 assert_eq!(node_txn[3], node_txn[20]);
2218                 assert_eq!(node_txn[3], node_txn[23]);
2219
2220                 assert_eq!(node_txn[4], node_txn[6]);
2221                 assert_eq!(node_txn[4], node_txn[8]);
2222                 assert_eq!(node_txn[4], node_txn[10]);
2223                 assert_eq!(node_txn[4], node_txn[15]);
2224                 assert_eq!(node_txn[4], node_txn[18]);
2225                 assert_eq!(node_txn[4], node_txn[21]);
2226                 assert_eq!(node_txn[4], node_txn[24]);
2227
2228                 assert_eq!(node_txn[0].input.len(), 1);
2229                 assert_eq!(node_txn[1].input.len(), 1);
2230                 assert_eq!(node_txn[2].input.len(), 1);
2231
2232                 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2233                         if out_point.txid == tx.txid() {
2234                                 tx.output.get(out_point.vout as usize).cloned()
2235                         } else {
2236                                 None
2237                         }
2238                 }
2239                 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2240                 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2241                 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2242
2243                 let mut witness_lens = BTreeSet::new();
2244                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2245                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2246                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2247                 assert_eq!(witness_lens.len(), 3);
2248                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2249                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2250                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2251
2252                 assert_eq!(node_txn[3].input.len(), 1);
2253                 check_spends!(node_txn[3], chan_1.3.clone());
2254
2255                 assert_eq!(node_txn[4].input.len(), 1);
2256                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2257                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2258                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2259                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2260                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2261         }
2262         get_announce_close_broadcast_events(&nodes, 0, 1);
2263         assert_eq!(nodes[0].node.list_channels().len(), 0);
2264         assert_eq!(nodes[1].node.list_channels().len(), 0);
2265 }
2266
2267 #[test]
2268 fn test_htlc_on_chain_success() {
2269         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2270         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2271         // broadcasting the right event to other nodes in payment path.
2272         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2273         // A --------------------> B ----------------------> C (preimage)
2274         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2275         // commitment transaction was broadcast.
2276         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2277         // towards B.
2278         // B should be able to claim via preimage if A then broadcasts its local tx.
2279         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2280         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2281         // PaymentSent event).
2282
2283         let node_cfgs = create_node_cfgs(3);
2284         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2285         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2286
2287         // Create some initial channels
2288         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2289         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2290
2291         // Rebalance the network a bit by relaying one payment through all the channels...
2292         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2293         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2294
2295         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2296         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2297         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2298
2299         // Broadcast legit commitment tx from C on B's chain
2300         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2301         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();
2302         assert_eq!(commitment_tx.len(), 1);
2303         check_spends!(commitment_tx[0], chan_2.3.clone());
2304         nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2305         nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2306         check_added_monitors!(nodes[2], 2);
2307         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2308         assert!(updates.update_add_htlcs.is_empty());
2309         assert!(updates.update_fail_htlcs.is_empty());
2310         assert!(updates.update_fail_malformed_htlcs.is_empty());
2311         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2312
2313         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2314         check_closed_broadcast!(nodes[2], false);
2315         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)
2316         assert_eq!(node_txn.len(), 7);
2317         assert_eq!(node_txn[0], node_txn[3]);
2318         assert_eq!(node_txn[1], node_txn[4]);
2319         assert_eq!(node_txn[0], node_txn[5]);
2320         assert_eq!(node_txn[1], node_txn[6]);
2321         assert_eq!(node_txn[2], commitment_tx[0]);
2322         check_spends!(node_txn[0], commitment_tx[0].clone());
2323         check_spends!(node_txn[1], commitment_tx[0].clone());
2324         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2325         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2326         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2327         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2328         assert_eq!(node_txn[0].lock_time, 0);
2329         assert_eq!(node_txn[1].lock_time, 0);
2330
2331         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2332         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2333         let events = nodes[1].node.get_and_clear_pending_msg_events();
2334         {
2335                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2336                 assert_eq!(added_monitors.len(), 2);
2337                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2338                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2339                 added_monitors.clear();
2340         }
2341         assert_eq!(events.len(), 2);
2342         match events[0] {
2343                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2344                 _ => panic!("Unexpected event"),
2345         }
2346         match events[1] {
2347                 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, .. } } => {
2348                         assert!(update_add_htlcs.is_empty());
2349                         assert!(update_fail_htlcs.is_empty());
2350                         assert_eq!(update_fulfill_htlcs.len(), 1);
2351                         assert!(update_fail_malformed_htlcs.is_empty());
2352                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2353                 },
2354                 _ => panic!("Unexpected event"),
2355         };
2356         macro_rules! check_tx_local_broadcast {
2357                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2358                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2359                         assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2360                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2361                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2362                         check_spends!(node_txn[0], $commitment_tx.clone());
2363                         check_spends!(node_txn[1], $commitment_tx.clone());
2364                         if $htlc_offered {
2365                                 assert_eq!(node_txn[0], node_txn[5]);
2366                                 assert_eq!(node_txn[1], node_txn[6]);
2367                         }
2368                         assert_ne!(node_txn[0].lock_time, 0);
2369                         assert_ne!(node_txn[1].lock_time, 0);
2370                         if $htlc_offered {
2371                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2372                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2373                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2374                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2375                         } else {
2376                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2377                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2378                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2379                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2380                         }
2381                         check_spends!(node_txn[2], $chan_tx.clone());
2382                         check_spends!(node_txn[3], node_txn[2].clone());
2383                         check_spends!(node_txn[4], node_txn[2].clone());
2384                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2385                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2386                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2387                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2388                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2389                         assert_ne!(node_txn[3].lock_time, 0);
2390                         assert_ne!(node_txn[4].lock_time, 0);
2391                         node_txn.clear();
2392                 } }
2393         }
2394         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2395         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2396         // timeout-claim of the output that nodes[2] just claimed via success.
2397         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2398
2399         // Broadcast legit commitment tx from A on B's chain
2400         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2401         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();
2402         check_spends!(commitment_tx[0], chan_1.3.clone());
2403         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2404         check_closed_broadcast!(nodes[1], false);
2405         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2406         assert_eq!(node_txn.len(), 4);
2407         check_spends!(node_txn[0], commitment_tx[0].clone());
2408         assert_eq!(node_txn[0].input.len(), 2);
2409         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2410         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2411         assert_eq!(node_txn[0].lock_time, 0);
2412         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2413         check_spends!(node_txn[1], chan_1.3.clone());
2414         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2415         check_spends!(node_txn[2], node_txn[1]);
2416         check_spends!(node_txn[3], node_txn[1]);
2417         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2418         // we already checked the same situation with A.
2419
2420         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2421         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2422         check_closed_broadcast!(nodes[0], false);
2423         let events = nodes[0].node.get_and_clear_pending_events();
2424         assert_eq!(events.len(), 2);
2425         let mut first_claimed = false;
2426         for event in events {
2427                 match event {
2428                         Event::PaymentSent { payment_preimage } => {
2429                                 if payment_preimage == our_payment_preimage {
2430                                         assert!(!first_claimed);
2431                                         first_claimed = true;
2432                                 } else {
2433                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2434                                 }
2435                         },
2436                         _ => panic!("Unexpected event"),
2437                 }
2438         }
2439         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2440 }
2441
2442 #[test]
2443 fn test_htlc_on_chain_timeout() {
2444         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2445         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2446         // broadcasting the right event to other nodes in payment path.
2447         // A ------------------> B ----------------------> C (timeout)
2448         //    B's commitment tx                 C's commitment tx
2449         //            \                                  \
2450         //         B's HTLC timeout tx               B's timeout tx
2451
2452         let node_cfgs = create_node_cfgs(3);
2453         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2454         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2455
2456         // Create some intial channels
2457         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2458         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2459
2460         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2461         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2462         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2463
2464         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2465         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2466
2467         // Broadcast legit commitment tx from C on B's chain
2468         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();
2469         check_spends!(commitment_tx[0], chan_2.3.clone());
2470         nodes[2].node.fail_htlc_backwards(&payment_hash);
2471         check_added_monitors!(nodes[2], 0);
2472         expect_pending_htlcs_forwardable!(nodes[2]);
2473         check_added_monitors!(nodes[2], 1);
2474
2475         let events = nodes[2].node.get_and_clear_pending_msg_events();
2476         assert_eq!(events.len(), 1);
2477         match events[0] {
2478                 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, .. } } => {
2479                         assert!(update_add_htlcs.is_empty());
2480                         assert!(!update_fail_htlcs.is_empty());
2481                         assert!(update_fulfill_htlcs.is_empty());
2482                         assert!(update_fail_malformed_htlcs.is_empty());
2483                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2484                 },
2485                 _ => panic!("Unexpected event"),
2486         };
2487         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2488         check_closed_broadcast!(nodes[2], false);
2489         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2490         assert_eq!(node_txn.len(), 1);
2491         check_spends!(node_txn[0], chan_2.3.clone());
2492         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2493
2494         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2495         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2496         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2497         let timeout_tx;
2498         {
2499                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2500                 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2501                 assert_eq!(node_txn[1], node_txn[3]);
2502                 assert_eq!(node_txn[1], node_txn[5]);
2503                 assert_eq!(node_txn[2], node_txn[4]);
2504                 assert_eq!(node_txn[2], node_txn[6]);
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_2.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                 check_spends!(node_txn[3], chan_2.3.clone());
2512                 check_spends!(node_txn[4], node_txn[3].clone());
2513                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2514                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2515                 timeout_tx = node_txn[0].clone();
2516                 node_txn.clear();
2517         }
2518
2519         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2520         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2521         check_added_monitors!(nodes[1], 0);
2522         check_closed_broadcast!(nodes[1], false);
2523
2524         expect_pending_htlcs_forwardable!(nodes[1]);
2525         check_added_monitors!(nodes[1], 1);
2526         let events = nodes[1].node.get_and_clear_pending_msg_events();
2527         assert_eq!(events.len(), 1);
2528         match events[0] {
2529                 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, .. } } => {
2530                         assert!(update_add_htlcs.is_empty());
2531                         assert!(!update_fail_htlcs.is_empty());
2532                         assert!(update_fulfill_htlcs.is_empty());
2533                         assert!(update_fail_malformed_htlcs.is_empty());
2534                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2535                 },
2536                 _ => panic!("Unexpected event"),
2537         };
2538         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
2539         assert_eq!(node_txn.len(), 0);
2540
2541         // Broadcast legit commitment tx from B on A's chain
2542         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();
2543         check_spends!(commitment_tx[0], chan_1.3.clone());
2544
2545         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2546         check_closed_broadcast!(nodes[0], false);
2547         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2548         assert_eq!(node_txn.len(), 3);
2549         check_spends!(node_txn[0], commitment_tx[0].clone());
2550         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2551         check_spends!(node_txn[1], chan_1.3.clone());
2552         check_spends!(node_txn[2], node_txn[1].clone());
2553         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2554         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2555 }
2556
2557 #[test]
2558 fn test_simple_commitment_revoked_fail_backward() {
2559         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2560         // and fail backward accordingly.
2561
2562         let node_cfgs = create_node_cfgs(3);
2563         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2564         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2565
2566         // Create some initial channels
2567         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2568         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2569
2570         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2571         // Get the will-be-revoked local txn from nodes[2]
2572         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();
2573         // Revoke the old state
2574         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2575
2576         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2577
2578         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2579         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2580         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2581         check_added_monitors!(nodes[1], 0);
2582         check_closed_broadcast!(nodes[1], false);
2583
2584         expect_pending_htlcs_forwardable!(nodes[1]);
2585         check_added_monitors!(nodes[1], 1);
2586         let events = nodes[1].node.get_and_clear_pending_msg_events();
2587         assert_eq!(events.len(), 1);
2588         match events[0] {
2589                 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, .. } } => {
2590                         assert!(update_add_htlcs.is_empty());
2591                         assert_eq!(update_fail_htlcs.len(), 1);
2592                         assert!(update_fulfill_htlcs.is_empty());
2593                         assert!(update_fail_malformed_htlcs.is_empty());
2594                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2595
2596                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2597                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2598
2599                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2600                         assert_eq!(events.len(), 1);
2601                         match events[0] {
2602                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2603                                 _ => panic!("Unexpected event"),
2604                         }
2605                         let events = nodes[0].node.get_and_clear_pending_events();
2606                         assert_eq!(events.len(), 1);
2607                         match events[0] {
2608                                 Event::PaymentFailed { .. } => {},
2609                                 _ => panic!("Unexpected event"),
2610                         }
2611                 },
2612                 _ => panic!("Unexpected event"),
2613         }
2614 }
2615
2616 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2617         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2618         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2619         // commitment transaction anymore.
2620         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2621         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2622         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2623         // technically disallowed and we should probably handle it reasonably.
2624         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2625         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2626         // transactions:
2627         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2628         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2629         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2630         //   and once they revoke the previous commitment transaction (allowing us to send a new
2631         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2632         let node_cfgs = create_node_cfgs(3);
2633         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2634         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2635
2636         // Create some initial channels
2637         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2638         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2639
2640         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2641         // Get the will-be-revoked local txn from nodes[2]
2642         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();
2643         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2644         // Revoke the old state
2645         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2646
2647         let value = if use_dust {
2648                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2649                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2650                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2651         } else { 3000000 };
2652
2653         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2654         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2655         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2656
2657         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2658         expect_pending_htlcs_forwardable!(nodes[2]);
2659         check_added_monitors!(nodes[2], 1);
2660         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2661         assert!(updates.update_add_htlcs.is_empty());
2662         assert!(updates.update_fulfill_htlcs.is_empty());
2663         assert!(updates.update_fail_malformed_htlcs.is_empty());
2664         assert_eq!(updates.update_fail_htlcs.len(), 1);
2665         assert!(updates.update_fee.is_none());
2666         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2667         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2668         // Drop the last RAA from 3 -> 2
2669
2670         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2671         expect_pending_htlcs_forwardable!(nodes[2]);
2672         check_added_monitors!(nodes[2], 1);
2673         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2674         assert!(updates.update_add_htlcs.is_empty());
2675         assert!(updates.update_fulfill_htlcs.is_empty());
2676         assert!(updates.update_fail_malformed_htlcs.is_empty());
2677         assert_eq!(updates.update_fail_htlcs.len(), 1);
2678         assert!(updates.update_fee.is_none());
2679         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2680         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2681         check_added_monitors!(nodes[1], 1);
2682         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2683         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2684         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2685         check_added_monitors!(nodes[2], 1);
2686
2687         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2688         expect_pending_htlcs_forwardable!(nodes[2]);
2689         check_added_monitors!(nodes[2], 1);
2690         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2691         assert!(updates.update_add_htlcs.is_empty());
2692         assert!(updates.update_fulfill_htlcs.is_empty());
2693         assert!(updates.update_fail_malformed_htlcs.is_empty());
2694         assert_eq!(updates.update_fail_htlcs.len(), 1);
2695         assert!(updates.update_fee.is_none());
2696         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2697         // At this point first_payment_hash has dropped out of the latest two commitment
2698         // transactions that nodes[1] is tracking...
2699         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2700         check_added_monitors!(nodes[1], 1);
2701         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2702         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2703         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2704         check_added_monitors!(nodes[2], 1);
2705
2706         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2707         // on nodes[2]'s RAA.
2708         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2709         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2710         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2711         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2712         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2713         check_added_monitors!(nodes[1], 0);
2714
2715         if deliver_bs_raa {
2716                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2717                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2718                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2719                 check_added_monitors!(nodes[1], 1);
2720                 let events = nodes[1].node.get_and_clear_pending_events();
2721                 assert_eq!(events.len(), 1);
2722                 match events[0] {
2723                         Event::PendingHTLCsForwardable { .. } => { },
2724                         _ => panic!("Unexpected event"),
2725                 };
2726                 // Deliberately don't process the pending fail-back so they all fail back at once after
2727                 // block connection just like the !deliver_bs_raa case
2728         }
2729
2730         let mut failed_htlcs = HashSet::new();
2731         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2732
2733         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2734         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2735         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2736
2737         let events = nodes[1].node.get_and_clear_pending_events();
2738         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2739         match events[0] {
2740                 Event::PaymentFailed { ref payment_hash, .. } => {
2741                         assert_eq!(*payment_hash, fourth_payment_hash);
2742                 },
2743                 _ => panic!("Unexpected event"),
2744         }
2745         if !deliver_bs_raa {
2746                 match events[1] {
2747                         Event::PendingHTLCsForwardable { .. } => { },
2748                         _ => panic!("Unexpected event"),
2749                 };
2750         }
2751         nodes[1].node.process_pending_htlc_forwards();
2752         check_added_monitors!(nodes[1], 1);
2753
2754         let events = nodes[1].node.get_and_clear_pending_msg_events();
2755         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2756         match events[if deliver_bs_raa { 1 } else { 0 }] {
2757                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2758                 _ => panic!("Unexpected event"),
2759         }
2760         if deliver_bs_raa {
2761                 match events[0] {
2762                         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, .. } } => {
2763                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2764                                 assert_eq!(update_add_htlcs.len(), 1);
2765                                 assert!(update_fulfill_htlcs.is_empty());
2766                                 assert!(update_fail_htlcs.is_empty());
2767                                 assert!(update_fail_malformed_htlcs.is_empty());
2768                         },
2769                         _ => panic!("Unexpected event"),
2770                 }
2771         }
2772         match events[if deliver_bs_raa { 2 } else { 1 }] {
2773                 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, .. } } => {
2774                         assert!(update_add_htlcs.is_empty());
2775                         assert_eq!(update_fail_htlcs.len(), 3);
2776                         assert!(update_fulfill_htlcs.is_empty());
2777                         assert!(update_fail_malformed_htlcs.is_empty());
2778                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2779
2780                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2781                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2782                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2783
2784                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2785
2786                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2787                         // If we delivered B's RAA we got an unknown preimage error, not something
2788                         // that we should update our routing table for.
2789                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2790                         for event in events {
2791                                 match event {
2792                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2793                                         _ => panic!("Unexpected event"),
2794                                 }
2795                         }
2796                         let events = nodes[0].node.get_and_clear_pending_events();
2797                         assert_eq!(events.len(), 3);
2798                         match events[0] {
2799                                 Event::PaymentFailed { ref payment_hash, .. } => {
2800                                         assert!(failed_htlcs.insert(payment_hash.0));
2801                                 },
2802                                 _ => panic!("Unexpected event"),
2803                         }
2804                         match events[1] {
2805                                 Event::PaymentFailed { ref payment_hash, .. } => {
2806                                         assert!(failed_htlcs.insert(payment_hash.0));
2807                                 },
2808                                 _ => panic!("Unexpected event"),
2809                         }
2810                         match events[2] {
2811                                 Event::PaymentFailed { ref payment_hash, .. } => {
2812                                         assert!(failed_htlcs.insert(payment_hash.0));
2813                                 },
2814                                 _ => panic!("Unexpected event"),
2815                         }
2816                 },
2817                 _ => panic!("Unexpected event"),
2818         }
2819
2820         assert!(failed_htlcs.contains(&first_payment_hash.0));
2821         assert!(failed_htlcs.contains(&second_payment_hash.0));
2822         assert!(failed_htlcs.contains(&third_payment_hash.0));
2823 }
2824
2825 #[test]
2826 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2827         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2828         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2829         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2830         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2831 }
2832
2833 #[test]
2834 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2835         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2836         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2837         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2838         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2839 }
2840
2841 #[test]
2842 fn test_htlc_ignore_latest_remote_commitment() {
2843         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2844         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2845         let node_cfgs = create_node_cfgs(2);
2846         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2847         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2848         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2849
2850         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2851         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2852         check_closed_broadcast!(nodes[0], false);
2853
2854         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2855         assert_eq!(node_txn.len(), 2);
2856
2857         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2858         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2859         check_closed_broadcast!(nodes[1], false);
2860
2861         // Duplicate the block_connected call since this may happen due to other listeners
2862         // registering new transactions
2863         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2864 }
2865
2866 #[test]
2867 fn test_force_close_fail_back() {
2868         // Check which HTLCs are failed-backwards on channel force-closure
2869         let node_cfgs = create_node_cfgs(3);
2870         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2871         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2872         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2873         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2874
2875         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2876
2877         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2878
2879         let mut payment_event = {
2880                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2881                 check_added_monitors!(nodes[0], 1);
2882
2883                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2884                 assert_eq!(events.len(), 1);
2885                 SendEvent::from_event(events.remove(0))
2886         };
2887
2888         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2889         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2890
2891         expect_pending_htlcs_forwardable!(nodes[1]);
2892
2893         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2894         assert_eq!(events_2.len(), 1);
2895         payment_event = SendEvent::from_event(events_2.remove(0));
2896         assert_eq!(payment_event.msgs.len(), 1);
2897
2898         check_added_monitors!(nodes[1], 1);
2899         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2900         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2901         check_added_monitors!(nodes[2], 1);
2902         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2903
2904         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2905         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2906         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2907
2908         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2909         check_closed_broadcast!(nodes[2], false);
2910         let tx = {
2911                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2912                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2913                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2914                 // back to nodes[1] upon timeout otherwise.
2915                 assert_eq!(node_txn.len(), 1);
2916                 node_txn.remove(0)
2917         };
2918
2919         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2920         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2921
2922         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2923         check_closed_broadcast!(nodes[1], false);
2924
2925         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2926         {
2927                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2928                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2929                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2930         }
2931         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2932         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2933         assert_eq!(node_txn.len(), 1);
2934         assert_eq!(node_txn[0].input.len(), 1);
2935         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2936         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2937         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2938
2939         check_spends!(node_txn[0], tx);
2940 }
2941
2942 #[test]
2943 fn test_unconf_chan() {
2944         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2945         let node_cfgs = create_node_cfgs(2);
2946         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2947         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2948         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2949
2950         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2951         assert_eq!(channel_state.by_id.len(), 1);
2952         assert_eq!(channel_state.short_to_id.len(), 1);
2953         mem::drop(channel_state);
2954
2955         let mut headers = Vec::new();
2956         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2957         headers.push(header.clone());
2958         for _i in 2..100 {
2959                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2960                 headers.push(header.clone());
2961         }
2962         let mut height = 99;
2963         while !headers.is_empty() {
2964                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2965                 height -= 1;
2966         }
2967         check_closed_broadcast!(nodes[0], false);
2968         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2969         assert_eq!(channel_state.by_id.len(), 0);
2970         assert_eq!(channel_state.short_to_id.len(), 0);
2971 }
2972
2973 #[test]
2974 fn test_simple_peer_disconnect() {
2975         // Test that we can reconnect when there are no lost messages
2976         let node_cfgs = create_node_cfgs(3);
2977         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2978         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2979         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2980         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2981
2982         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2983         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2984         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2985
2986         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2987         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2988         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2989         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2990
2991         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2992         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2993         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2994
2995         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2996         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2997         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2998         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2999
3000         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3001         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3002
3003         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3004         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3005
3006         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3007         {
3008                 let events = nodes[0].node.get_and_clear_pending_events();
3009                 assert_eq!(events.len(), 2);
3010                 match events[0] {
3011                         Event::PaymentSent { payment_preimage } => {
3012                                 assert_eq!(payment_preimage, payment_preimage_3);
3013                         },
3014                         _ => panic!("Unexpected event"),
3015                 }
3016                 match events[1] {
3017                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3018                                 assert_eq!(payment_hash, payment_hash_5);
3019                                 assert!(rejected_by_dest);
3020                         },
3021                         _ => panic!("Unexpected event"),
3022                 }
3023         }
3024
3025         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3026         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3027 }
3028
3029 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3030         // Test that we can reconnect when in-flight HTLC updates get dropped
3031         let node_cfgs = create_node_cfgs(2);
3032         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3033         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3034         if messages_delivered == 0 {
3035                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3036                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3037         } else {
3038                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3039         }
3040
3041         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();
3042         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3043
3044         let payment_event = {
3045                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3046                 check_added_monitors!(nodes[0], 1);
3047
3048                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3049                 assert_eq!(events.len(), 1);
3050                 SendEvent::from_event(events.remove(0))
3051         };
3052         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3053
3054         if messages_delivered < 2 {
3055                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3056         } else {
3057                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3058                 if messages_delivered >= 3 {
3059                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3060                         check_added_monitors!(nodes[1], 1);
3061                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3062
3063                         if messages_delivered >= 4 {
3064                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3065                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3066                                 check_added_monitors!(nodes[0], 1);
3067
3068                                 if messages_delivered >= 5 {
3069                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3070                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3071                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3072                                         check_added_monitors!(nodes[0], 1);
3073
3074                                         if messages_delivered >= 6 {
3075                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3076                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3077                                                 check_added_monitors!(nodes[1], 1);
3078                                         }
3079                                 }
3080                         }
3081                 }
3082         }
3083
3084         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3085         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3086         if messages_delivered < 3 {
3087                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3088                 // received on either side, both sides will need to resend them.
3089                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3090         } else if messages_delivered == 3 {
3091                 // nodes[0] still wants its RAA + commitment_signed
3092                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3093         } else if messages_delivered == 4 {
3094                 // nodes[0] still wants its commitment_signed
3095                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3096         } else if messages_delivered == 5 {
3097                 // nodes[1] still wants its final RAA
3098                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3099         } else if messages_delivered == 6 {
3100                 // Everything was delivered...
3101                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3102         }
3103
3104         let events_1 = nodes[1].node.get_and_clear_pending_events();
3105         assert_eq!(events_1.len(), 1);
3106         match events_1[0] {
3107                 Event::PendingHTLCsForwardable { .. } => { },
3108                 _ => panic!("Unexpected event"),
3109         };
3110
3111         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3112         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3113         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3114
3115         nodes[1].node.process_pending_htlc_forwards();
3116
3117         let events_2 = nodes[1].node.get_and_clear_pending_events();
3118         assert_eq!(events_2.len(), 1);
3119         match events_2[0] {
3120                 Event::PaymentReceived { ref payment_hash, amt } => {
3121                         assert_eq!(payment_hash_1, *payment_hash);
3122                         assert_eq!(amt, 1000000);
3123                 },
3124                 _ => panic!("Unexpected event"),
3125         }
3126
3127         nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3128         check_added_monitors!(nodes[1], 1);
3129
3130         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3131         assert_eq!(events_3.len(), 1);
3132         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3133                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3134                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3135                         assert!(updates.update_add_htlcs.is_empty());
3136                         assert!(updates.update_fail_htlcs.is_empty());
3137                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3138                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3139                         assert!(updates.update_fee.is_none());
3140                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3141                 },
3142                 _ => panic!("Unexpected event"),
3143         };
3144
3145         if messages_delivered >= 1 {
3146                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3147
3148                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3149                 assert_eq!(events_4.len(), 1);
3150                 match events_4[0] {
3151                         Event::PaymentSent { ref payment_preimage } => {
3152                                 assert_eq!(payment_preimage_1, *payment_preimage);
3153                         },
3154                         _ => panic!("Unexpected event"),
3155                 }
3156
3157                 if messages_delivered >= 2 {
3158                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3159                         check_added_monitors!(nodes[0], 1);
3160                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3161
3162                         if messages_delivered >= 3 {
3163                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3164                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3165                                 check_added_monitors!(nodes[1], 1);
3166
3167                                 if messages_delivered >= 4 {
3168                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3169                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3170                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3171                                         check_added_monitors!(nodes[1], 1);
3172
3173                                         if messages_delivered >= 5 {
3174                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3175                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3176                                                 check_added_monitors!(nodes[0], 1);
3177                                         }
3178                                 }
3179                         }
3180                 }
3181         }
3182
3183         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3184         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3185         if messages_delivered < 2 {
3186                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3187                 //TODO: Deduplicate PaymentSent events, then enable this if:
3188                 //if messages_delivered < 1 {
3189                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3190                         assert_eq!(events_4.len(), 1);
3191                         match events_4[0] {
3192                                 Event::PaymentSent { ref payment_preimage } => {
3193                                         assert_eq!(payment_preimage_1, *payment_preimage);
3194                                 },
3195                                 _ => panic!("Unexpected event"),
3196                         }
3197                 //}
3198         } else if messages_delivered == 2 {
3199                 // nodes[0] still wants its RAA + commitment_signed
3200                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3201         } else if messages_delivered == 3 {
3202                 // nodes[0] still wants its commitment_signed
3203                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3204         } else if messages_delivered == 4 {
3205                 // nodes[1] still wants its final RAA
3206                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3207         } else if messages_delivered == 5 {
3208                 // Everything was delivered...
3209                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3210         }
3211
3212         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3213         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3214         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3215
3216         // Channel should still work fine...
3217         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3218         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3219 }
3220
3221 #[test]
3222 fn test_drop_messages_peer_disconnect_a() {
3223         do_test_drop_messages_peer_disconnect(0);
3224         do_test_drop_messages_peer_disconnect(1);
3225         do_test_drop_messages_peer_disconnect(2);
3226         do_test_drop_messages_peer_disconnect(3);
3227 }
3228
3229 #[test]
3230 fn test_drop_messages_peer_disconnect_b() {
3231         do_test_drop_messages_peer_disconnect(4);
3232         do_test_drop_messages_peer_disconnect(5);
3233         do_test_drop_messages_peer_disconnect(6);
3234 }
3235
3236 #[test]
3237 fn test_funding_peer_disconnect() {
3238         // Test that we can lock in our funding tx while disconnected
3239         let node_cfgs = create_node_cfgs(2);
3240         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3241         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3242         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3243
3244         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3245         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3246
3247         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3248         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3249         assert_eq!(events_1.len(), 1);
3250         match events_1[0] {
3251                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3252                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3253                 },
3254                 _ => panic!("Unexpected event"),
3255         }
3256
3257         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3258
3259         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3260         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3261
3262         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3263         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3264         assert_eq!(events_2.len(), 2);
3265         let funding_locked = match events_2[0] {
3266                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3267                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3268                         msg.clone()
3269                 },
3270                 _ => panic!("Unexpected event"),
3271         };
3272         let bs_announcement_sigs = match events_2[1] {
3273                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3274                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3275                         msg.clone()
3276                 },
3277                 _ => panic!("Unexpected event"),
3278         };
3279
3280         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3281
3282         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3283         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3284         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3285         assert_eq!(events_3.len(), 2);
3286         let as_announcement_sigs = match events_3[0] {
3287                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3288                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3289                         msg.clone()
3290                 },
3291                 _ => panic!("Unexpected event"),
3292         };
3293         let (as_announcement, as_update) = match events_3[1] {
3294                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3295                         (msg.clone(), update_msg.clone())
3296                 },
3297                 _ => panic!("Unexpected event"),
3298         };
3299
3300         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3301         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3302         assert_eq!(events_4.len(), 1);
3303         let (_, bs_update) = match events_4[0] {
3304                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3305                         (msg.clone(), update_msg.clone())
3306                 },
3307                 _ => panic!("Unexpected event"),
3308         };
3309
3310         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3311         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3312         nodes[0].router.handle_channel_update(&as_update).unwrap();
3313
3314         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3315         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3316         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3317 }
3318
3319 #[test]
3320 fn test_drop_messages_peer_disconnect_dual_htlc() {
3321         // Test that we can handle reconnecting when both sides of a channel have pending
3322         // commitment_updates when we disconnect.
3323         let node_cfgs = create_node_cfgs(2);
3324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3325         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3326         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3327
3328         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3329
3330         // Now try to send a second payment which will fail to send
3331         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3332         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3333
3334         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3335         check_added_monitors!(nodes[0], 1);
3336
3337         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3338         assert_eq!(events_1.len(), 1);
3339         match events_1[0] {
3340                 MessageSendEvent::UpdateHTLCs { .. } => {},
3341                 _ => panic!("Unexpected event"),
3342         }
3343
3344         assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3345         check_added_monitors!(nodes[1], 1);
3346
3347         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3348         assert_eq!(events_2.len(), 1);
3349         match events_2[0] {
3350                 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 } } => {
3351                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3352                         assert!(update_add_htlcs.is_empty());
3353                         assert_eq!(update_fulfill_htlcs.len(), 1);
3354                         assert!(update_fail_htlcs.is_empty());
3355                         assert!(update_fail_malformed_htlcs.is_empty());
3356                         assert!(update_fee.is_none());
3357
3358                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3359                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3360                         assert_eq!(events_3.len(), 1);
3361                         match events_3[0] {
3362                                 Event::PaymentSent { ref payment_preimage } => {
3363                                         assert_eq!(*payment_preimage, payment_preimage_1);
3364                                 },
3365                                 _ => panic!("Unexpected event"),
3366                         }
3367
3368                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3369                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3370                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3371                         check_added_monitors!(nodes[0], 1);
3372                 },
3373                 _ => panic!("Unexpected event"),
3374         }
3375
3376         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3377         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3378
3379         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3380         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3381         assert_eq!(reestablish_1.len(), 1);
3382         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3383         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3384         assert_eq!(reestablish_2.len(), 1);
3385
3386         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3387         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3388         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3389         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3390
3391         assert!(as_resp.0.is_none());
3392         assert!(bs_resp.0.is_none());
3393
3394         assert!(bs_resp.1.is_none());
3395         assert!(bs_resp.2.is_none());
3396
3397         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3398
3399         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3400         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3401         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3402         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3403         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3404         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3405         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3406         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3407         // No commitment_signed so get_event_msg's assert(len == 1) passes
3408         check_added_monitors!(nodes[1], 1);
3409
3410         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3411         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3412         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3413         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3414         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3415         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3416         assert!(bs_second_commitment_signed.update_fee.is_none());
3417         check_added_monitors!(nodes[1], 1);
3418
3419         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3420         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3421         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3422         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3423         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3424         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3425         assert!(as_commitment_signed.update_fee.is_none());
3426         check_added_monitors!(nodes[0], 1);
3427
3428         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3429         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3430         // No commitment_signed so get_event_msg's assert(len == 1) passes
3431         check_added_monitors!(nodes[0], 1);
3432
3433         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3434         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3435         // No commitment_signed so get_event_msg's assert(len == 1) passes
3436         check_added_monitors!(nodes[1], 1);
3437
3438         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3439         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3440         check_added_monitors!(nodes[1], 1);
3441
3442         expect_pending_htlcs_forwardable!(nodes[1]);
3443
3444         let events_5 = nodes[1].node.get_and_clear_pending_events();
3445         assert_eq!(events_5.len(), 1);
3446         match events_5[0] {
3447                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3448                         assert_eq!(payment_hash_2, *payment_hash);
3449                 },
3450                 _ => panic!("Unexpected event"),
3451         }
3452
3453         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3454         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3455         check_added_monitors!(nodes[0], 1);
3456
3457         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
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 = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3478         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
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<EnforcingChannelKeys>)>::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<EnforcingChannelKeys>)>::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<EnforcingChannelKeys>)>::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, 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: preimage tx
3967         assert_eq!(node_txn.len(), 3);
3968         check_spends!(node_txn[0], commitment_tx[0].clone());
3969         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3970 eprintln!("{:?}", node_txn[1]);
3971         check_spends!(node_txn[1], chan_1.3.clone());
3972         check_spends!(node_txn[2], node_txn[1]);
3973
3974         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3975         assert_eq!(spend_txn.len(), 2);
3976         assert_eq!(spend_txn[0], spend_txn[1]);
3977         check_spends!(spend_txn[0], node_txn[0].clone());
3978 }
3979
3980 #[test]
3981 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3982         let node_cfgs = create_node_cfgs(2);
3983         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3984         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3985
3986         // Create some initial channels
3987         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3988
3989         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3990         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();
3991         assert_eq!(revoked_local_txn[0].input.len(), 1);
3992         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3993
3994         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3995
3996         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3997         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3998         check_closed_broadcast!(nodes[1], false);
3999
4000         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4001         assert_eq!(node_txn.len(), 2);
4002         assert_eq!(node_txn[0].input.len(), 2);
4003         check_spends!(node_txn[0], revoked_local_txn[0].clone());
4004
4005         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4006         assert_eq!(spend_txn.len(), 2);
4007         assert_eq!(spend_txn[0], spend_txn[1]);
4008         check_spends!(spend_txn[0], node_txn[0].clone());
4009 }
4010
4011 #[test]
4012 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4013         let node_cfgs = create_node_cfgs(2);
4014         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4015         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4016
4017         // Create some initial channels
4018         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4019
4020         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4021         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();
4022         assert_eq!(revoked_local_txn[0].input.len(), 1);
4023         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4024
4025         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4026
4027         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4028         // A will generate HTLC-Timeout from revoked commitment tx
4029         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4030         check_closed_broadcast!(nodes[0], false);
4031
4032         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4033         assert_eq!(revoked_htlc_txn.len(), 3);
4034         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4035         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4036         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4037         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4038         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
4039
4040         // B will generate justice tx from A's revoked commitment/HTLC tx
4041         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4042         check_closed_broadcast!(nodes[1], false);
4043
4044         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4045         assert_eq!(node_txn.len(), 4 ); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4046         assert_eq!(node_txn[2].input.len(), 1);
4047         check_spends!(node_txn[2], revoked_htlc_txn[0].clone());
4048
4049         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4050         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4051         assert_eq!(spend_txn.len(), 3);
4052         assert_eq!(spend_txn[0], spend_txn[1]);
4053         check_spends!(spend_txn[0], node_txn[0].clone());
4054         check_spends!(spend_txn[2], node_txn[2].clone());
4055 }
4056
4057 #[test]
4058 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4059         let node_cfgs = create_node_cfgs(2);
4060         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4061         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4062
4063         // Create some initial channels
4064         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4065
4066         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4067         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();
4068         assert_eq!(revoked_local_txn[0].input.len(), 1);
4069         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4070
4071         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4072
4073         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4074         // B will generate HTLC-Success from revoked commitment tx
4075         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4076         check_closed_broadcast!(nodes[1], false);
4077         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4078
4079         assert_eq!(revoked_htlc_txn.len(), 3);
4080         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4081         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4082         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4083         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4084
4085         // A will generate justice tx from B's revoked commitment/HTLC tx
4086         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4087         check_closed_broadcast!(nodes[0], false);
4088
4089         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4090         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4091         assert_eq!(node_txn[2].input.len(), 1);
4092         check_spends!(node_txn[2], revoked_htlc_txn[0].clone());
4093
4094         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4095         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4096         assert_eq!(spend_txn.len(), 5);
4097         assert_eq!(spend_txn[0], spend_txn[2]);
4098         assert_eq!(spend_txn[1], spend_txn[3]);
4099         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4100         check_spends!(spend_txn[1], node_txn[0].clone()); // spending justice tx output from revoked local tx htlc received output
4101         check_spends!(spend_txn[4], node_txn[2].clone()); // spending justice tx output on htlc success tx
4102 }
4103
4104 #[test]
4105 fn test_onchain_to_onchain_claim() {
4106         // Test that in case of channel closure, we detect the state of output thanks to
4107         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4108         // First, have C claim an HTLC against its own latest commitment transaction.
4109         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4110         // channel.
4111         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4112         // gets broadcast.
4113
4114         let node_cfgs = create_node_cfgs(3);
4115         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4116         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4117
4118         // Create some initial channels
4119         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4120         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4121
4122         // Rebalance the network a bit by relaying one payment through all the channels ...
4123         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4124         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4125
4126         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4127         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4128         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();
4129         check_spends!(commitment_tx[0], chan_2.3.clone());
4130         nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4131         check_added_monitors!(nodes[2], 1);
4132         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4133         assert!(updates.update_add_htlcs.is_empty());
4134         assert!(updates.update_fail_htlcs.is_empty());
4135         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4136         assert!(updates.update_fail_malformed_htlcs.is_empty());
4137
4138         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4139         check_closed_broadcast!(nodes[2], false);
4140
4141         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4142         assert_eq!(c_txn.len(), 4);
4143         assert_eq!(c_txn[0], c_txn[2]);
4144         assert_eq!(c_txn[0], c_txn[3]);
4145         assert_eq!(commitment_tx[0], c_txn[1]);
4146         check_spends!(c_txn[1], chan_2.3.clone());
4147         check_spends!(c_txn[2], c_txn[1].clone());
4148         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4149         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4150         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4151         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4152
4153         // 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
4154         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4155         {
4156                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4157                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4158                 assert_eq!(b_txn.len(), 3);
4159                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4160                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4161                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4162                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4163                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4164                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4165                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4166                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4167                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4168                 b_txn.clear();
4169         }
4170         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4171         check_added_monitors!(nodes[1], 1);
4172         match msg_events[0] {
4173                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4174                 _ => panic!("Unexpected event"),
4175         }
4176         match msg_events[1] {
4177                 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, .. } } => {
4178                         assert!(update_add_htlcs.is_empty());
4179                         assert!(update_fail_htlcs.is_empty());
4180                         assert_eq!(update_fulfill_htlcs.len(), 1);
4181                         assert!(update_fail_malformed_htlcs.is_empty());
4182                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4183                 },
4184                 _ => panic!("Unexpected event"),
4185         };
4186         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4187         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();
4188         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4189         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4190         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4191         assert_eq!(b_txn.len(), 3);
4192         check_spends!(b_txn[1], chan_1.3);
4193         check_spends!(b_txn[2], b_txn[1].clone());
4194         check_spends!(b_txn[0], commitment_tx[0].clone());
4195         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4196         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4197         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4198
4199         check_closed_broadcast!(nodes[1], false);
4200 }
4201
4202 #[test]
4203 fn test_duplicate_payment_hash_one_failure_one_success() {
4204         // Topology : A --> B --> C
4205         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4206         let node_cfgs = create_node_cfgs(3);
4207         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4208         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4209
4210         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4211         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4212
4213         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4214         *nodes[0].network_payment_count.borrow_mut() -= 1;
4215         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4216
4217         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();
4218         assert_eq!(commitment_txn[0].input.len(), 1);
4219         check_spends!(commitment_txn[0], chan_2.3.clone());
4220
4221         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4222         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4223         check_closed_broadcast!(nodes[1], false);
4224
4225         let htlc_timeout_tx;
4226         { // Extract one of the two HTLC-Timeout transaction
4227                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4228                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4229                 assert_eq!(node_txn.len(), 5);
4230                 check_spends!(node_txn[0], commitment_txn[0].clone());
4231                 assert_eq!(node_txn[0].input.len(), 1);
4232                 check_spends!(node_txn[1], commitment_txn[0].clone());
4233                 assert_eq!(node_txn[1].input.len(), 1);
4234                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4235                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4236                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4237                 check_spends!(node_txn[2], chan_2.3.clone());
4238                 check_spends!(node_txn[3], node_txn[2].clone());
4239                 check_spends!(node_txn[4], node_txn[2].clone());
4240                 htlc_timeout_tx = node_txn[1].clone();
4241         }
4242
4243         nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4244         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4245         check_added_monitors!(nodes[2], 2);
4246         let events = nodes[2].node.get_and_clear_pending_msg_events();
4247         match events[0] {
4248                 MessageSendEvent::UpdateHTLCs { .. } => {},
4249                 _ => panic!("Unexpected event"),
4250         }
4251         match events[1] {
4252                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4253                 _ => panic!("Unexepected event"),
4254         }
4255         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4256         assert_eq!(htlc_success_txn.len(), 7);
4257         check_spends!(htlc_success_txn[2], chan_2.3.clone());
4258         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4259         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4260         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4261         assert_eq!(htlc_success_txn[0].input.len(), 1);
4262         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4263         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4264         assert_eq!(htlc_success_txn[1].input.len(), 1);
4265         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4266         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4267         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4268         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4269
4270         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4271         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4272         expect_pending_htlcs_forwardable!(nodes[1]);
4273         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4274         assert!(htlc_updates.update_add_htlcs.is_empty());
4275         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4276         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4277         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4278         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4279         check_added_monitors!(nodes[1], 1);
4280
4281         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4282         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4283         {
4284                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4285                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4286                 assert_eq!(events.len(), 1);
4287                 match events[0] {
4288                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4289                         },
4290                         _ => { panic!("Unexpected event"); }
4291                 }
4292         }
4293         let events = nodes[0].node.get_and_clear_pending_events();
4294         match events[0] {
4295                 Event::PaymentFailed { ref payment_hash, .. } => {
4296                         assert_eq!(*payment_hash, duplicate_payment_hash);
4297                 }
4298                 _ => panic!("Unexpected event"),
4299         }
4300
4301         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4302         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4303         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4304         assert!(updates.update_add_htlcs.is_empty());
4305         assert!(updates.update_fail_htlcs.is_empty());
4306         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4307         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4308         assert!(updates.update_fail_malformed_htlcs.is_empty());
4309         check_added_monitors!(nodes[1], 1);
4310
4311         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4312         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4313
4314         let events = nodes[0].node.get_and_clear_pending_events();
4315         match events[0] {
4316                 Event::PaymentSent { ref payment_preimage } => {
4317                         assert_eq!(*payment_preimage, our_payment_preimage);
4318                 }
4319                 _ => panic!("Unexpected event"),
4320         }
4321 }
4322
4323 #[test]
4324 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4325         let node_cfgs = create_node_cfgs(2);
4326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4327         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4328
4329         // Create some initial channels
4330         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4331
4332         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4333         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();
4334         assert_eq!(local_txn[0].input.len(), 1);
4335         check_spends!(local_txn[0], chan_1.3.clone());
4336
4337         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4338         nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4339         check_added_monitors!(nodes[1], 1);
4340         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4341         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4342         let events = nodes[1].node.get_and_clear_pending_msg_events();
4343         match events[0] {
4344                 MessageSendEvent::UpdateHTLCs { .. } => {},
4345                 _ => panic!("Unexpected event"),
4346         }
4347         match events[1] {
4348                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4349                 _ => panic!("Unexepected event"),
4350         }
4351         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4352         assert_eq!(node_txn[0].input.len(), 1);
4353         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4354         check_spends!(node_txn[0], local_txn[0].clone());
4355
4356         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4357         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4358         assert_eq!(spend_txn.len(), 2);
4359         check_spends!(spend_txn[0], node_txn[0].clone());
4360         check_spends!(spend_txn[1], node_txn[2].clone());
4361 }
4362
4363 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4364         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4365         // unrevoked commitment transaction.
4366         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4367         // a remote RAA before they could be failed backwards (and combinations thereof).
4368         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4369         // use the same payment hashes.
4370         // Thus, we use a six-node network:
4371         //
4372         // A \         / E
4373         //    - C - D -
4374         // B /         \ F
4375         // And test where C fails back to A/B when D announces its latest commitment transaction
4376         let node_cfgs = create_node_cfgs(6);
4377         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4378         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4379
4380         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4381         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4382         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4383         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4384         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4385
4386         // Rebalance and check output sanity...
4387         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4388         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4389         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);
4390
4391         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4392         // 0th HTLC:
4393         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
4394         // 1st HTLC:
4395         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
4396         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();
4397         // 2nd HTLC:
4398         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
4399         // 3rd HTLC:
4400         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
4401         // 4th HTLC:
4402         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4403         // 5th HTLC:
4404         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4405         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4406         // 6th HTLC:
4407         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4408         // 7th HTLC:
4409         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4410
4411         // 8th HTLC:
4412         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4413         // 9th HTLC:
4414         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();
4415         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
4416
4417         // 10th HTLC:
4418         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
4419         // 11th HTLC:
4420         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4421         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4422
4423         // Double-check that six of the new HTLC were added
4424         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4425         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4426         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);
4427         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);
4428
4429         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4430         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4431         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4432         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4433         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4434         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4435         check_added_monitors!(nodes[4], 0);
4436         expect_pending_htlcs_forwardable!(nodes[4]);
4437         check_added_monitors!(nodes[4], 1);
4438
4439         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4440         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4441         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4442         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4443         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4444         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4445
4446         // Fail 3rd below-dust and 7th above-dust HTLCs
4447         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4448         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4449         check_added_monitors!(nodes[5], 0);
4450         expect_pending_htlcs_forwardable!(nodes[5]);
4451         check_added_monitors!(nodes[5], 1);
4452
4453         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4454         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4455         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4456         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4457
4458         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();
4459
4460         expect_pending_htlcs_forwardable!(nodes[3]);
4461         check_added_monitors!(nodes[3], 1);
4462         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4463         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4464         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4465         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4466         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4467         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4468         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4469         if deliver_last_raa {
4470                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4471         } else {
4472                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4473         }
4474
4475         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4476         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4477         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4478         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4479         //
4480         // We now broadcast the latest commitment transaction, which *should* result in failures for
4481         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4482         // the non-broadcast above-dust HTLCs.
4483         //
4484         // Alternatively, we may broadcast the previous commitment transaction, which should only
4485         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4486         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();
4487
4488         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4489         if announce_latest {
4490                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4491         } else {
4492                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4493         }
4494         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4495         check_closed_broadcast!(nodes[2], false);
4496         expect_pending_htlcs_forwardable!(nodes[2]);
4497         check_added_monitors!(nodes[2], 2);
4498
4499         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4500         assert_eq!(cs_msgs.len(), 2);
4501         let mut a_done = false;
4502         for msg in cs_msgs {
4503                 match msg {
4504                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4505                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4506                                 // should be failed-backwards here.
4507                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4508                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4509                                         for htlc in &updates.update_fail_htlcs {
4510                                                 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 });
4511                                         }
4512                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4513                                         assert!(!a_done);
4514                                         a_done = true;
4515                                         &nodes[0]
4516                                 } else {
4517                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4518                                         for htlc in &updates.update_fail_htlcs {
4519                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4520                                         }
4521                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4522                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4523                                         &nodes[1]
4524                                 };
4525                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4526                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4527                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4528                                 if announce_latest {
4529                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4530                                         if *node_id == nodes[0].node.get_our_node_id() {
4531                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4532                                         }
4533                                 }
4534                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4535                         },
4536                         _ => panic!("Unexpected event"),
4537                 }
4538         }
4539
4540         let as_events = nodes[0].node.get_and_clear_pending_events();
4541         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4542         let mut as_failds = HashSet::new();
4543         for event in as_events.iter() {
4544                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4545                         assert!(as_failds.insert(*payment_hash));
4546                         if *payment_hash != payment_hash_2 {
4547                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4548                         } else {
4549                                 assert!(!rejected_by_dest);
4550                         }
4551                 } else { panic!("Unexpected event"); }
4552         }
4553         assert!(as_failds.contains(&payment_hash_1));
4554         assert!(as_failds.contains(&payment_hash_2));
4555         if announce_latest {
4556                 assert!(as_failds.contains(&payment_hash_3));
4557                 assert!(as_failds.contains(&payment_hash_5));
4558         }
4559         assert!(as_failds.contains(&payment_hash_6));
4560
4561         let bs_events = nodes[1].node.get_and_clear_pending_events();
4562         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4563         let mut bs_failds = HashSet::new();
4564         for event in bs_events.iter() {
4565                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4566                         assert!(bs_failds.insert(*payment_hash));
4567                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4568                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4569                         } else {
4570                                 assert!(!rejected_by_dest);
4571                         }
4572                 } else { panic!("Unexpected event"); }
4573         }
4574         assert!(bs_failds.contains(&payment_hash_1));
4575         assert!(bs_failds.contains(&payment_hash_2));
4576         if announce_latest {
4577                 assert!(bs_failds.contains(&payment_hash_4));
4578         }
4579         assert!(bs_failds.contains(&payment_hash_5));
4580
4581         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4582         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4583         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4584         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4585         // PaymentFailureNetworkUpdates.
4586         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4587         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4588         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4589         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4590         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4591                 match event {
4592                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4593                         _ => panic!("Unexpected event"),
4594                 }
4595         }
4596 }
4597
4598 #[test]
4599 fn test_fail_backwards_latest_remote_announce_a() {
4600         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4601 }
4602
4603 #[test]
4604 fn test_fail_backwards_latest_remote_announce_b() {
4605         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4606 }
4607
4608 #[test]
4609 fn test_fail_backwards_previous_remote_announce() {
4610         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4611         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4612         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4613 }
4614
4615 #[test]
4616 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4617         let node_cfgs = create_node_cfgs(2);
4618         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4619         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4620
4621         // Create some initial channels
4622         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4623
4624         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4625         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();
4626         assert_eq!(local_txn[0].input.len(), 1);
4627         check_spends!(local_txn[0], chan_1.3.clone());
4628
4629         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4630         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4631         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4632         check_closed_broadcast!(nodes[0], false);
4633
4634         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4635         assert_eq!(node_txn[0].input.len(), 1);
4636         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4637         check_spends!(node_txn[0], local_txn[0].clone());
4638
4639         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4640         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4641         assert_eq!(spend_txn.len(), 8);
4642         assert_eq!(spend_txn[0], spend_txn[2]);
4643         assert_eq!(spend_txn[0], spend_txn[4]);
4644         assert_eq!(spend_txn[0], spend_txn[6]);
4645         assert_eq!(spend_txn[1], spend_txn[3]);
4646         assert_eq!(spend_txn[1], spend_txn[5]);
4647         assert_eq!(spend_txn[1], spend_txn[7]);
4648         check_spends!(spend_txn[0], local_txn[0].clone());
4649         check_spends!(spend_txn[1], node_txn[0].clone());
4650 }
4651
4652 #[test]
4653 fn test_static_output_closing_tx() {
4654         let node_cfgs = create_node_cfgs(2);
4655         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4656         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4657
4658         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4659
4660         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4661         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4662
4663         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4664         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4665         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4666         assert_eq!(spend_txn.len(), 1);
4667         check_spends!(spend_txn[0], closing_tx.clone());
4668
4669         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4670         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4671         assert_eq!(spend_txn.len(), 1);
4672         check_spends!(spend_txn[0], closing_tx);
4673 }
4674
4675 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4676         let node_cfgs = create_node_cfgs(2);
4677         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4678         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4679         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4680
4681         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4682
4683         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4684         // present in B's local commitment transaction, but none of A's commitment transactions.
4685         assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4686         check_added_monitors!(nodes[1], 1);
4687
4688         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4689         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4690         let events = nodes[0].node.get_and_clear_pending_events();
4691         assert_eq!(events.len(), 1);
4692         match events[0] {
4693                 Event::PaymentSent { payment_preimage } => {
4694                         assert_eq!(payment_preimage, our_payment_preimage);
4695                 },
4696                 _ => panic!("Unexpected event"),
4697         }
4698
4699         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4700         check_added_monitors!(nodes[0], 1);
4701         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4702         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4703         check_added_monitors!(nodes[1], 1);
4704
4705         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4706         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4707                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4708                 header.prev_blockhash = header.bitcoin_hash();
4709         }
4710         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4711         check_closed_broadcast!(nodes[1], false);
4712 }
4713
4714 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4715         let node_cfgs = create_node_cfgs(2);
4716         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4717         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4718         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4719
4720         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();
4721         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4722         nodes[0].node.send_payment(route, payment_hash).unwrap();
4723         check_added_monitors!(nodes[0], 1);
4724
4725         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4726
4727         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4728         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4729         // to "time out" the HTLC.
4730
4731         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4732
4733         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4734                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4735                 header.prev_blockhash = header.bitcoin_hash();
4736         }
4737         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4738         check_closed_broadcast!(nodes[0], false);
4739 }
4740
4741 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4742         let node_cfgs = create_node_cfgs(3);
4743         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4744         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4745         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4746
4747         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4748         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4749         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4750         // actually revoked.
4751         let htlc_value = if use_dust { 50000 } else { 3000000 };
4752         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4753         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4754         expect_pending_htlcs_forwardable!(nodes[1]);
4755         check_added_monitors!(nodes[1], 1);
4756
4757         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4758         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4759         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4760         check_added_monitors!(nodes[0], 1);
4761         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4762         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4763         check_added_monitors!(nodes[1], 1);
4764         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4765         check_added_monitors!(nodes[1], 1);
4766         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4767
4768         if check_revoke_no_close {
4769                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4770                 check_added_monitors!(nodes[0], 1);
4771         }
4772
4773         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4774         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4775                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4776                 header.prev_blockhash = header.bitcoin_hash();
4777         }
4778         if !check_revoke_no_close {
4779                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4780                 check_closed_broadcast!(nodes[0], false);
4781         } else {
4782                 let events = nodes[0].node.get_and_clear_pending_events();
4783                 assert_eq!(events.len(), 1);
4784                 match events[0] {
4785                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4786                                 assert_eq!(payment_hash, our_payment_hash);
4787                                 assert!(rejected_by_dest);
4788                         },
4789                         _ => panic!("Unexpected event"),
4790                 }
4791         }
4792 }
4793
4794 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4795 // There are only a few cases to test here:
4796 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4797 //    broadcastable commitment transactions result in channel closure,
4798 //  * its included in an unrevoked-but-previous remote commitment transaction,
4799 //  * its included in the latest remote or local commitment transactions.
4800 // We test each of the three possible commitment transactions individually and use both dust and
4801 // non-dust HTLCs.
4802 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4803 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4804 // tested for at least one of the cases in other tests.
4805 #[test]
4806 fn htlc_claim_single_commitment_only_a() {
4807         do_htlc_claim_local_commitment_only(true);
4808         do_htlc_claim_local_commitment_only(false);
4809
4810         do_htlc_claim_current_remote_commitment_only(true);
4811         do_htlc_claim_current_remote_commitment_only(false);
4812 }
4813
4814 #[test]
4815 fn htlc_claim_single_commitment_only_b() {
4816         do_htlc_claim_previous_remote_commitment_only(true, false);
4817         do_htlc_claim_previous_remote_commitment_only(false, false);
4818         do_htlc_claim_previous_remote_commitment_only(true, true);
4819         do_htlc_claim_previous_remote_commitment_only(false, true);
4820 }
4821
4822 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>)
4823         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4824                                 F2: FnMut(),
4825 {
4826         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);
4827 }
4828
4829 // test_case
4830 // 0: node1 fails backward
4831 // 1: final node fails backward
4832 // 2: payment completed but the user rejects the payment
4833 // 3: final node fails backward (but tamper onion payloads from node0)
4834 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4835 // 200: trigger error in the final node and tamper returning fail_htlc
4836 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>)
4837         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4838                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4839                                 F3: FnMut(),
4840 {
4841
4842         // reset block height
4843         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4844         for ix in 0..nodes.len() {
4845                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4846         }
4847
4848         macro_rules! expect_event {
4849                 ($node: expr, $event_type: path) => {{
4850                         let events = $node.node.get_and_clear_pending_events();
4851                         assert_eq!(events.len(), 1);
4852                         match events[0] {
4853                                 $event_type { .. } => {},
4854                                 _ => panic!("Unexpected event"),
4855                         }
4856                 }}
4857         }
4858
4859         macro_rules! expect_htlc_forward {
4860                 ($node: expr) => {{
4861                         expect_event!($node, Event::PendingHTLCsForwardable);
4862                         $node.node.process_pending_htlc_forwards();
4863                 }}
4864         }
4865
4866         // 0 ~~> 2 send payment
4867         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4868         check_added_monitors!(nodes[0], 1);
4869         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4870         // temper update_add (0 => 1)
4871         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4872         if test_case == 0 || test_case == 3 || test_case == 100 {
4873                 callback_msg(&mut update_add_0);
4874                 callback_node();
4875         }
4876         // 0 => 1 update_add & CS
4877         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4878         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4879
4880         let update_1_0 = match test_case {
4881                 0|100 => { // intermediate node failure; fail backward to 0
4882                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4883                         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));
4884                         update_1_0
4885                 },
4886                 1|2|3|200 => { // final node failure; forwarding to 2
4887                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4888                         // forwarding on 1
4889                         if test_case != 200 {
4890                                 callback_node();
4891                         }
4892                         expect_htlc_forward!(&nodes[1]);
4893
4894                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4895                         check_added_monitors!(&nodes[1], 1);
4896                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4897                         // tamper update_add (1 => 2)
4898                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4899                         if test_case != 3 && test_case != 200 {
4900                                 callback_msg(&mut update_add_1);
4901                         }
4902
4903                         // 1 => 2
4904                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4905                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4906
4907                         if test_case == 2 || test_case == 200 {
4908                                 expect_htlc_forward!(&nodes[2]);
4909                                 expect_event!(&nodes[2], Event::PaymentReceived);
4910                                 callback_node();
4911                                 expect_pending_htlcs_forwardable!(nodes[2]);
4912                         }
4913
4914                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4915                         if test_case == 2 || test_case == 200 {
4916                                 check_added_monitors!(&nodes[2], 1);
4917                         }
4918                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4919
4920                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4921                         if test_case == 200 {
4922                                 callback_fail(&mut fail_msg);
4923                         }
4924
4925                         // 2 => 1
4926                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4927                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4928
4929                         // backward fail on 1
4930                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4931                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4932                         update_1_0
4933                 },
4934                 _ => unreachable!(),
4935         };
4936
4937         // 1 => 0 commitment_signed_dance
4938         if update_1_0.update_fail_htlcs.len() > 0 {
4939                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4940                 if test_case == 100 {
4941                         callback_fail(&mut fail_msg);
4942                 }
4943                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4944         } else {
4945                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4946         };
4947
4948         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4949
4950         let events = nodes[0].node.get_and_clear_pending_events();
4951         assert_eq!(events.len(), 1);
4952         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4953                 assert_eq!(*rejected_by_dest, !expected_retryable);
4954                 assert_eq!(*error_code, expected_error_code);
4955         } else {
4956                 panic!("Uexpected event");
4957         }
4958
4959         let events = nodes[0].node.get_and_clear_pending_msg_events();
4960         if expected_channel_update.is_some() {
4961                 assert_eq!(events.len(), 1);
4962                 match events[0] {
4963                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4964                                 match update {
4965                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4966                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4967                                                         panic!("channel_update not found!");
4968                                                 }
4969                                         },
4970                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4971                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4972                                                         assert!(*short_channel_id == *expected_short_channel_id);
4973                                                         assert!(*is_permanent == *expected_is_permanent);
4974                                                 } else {
4975                                                         panic!("Unexpected message event");
4976                                                 }
4977                                         },
4978                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4979                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4980                                                         assert!(*node_id == *expected_node_id);
4981                                                         assert!(*is_permanent == *expected_is_permanent);
4982                                                 } else {
4983                                                         panic!("Unexpected message event");
4984                                                 }
4985                                         },
4986                                 }
4987                         },
4988                         _ => panic!("Unexpected message event"),
4989                 }
4990         } else {
4991                 assert_eq!(events.len(), 0);
4992         }
4993 }
4994
4995 impl msgs::ChannelUpdate {
4996         fn dummy() -> msgs::ChannelUpdate {
4997                 use secp256k1::ffi::Signature as FFISignature;
4998                 use secp256k1::Signature;
4999                 msgs::ChannelUpdate {
5000                         signature: Signature::from(FFISignature::new()),
5001                         contents: msgs::UnsignedChannelUpdate {
5002                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5003                                 short_channel_id: 0,
5004                                 timestamp: 0,
5005                                 flags: 0,
5006                                 cltv_expiry_delta: 0,
5007                                 htlc_minimum_msat: 0,
5008                                 fee_base_msat: 0,
5009                                 fee_proportional_millionths: 0,
5010                                 excess_data: vec![],
5011                         }
5012                 }
5013         }
5014 }
5015
5016 struct BogusOnionHopData {
5017         data: Vec<u8>
5018 }
5019 impl BogusOnionHopData {
5020         fn new(orig: msgs::OnionHopData) -> Self {
5021                 Self { data: orig.encode() }
5022         }
5023 }
5024 impl Writeable for BogusOnionHopData {
5025         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5026                 writer.write_all(&self.data[..])
5027         }
5028 }
5029
5030 #[test]
5031 fn test_onion_failure() {
5032         use ln::msgs::ChannelUpdate;
5033         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5034         use secp256k1;
5035
5036         const BADONION: u16 = 0x8000;
5037         const PERM: u16 = 0x4000;
5038         const NODE: u16 = 0x2000;
5039         const UPDATE: u16 = 0x1000;
5040
5041         let node_cfgs = create_node_cfgs(3);
5042         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5043         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5044         for node in nodes.iter() {
5045                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5046         }
5047         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())];
5048         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5049         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5050         // positve case
5051         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5052
5053         // intermediate node failure
5054         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5055                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5056                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5057                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5058                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5059                 let mut new_payloads = Vec::new();
5060                 for payload in onion_payloads.drain(..) {
5061                         new_payloads.push(BogusOnionHopData::new(payload));
5062                 }
5063                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5064                 // describing a length-1 TLV payload, which is obviously bogus.
5065                 new_payloads[0].data[0] = 1;
5066                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5067         }, ||{}, 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
5068
5069         // final node failure
5070         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5071                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5072                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5073                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5074                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5075                 let mut new_payloads = Vec::new();
5076                 for payload in onion_payloads.drain(..) {
5077                         new_payloads.push(BogusOnionHopData::new(payload));
5078                 }
5079                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5080                 // length-1 TLV payload, which is obviously bogus.
5081                 new_payloads[1].data[0] = 1;
5082                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5083         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5084
5085         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5086         // receiving simulated fail messages
5087         // intermediate node failure
5088         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5089                 // trigger error
5090                 msg.amount_msat -= 1;
5091         }, |msg| {
5092                 // and tamper returning error message
5093                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5094                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5095                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5096         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5097
5098         // final node failure
5099         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5100                 // and tamper returning error message
5101                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5102                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5103                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5104         }, ||{
5105                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5106         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5107
5108         // intermediate node failure
5109         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5110                 msg.amount_msat -= 1;
5111         }, |msg| {
5112                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5113                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5114                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5115         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5116
5117         // final node failure
5118         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5119                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5120                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5121                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5122         }, ||{
5123                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5124         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5125
5126         // intermediate node failure
5127         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5128                 msg.amount_msat -= 1;
5129         }, |msg| {
5130                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5131                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5132                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5133         }, ||{
5134                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5135         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5136
5137         // final node failure
5138         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5139                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5140                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5141                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5142         }, ||{
5143                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5144         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5145
5146         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5147                 Some(BADONION|PERM|4), None);
5148
5149         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5150                 Some(BADONION|PERM|5), None);
5151
5152         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5153                 Some(BADONION|PERM|6), None);
5154
5155         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5156                 msg.amount_msat -= 1;
5157         }, |msg| {
5158                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5159                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5160                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5161         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5162
5163         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5164                 msg.amount_msat -= 1;
5165         }, |msg| {
5166                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5167                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5168                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5169                 // short_channel_id from the processing node
5170         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5171
5172         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5173                 msg.amount_msat -= 1;
5174         }, |msg| {
5175                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5176                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5177                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5178                 // short_channel_id from the processing node
5179         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5180
5181         let mut bogus_route = route.clone();
5182         bogus_route.hops[1].short_channel_id -= 1;
5183         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5184           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5185
5186         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5187         let mut bogus_route = route.clone();
5188         let route_len = bogus_route.hops.len();
5189         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5190         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5191
5192         //TODO: with new config API, we will be able to generate both valid and
5193         //invalid channel_update cases.
5194         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5195                 msg.amount_msat -= 1;
5196         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5197
5198         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5199                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5200                 msg.cltv_expiry -= 1;
5201         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5202
5203         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5204                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5205                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5206
5207                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5208         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5209
5210         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5211                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5212         }, false, Some(PERM|15), None);
5213
5214         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5215                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5216                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5217
5218                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5219         }, || {}, true, Some(17), None);
5220
5221         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5222                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5223                         for f in pending_forwards.iter_mut() {
5224                                 match f {
5225                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5226                                                 forward_info.outgoing_cltv_value += 1,
5227                                         _ => {},
5228                                 }
5229                         }
5230                 }
5231         }, true, Some(18), None);
5232
5233         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5234                 // violate amt_to_forward > msg.amount_msat
5235                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5236                         for f in pending_forwards.iter_mut() {
5237                                 match f {
5238                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5239                                                 forward_info.amt_to_forward -= 1,
5240                                         _ => {},
5241                                 }
5242                         }
5243                 }
5244         }, true, Some(19), None);
5245
5246         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5247                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5248                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5249                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5250         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5251         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5252
5253         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5254                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5255                 let mut route = route.clone();
5256                 let height = 1;
5257                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5258                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5259                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5260                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5261                 msg.cltv_expiry = htlc_cltv;
5262                 msg.onion_routing_packet = onion_packet;
5263         }, ||{}, true, Some(21), None);
5264 }
5265
5266 #[test]
5267 #[should_panic]
5268 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5269         let node_cfgs = create_node_cfgs(2);
5270         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5271         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5272         //Force duplicate channel ids
5273         for node in nodes.iter() {
5274                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5275         }
5276
5277         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5278         let channel_value_satoshis=10000;
5279         let push_msat=10001;
5280         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5281         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5282         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5283
5284         //Create a second channel with a channel_id collision
5285         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5286 }
5287
5288 #[test]
5289 fn bolt2_open_channel_sending_node_checks_part2() {
5290         let node_cfgs = create_node_cfgs(2);
5291         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5292         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5293
5294         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5295         let channel_value_satoshis=2^24;
5296         let push_msat=10001;
5297         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5298
5299         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5300         let channel_value_satoshis=10000;
5301         // Test when push_msat is equal to 1000 * funding_satoshis.
5302         let push_msat=1000*channel_value_satoshis+1;
5303         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5304
5305         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5306         let channel_value_satoshis=10000;
5307         let push_msat=10001;
5308         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
5309         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5310         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5311
5312         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5313         // 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
5314         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5315
5316         // 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.
5317         assert!(BREAKDOWN_TIMEOUT>0);
5318         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5319
5320         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5321         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5322         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5323
5324         // 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.
5325         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5326         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5327         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5328         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5329         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5330 }
5331
5332 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5333 // 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.
5334 //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.
5335
5336 #[test]
5337 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5338         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5339         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5340         let node_cfgs = create_node_cfgs(2);
5341         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5342         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5343         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5344         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5345         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5346
5347         route.hops[0].fee_msat = 0;
5348
5349         let err = nodes[0].node.send_payment(route, our_payment_hash);
5350
5351         if let Err(APIError::ChannelUnavailable{err}) = err {
5352                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5353         } else {
5354                 assert!(false);
5355         }
5356         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5357         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5358 }
5359
5360 #[test]
5361 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5362         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5363         //It is enforced when constructing a route.
5364         let node_cfgs = create_node_cfgs(2);
5365         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5366         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5367         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5368         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5369         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5370
5371         let err = nodes[0].node.send_payment(route, our_payment_hash);
5372
5373         if let Err(APIError::RouteError{err}) = err {
5374                 assert_eq!(err, "Channel CLTV overflowed?!");
5375         } else {
5376                 assert!(false);
5377         }
5378 }
5379
5380 #[test]
5381 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5382         //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.
5383         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5384         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5385         let node_cfgs = create_node_cfgs(2);
5386         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5387         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5388         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5389         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5390
5391         for i in 0..max_accepted_htlcs {
5392                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5393                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5394                 let payment_event = {
5395                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5396                         check_added_monitors!(nodes[0], 1);
5397
5398                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5399                         assert_eq!(events.len(), 1);
5400                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5401                                 assert_eq!(htlcs[0].htlc_id, i);
5402                         } else {
5403                                 assert!(false);
5404                         }
5405                         SendEvent::from_event(events.remove(0))
5406                 };
5407                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5408                 check_added_monitors!(nodes[1], 0);
5409                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5410
5411                 expect_pending_htlcs_forwardable!(nodes[1]);
5412                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5413         }
5414         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5415         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5416         let err = nodes[0].node.send_payment(route, our_payment_hash);
5417
5418         if let Err(APIError::ChannelUnavailable{err}) = err {
5419                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5420         } else {
5421                 assert!(false);
5422         }
5423         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5424         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5425 }
5426
5427 #[test]
5428 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5429         //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.
5430         let node_cfgs = create_node_cfgs(2);
5431         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5432         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5433         let channel_value = 100000;
5434         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5435         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5436
5437         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5438
5439         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5440         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5441         let err = nodes[0].node.send_payment(route, our_payment_hash);
5442
5443         if let Err(APIError::ChannelUnavailable{err}) = err {
5444                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5445         } else {
5446                 assert!(false);
5447         }
5448         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5449         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);
5450
5451         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5452 }
5453
5454 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5455 #[test]
5456 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5457         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5458         let node_cfgs = create_node_cfgs(2);
5459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5460         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5461         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5462         let htlc_minimum_msat: u64;
5463         {
5464                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5465                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5466                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5467         }
5468         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5469         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5470         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5471         check_added_monitors!(nodes[0], 1);
5472         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5473         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5474         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5475         assert!(nodes[1].node.list_channels().is_empty());
5476         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5477         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5478 }
5479
5480 #[test]
5481 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5482         //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
5483         let node_cfgs = create_node_cfgs(2);
5484         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5485         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5486         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5487
5488         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5489
5490         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5491         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5492         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5493         check_added_monitors!(nodes[0], 1);
5494         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5495
5496         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5497         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5498
5499         assert!(nodes[1].node.list_channels().is_empty());
5500         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5501         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5502 }
5503
5504 #[test]
5505 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5506         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5507         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5508         let node_cfgs = create_node_cfgs(2);
5509         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5510         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5511         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5512         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5513         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5514
5515         let session_priv = SecretKey::from_slice(&{
5516                 let mut session_key = [0; 32];
5517                 let mut rng = thread_rng();
5518                 rng.fill_bytes(&mut session_key);
5519                 session_key
5520         }).expect("RNG is bad!");
5521
5522         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5523         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5524         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5525         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5526
5527         let mut msg = msgs::UpdateAddHTLC {
5528                 channel_id: chan.2,
5529                 htlc_id: 0,
5530                 amount_msat: 1000,
5531                 payment_hash: our_payment_hash,
5532                 cltv_expiry: htlc_cltv,
5533                 onion_routing_packet: onion_packet.clone(),
5534         };
5535
5536         for i in 0..super::channel::OUR_MAX_HTLCS {
5537                 msg.htlc_id = i as u64;
5538                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5539         }
5540         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5541         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5542
5543         assert!(nodes[1].node.list_channels().is_empty());
5544         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5545         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5546 }
5547
5548 #[test]
5549 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5550         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5551         let node_cfgs = create_node_cfgs(2);
5552         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5553         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5554         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5555         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5556         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5557         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5558         check_added_monitors!(nodes[0], 1);
5559         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5560         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5561         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5562
5563         assert!(nodes[1].node.list_channels().is_empty());
5564         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5565         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5566 }
5567
5568 #[test]
5569 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5570         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5571         let node_cfgs = create_node_cfgs(2);
5572         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5573         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5574         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5575         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5576         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5577         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5578         check_added_monitors!(nodes[0], 1);
5579         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5580         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5581         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5582
5583         assert!(nodes[1].node.list_channels().is_empty());
5584         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5585         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5586 }
5587
5588 #[test]
5589 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5590         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5591         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5592         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5593         let node_cfgs = create_node_cfgs(2);
5594         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5595         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5596         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5597         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5598         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5599         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5600         check_added_monitors!(nodes[0], 1);
5601         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5602         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5603
5604         //Disconnect and Reconnect
5605         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5606         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5607         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5608         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5609         assert_eq!(reestablish_1.len(), 1);
5610         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5611         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5612         assert_eq!(reestablish_2.len(), 1);
5613         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5614         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5615         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5616         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5617
5618         //Resend HTLC
5619         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5620         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5621         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5622         check_added_monitors!(nodes[1], 1);
5623         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5624
5625         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5626
5627         assert!(nodes[1].node.list_channels().is_empty());
5628         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5629         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5630 }
5631
5632 #[test]
5633 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5634         //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.
5635
5636         let node_cfgs = create_node_cfgs(2);
5637         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5638         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5639         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5640
5641         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5642         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5643         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5644         check_added_monitors!(nodes[0], 1);
5645         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5646         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5647
5648         let update_msg = msgs::UpdateFulfillHTLC{
5649                 channel_id: chan.2,
5650                 htlc_id: 0,
5651                 payment_preimage: our_payment_preimage,
5652         };
5653
5654         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5655
5656         assert!(nodes[0].node.list_channels().is_empty());
5657         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5658         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5659 }
5660
5661 #[test]
5662 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5663         //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.
5664
5665         let node_cfgs = create_node_cfgs(2);
5666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5667         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5668         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5669
5670         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5671         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5672         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5673         check_added_monitors!(nodes[0], 1);
5674         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5675         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5676
5677         let update_msg = msgs::UpdateFailHTLC{
5678                 channel_id: chan.2,
5679                 htlc_id: 0,
5680                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5681         };
5682
5683         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5684
5685         assert!(nodes[0].node.list_channels().is_empty());
5686         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5687         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5688 }
5689
5690 #[test]
5691 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5692         //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.
5693
5694         let node_cfgs = create_node_cfgs(2);
5695         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5696         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5697         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5698
5699         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5700         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5701         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5702         check_added_monitors!(nodes[0], 1);
5703         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5704         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5705
5706         let update_msg = msgs::UpdateFailMalformedHTLC{
5707                 channel_id: chan.2,
5708                 htlc_id: 0,
5709                 sha256_of_onion: [1; 32],
5710                 failure_code: 0x8000,
5711         };
5712
5713         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5714
5715         assert!(nodes[0].node.list_channels().is_empty());
5716         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5717         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5718 }
5719
5720 #[test]
5721 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5722         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5723
5724         let node_cfgs = create_node_cfgs(2);
5725         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5726         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5727         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5728
5729         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5730
5731         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5732         check_added_monitors!(nodes[1], 1);
5733
5734         let events = nodes[1].node.get_and_clear_pending_msg_events();
5735         assert_eq!(events.len(), 1);
5736         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5737                 match events[0] {
5738                         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, .. } } => {
5739                                 assert!(update_add_htlcs.is_empty());
5740                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5741                                 assert!(update_fail_htlcs.is_empty());
5742                                 assert!(update_fail_malformed_htlcs.is_empty());
5743                                 assert!(update_fee.is_none());
5744                                 update_fulfill_htlcs[0].clone()
5745                         },
5746                         _ => panic!("Unexpected event"),
5747                 }
5748         };
5749
5750         update_fulfill_msg.htlc_id = 1;
5751
5752         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5753
5754         assert!(nodes[0].node.list_channels().is_empty());
5755         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5756         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5757 }
5758
5759 #[test]
5760 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5761         //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.
5762
5763         let node_cfgs = create_node_cfgs(2);
5764         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5765         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5766         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5767
5768         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5769
5770         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5771         check_added_monitors!(nodes[1], 1);
5772
5773         let events = nodes[1].node.get_and_clear_pending_msg_events();
5774         assert_eq!(events.len(), 1);
5775         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5776                 match events[0] {
5777                         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, .. } } => {
5778                                 assert!(update_add_htlcs.is_empty());
5779                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5780                                 assert!(update_fail_htlcs.is_empty());
5781                                 assert!(update_fail_malformed_htlcs.is_empty());
5782                                 assert!(update_fee.is_none());
5783                                 update_fulfill_htlcs[0].clone()
5784                         },
5785                         _ => panic!("Unexpected event"),
5786                 }
5787         };
5788
5789         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5790
5791         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5792
5793         assert!(nodes[0].node.list_channels().is_empty());
5794         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5795         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5796 }
5797
5798
5799 #[test]
5800 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5801         //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.
5802
5803         let node_cfgs = create_node_cfgs(2);
5804         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5805         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5806         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5807         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5808         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5809         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5810         check_added_monitors!(nodes[0], 1);
5811
5812         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5813         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5814
5815         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5816         check_added_monitors!(nodes[1], 0);
5817         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5818
5819         let events = nodes[1].node.get_and_clear_pending_msg_events();
5820
5821         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5822                 match events[0] {
5823                         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, .. } } => {
5824                                 assert!(update_add_htlcs.is_empty());
5825                                 assert!(update_fulfill_htlcs.is_empty());
5826                                 assert!(update_fail_htlcs.is_empty());
5827                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5828                                 assert!(update_fee.is_none());
5829                                 update_fail_malformed_htlcs[0].clone()
5830                         },
5831                         _ => panic!("Unexpected event"),
5832                 }
5833         };
5834         update_msg.failure_code &= !0x8000;
5835         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5836
5837         assert!(nodes[0].node.list_channels().is_empty());
5838         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5839         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5840 }
5841
5842 #[test]
5843 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5844         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5845         //    * 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.
5846
5847         let node_cfgs = create_node_cfgs(3);
5848         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5849         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5850         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5851         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5852
5853         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5854         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5855
5856         //First hop
5857         let mut payment_event = {
5858                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5859                 check_added_monitors!(nodes[0], 1);
5860                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5861                 assert_eq!(events.len(), 1);
5862                 SendEvent::from_event(events.remove(0))
5863         };
5864         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5865         check_added_monitors!(nodes[1], 0);
5866         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5867         expect_pending_htlcs_forwardable!(nodes[1]);
5868         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5869         assert_eq!(events_2.len(), 1);
5870         check_added_monitors!(nodes[1], 1);
5871         payment_event = SendEvent::from_event(events_2.remove(0));
5872         assert_eq!(payment_event.msgs.len(), 1);
5873
5874         //Second Hop
5875         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5876         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5877         check_added_monitors!(nodes[2], 0);
5878         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5879
5880         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5881         assert_eq!(events_3.len(), 1);
5882         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5883                 match events_3[0] {
5884                         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 } } => {
5885                                 assert!(update_add_htlcs.is_empty());
5886                                 assert!(update_fulfill_htlcs.is_empty());
5887                                 assert!(update_fail_htlcs.is_empty());
5888                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5889                                 assert!(update_fee.is_none());
5890                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5891                         },
5892                         _ => panic!("Unexpected event"),
5893                 }
5894         };
5895
5896         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5897
5898         check_added_monitors!(nodes[1], 0);
5899         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5900         expect_pending_htlcs_forwardable!(nodes[1]);
5901         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5902         assert_eq!(events_4.len(), 1);
5903
5904         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5905         match events_4[0] {
5906                 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, .. } } => {
5907                         assert!(update_add_htlcs.is_empty());
5908                         assert!(update_fulfill_htlcs.is_empty());
5909                         assert_eq!(update_fail_htlcs.len(), 1);
5910                         assert!(update_fail_malformed_htlcs.is_empty());
5911                         assert!(update_fee.is_none());
5912                 },
5913                 _ => panic!("Unexpected event"),
5914         };
5915
5916         check_added_monitors!(nodes[1], 1);
5917 }
5918
5919 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5920         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5921         // 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
5922         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5923
5924         let node_cfgs = create_node_cfgs(2);
5925         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5926         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5927         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5928
5929         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5930
5931         // We route 2 dust-HTLCs between A and B
5932         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5933         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5934         route_payment(&nodes[0], &[&nodes[1]], 1000000);
5935
5936         // Cache one local commitment tx as previous
5937         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();
5938
5939         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5940         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
5941         check_added_monitors!(nodes[1], 0);
5942         expect_pending_htlcs_forwardable!(nodes[1]);
5943         check_added_monitors!(nodes[1], 1);
5944
5945         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5946         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5947         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5948         check_added_monitors!(nodes[0], 1);
5949
5950         // Cache one local commitment tx as lastest
5951         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();
5952
5953         let events = nodes[0].node.get_and_clear_pending_msg_events();
5954         match events[0] {
5955                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5956                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5957                 },
5958                 _ => panic!("Unexpected event"),
5959         }
5960         match events[1] {
5961                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5962                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5963                 },
5964                 _ => panic!("Unexpected event"),
5965         }
5966
5967         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5968         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5969         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5970
5971         if announce_latest {
5972                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5973         } else {
5974                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5975         }
5976
5977         let events = nodes[0].node.get_and_clear_pending_msg_events();
5978         assert_eq!(events.len(), 1);
5979         match events[0] {
5980                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5981                 _ => panic!("Unexpected event"),
5982         }
5983
5984         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5985         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5986         let events = nodes[0].node.get_and_clear_pending_events();
5987         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5988         assert_eq!(events.len(), 2);
5989         let mut first_failed = false;
5990         for event in events {
5991                 match event {
5992                         Event::PaymentFailed { payment_hash, .. } => {
5993                                 if payment_hash == payment_hash_1 {
5994                                         assert!(!first_failed);
5995                                         first_failed = true;
5996                                 } else {
5997                                         assert_eq!(payment_hash, payment_hash_2);
5998                                 }
5999                         }
6000                         _ => panic!("Unexpected event"),
6001                 }
6002         }
6003 }
6004
6005 #[test]
6006 fn test_failure_delay_dust_htlc_local_commitment() {
6007         do_test_failure_delay_dust_htlc_local_commitment(true);
6008         do_test_failure_delay_dust_htlc_local_commitment(false);
6009 }
6010
6011 #[test]
6012 fn test_no_failure_dust_htlc_local_commitment() {
6013         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6014         // prone to error, we test here that a dummy transaction don't fail them.
6015
6016         let node_cfgs = create_node_cfgs(2);
6017         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6018         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6019         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6020
6021         // Rebalance a bit
6022         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6023
6024         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6025         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6026
6027         // We route 2 dust-HTLCs between A and B
6028         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6029         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6030
6031         // Build a dummy invalid transaction trying to spend a commitment tx
6032         let input = TxIn {
6033                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6034                 script_sig: Script::new(),
6035                 sequence: 0,
6036                 witness: Vec::new(),
6037         };
6038
6039         let outp = TxOut {
6040                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6041                 value: 10000,
6042         };
6043
6044         let dummy_tx = Transaction {
6045                 version: 2,
6046                 lock_time: 0,
6047                 input: vec![input],
6048                 output: vec![outp]
6049         };
6050
6051         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6052         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6053         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6054         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6055         // We broadcast a few more block to check everything is all right
6056         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6057         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6058         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6059
6060         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6061         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6062 }
6063
6064 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6065         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6066         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6067         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6068         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6069         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6070         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6071
6072         let node_cfgs = create_node_cfgs(3);
6073         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6074         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6075         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6076
6077         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6078
6079         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6080         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6081
6082         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();
6083         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();
6084
6085         // We revoked bs_commitment_tx
6086         if revoked {
6087                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6088                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6089         }
6090
6091         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6092         let mut timeout_tx = Vec::new();
6093         if local {
6094                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6095                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6096                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6097                 assert_eq!(events.len(), 1);
6098                 match events[0] {
6099                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6100                         _ => panic!("Unexpected event"),
6101                 }
6102                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6103                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6104                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6105                 let events = nodes[0].node.get_and_clear_pending_events();
6106                 assert_eq!(events.len(), 1);
6107                 match events[0] {
6108                         Event::PaymentFailed { payment_hash, .. } => {
6109                                 assert_eq!(payment_hash, dust_hash);
6110                         },
6111                         _ => panic!("Unexpected event"),
6112                 }
6113                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6114                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6115                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6116                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6117                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6118                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6119                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6120                 let events = nodes[0].node.get_and_clear_pending_events();
6121                 assert_eq!(events.len(), 1);
6122                 match events[0] {
6123                         Event::PaymentFailed { payment_hash, .. } => {
6124                                 assert_eq!(payment_hash, non_dust_hash);
6125                         },
6126                         _ => panic!("Unexpected event"),
6127                 }
6128         } else {
6129                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6130                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6131                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6132                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6133                 assert_eq!(events.len(), 1);
6134                 match events[0] {
6135                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6136                         _ => panic!("Unexpected event"),
6137                 }
6138                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6139                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6140                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6141                 if !revoked {
6142                         let events = nodes[0].node.get_and_clear_pending_events();
6143                         assert_eq!(events.len(), 1);
6144                         match events[0] {
6145                                 Event::PaymentFailed { payment_hash, .. } => {
6146                                         assert_eq!(payment_hash, dust_hash);
6147                                 },
6148                                 _ => panic!("Unexpected event"),
6149                         }
6150                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6151                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6152                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6153                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6154                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6155                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6156                         let events = nodes[0].node.get_and_clear_pending_events();
6157                         assert_eq!(events.len(), 1);
6158                         match events[0] {
6159                                 Event::PaymentFailed { payment_hash, .. } => {
6160                                         assert_eq!(payment_hash, non_dust_hash);
6161                                 },
6162                                 _ => panic!("Unexpected event"),
6163                         }
6164                 } else {
6165                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6166                         // commitment tx
6167                         let events = nodes[0].node.get_and_clear_pending_events();
6168                         assert_eq!(events.len(), 2);
6169                         let first;
6170                         match events[0] {
6171                                 Event::PaymentFailed { payment_hash, .. } => {
6172                                         if payment_hash == dust_hash { first = true; }
6173                                         else { first = false; }
6174                                 },
6175                                 _ => panic!("Unexpected event"),
6176                         }
6177                         match events[1] {
6178                                 Event::PaymentFailed { payment_hash, .. } => {
6179                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6180                                         else { assert_eq!(payment_hash, dust_hash); }
6181                                 },
6182                                 _ => panic!("Unexpected event"),
6183                         }
6184                 }
6185         }
6186 }
6187
6188 #[test]
6189 fn test_sweep_outbound_htlc_failure_update() {
6190         do_test_sweep_outbound_htlc_failure_update(false, true);
6191         do_test_sweep_outbound_htlc_failure_update(false, false);
6192         do_test_sweep_outbound_htlc_failure_update(true, false);
6193 }
6194
6195 #[test]
6196 fn test_upfront_shutdown_script() {
6197         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6198         // enforce it at shutdown message
6199
6200         let mut config = UserConfig::default();
6201         config.channel_options.announced_channel = true;
6202         config.peer_channel_config_limits.force_announced_channel_preference = false;
6203         config.channel_options.commit_upfront_shutdown_pubkey = false;
6204         let user_cfgs = [None, Some(config), None];
6205         let node_cfgs = create_node_cfgs(3);
6206         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6207         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6208
6209         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6210         let flags = InitFeatures::supported();
6211         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6212         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6213         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6214         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6215         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6216         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6217         let events = nodes[2].node.get_and_clear_pending_msg_events();
6218         assert_eq!(events.len(), 2);
6219         match events[0] {
6220                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6221                 _ => panic!("Unexpected event"),
6222         }
6223         if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6224                 match action {
6225                         &ErrorAction::SendErrorMessage { ref msg } => {
6226                                 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6227                         },
6228                         _ => { assert!(false); }
6229                 }
6230         } else { assert!(false); }
6231
6232         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6233         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6234         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6235         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6236         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6237         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6238         let events = nodes[2].node.get_and_clear_pending_msg_events();
6239         assert_eq!(events.len(), 1);
6240         match events[0] {
6241                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6242                 _ => panic!("Unexpected event"),
6243         }
6244
6245         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6246         let mut flags_no = InitFeatures::supported();
6247         flags_no.unset_upfront_shutdown_script();
6248         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6249         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6250         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6251         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6252         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6253         let events = nodes[1].node.get_and_clear_pending_msg_events();
6254         assert_eq!(events.len(), 1);
6255         match events[0] {
6256                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6257                 _ => panic!("Unexpected event"),
6258         }
6259
6260         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6261         // channel smoothly, opt-out is from channel initiator here
6262         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6263         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6264         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6265         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6266         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6267         let events = nodes[0].node.get_and_clear_pending_msg_events();
6268         assert_eq!(events.len(), 1);
6269         match events[0] {
6270                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6271                 _ => panic!("Unexpected event"),
6272         }
6273
6274         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6275         //// channel smoothly
6276         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6277         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6278         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6279         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6280         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6281         let events = nodes[0].node.get_and_clear_pending_msg_events();
6282         assert_eq!(events.len(), 2);
6283         match events[0] {
6284                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6285                 _ => panic!("Unexpected event"),
6286         }
6287         match events[1] {
6288                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6289                 _ => panic!("Unexpected event"),
6290         }
6291 }
6292
6293 #[test]
6294 fn test_user_configurable_csv_delay() {
6295         // We test our channel constructors yield errors when we pass them absurd csv delay
6296
6297         let mut low_our_to_self_config = UserConfig::default();
6298         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6299         let mut high_their_to_self_config = UserConfig::default();
6300         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6301         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6302         let node_cfgs = create_node_cfgs(2);
6303         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6304         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6305
6306         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6307         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())));
6308         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) {
6309                 match error {
6310                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6311                         _ => panic!("Unexpected event"),
6312                 }
6313         } else { assert!(false) }
6314
6315         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6316         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6317         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6318         open_channel.to_self_delay = 200;
6319         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) {
6320                 match error {
6321                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6322                         _ => panic!("Unexpected event"),
6323                 }
6324         } else { assert!(false); }
6325
6326         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6327         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6328         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()));
6329         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6330         accept_channel.to_self_delay = 200;
6331         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6332         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6333                 match action {
6334                         &ErrorAction::SendErrorMessage { ref msg } => {
6335                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6336                         },
6337                         _ => { assert!(false); }
6338                 }
6339         } else { assert!(false); }
6340
6341         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6342         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6343         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6344         open_channel.to_self_delay = 200;
6345         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) {
6346                 match error {
6347                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6348                         _ => panic!("Unexpected event"),
6349                 }
6350         } else { assert!(false); }
6351 }
6352
6353 #[test]
6354 fn test_data_loss_protect() {
6355         // We want to be sure that :
6356         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6357         // * we close channel in case of detecting other being fallen behind
6358         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6359         let monitor;
6360         let node_state_0;
6361         let node_cfgs = create_node_cfgs(2);
6362         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6363         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6364
6365         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6366
6367         // Cache node A state before any channel update
6368         let previous_node_state = nodes[0].node.encode();
6369         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6370         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6371
6372         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6373         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6374
6375         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6376         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6377
6378         // Restore node A from previous state
6379         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6380         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6381         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6382         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())});
6383         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6384         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone());
6385         node_state_0 = {
6386                 let mut channel_monitors = HashMap::new();
6387                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6388                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6389                         keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6390                         fee_estimator: feeest.clone(),
6391                         monitor: &monitor,
6392                         logger: Arc::clone(&logger),
6393                         tx_broadcaster,
6394                         default_config: UserConfig::default(),
6395                         channel_monitors: &mut channel_monitors,
6396                 }).unwrap().1
6397         };
6398         nodes[0].node = &node_state_0;
6399         assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6400         nodes[0].chan_monitor = &monitor;
6401         nodes[0].chain_monitor = chain_monitor;
6402
6403         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6404         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6405         nodes[0].block_notifier.register_listener(nodes[0].node);
6406
6407         check_added_monitors!(nodes[0], 1);
6408
6409         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6410         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6411
6412         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6413
6414         // Check we update monitor following learning of per_commitment_point from B
6415         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6416         check_added_monitors!(nodes[0], 1);
6417
6418         {
6419                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6420                 assert_eq!(node_txn.len(), 0);
6421         }
6422
6423         let mut reestablish_1 = Vec::with_capacity(1);
6424         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6425                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6426                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6427                         reestablish_1.push(msg.clone());
6428                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6429                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6430                         match action {
6431                                 &ErrorAction::SendErrorMessage { ref msg } => {
6432                                         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");
6433                                 },
6434                                 _ => panic!("Unexpected event!"),
6435                         }
6436                 } else {
6437                         panic!("Unexpected event")
6438                 }
6439         }
6440
6441         // Check we close channel detecting A is fallen-behind
6442         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6443         let events = nodes[1].node.get_and_clear_pending_msg_events();
6444         assert_eq!(events.len(), 2);
6445         match events[0] {
6446                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6447                 _ => panic!("Unexpected event"),
6448         }
6449         match events [1] {
6450                 MessageSendEvent::HandleError { ref action, .. } => {
6451                         match action {
6452                                 &ErrorAction::SendErrorMessage { ref msg } => {
6453                                         assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6454                                 _ => panic!("Unexpected event!"),
6455                         }
6456                 },
6457                 _ => panic!("Unexpected event"),
6458         }
6459
6460         // Check A is able to claim to_remote output
6461         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6462         assert_eq!(node_txn.len(), 1);
6463         check_spends!(node_txn[0], chan.3.clone());
6464         assert_eq!(node_txn[0].output.len(), 2);
6465         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6466         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6467         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6468         assert_eq!(spend_txn.len(), 1);
6469         check_spends!(spend_txn[0], node_txn[0].clone());
6470 }
6471
6472 #[test]
6473 fn test_check_htlc_underpaying() {
6474         // Send payment through A -> B but A is maliciously
6475         // sending a probe payment (i.e less than expected value0
6476         // to B, B should refuse payment.
6477
6478         let node_cfgs = create_node_cfgs(2);
6479         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6480         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6481
6482         // Create some initial channels
6483         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6484
6485         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6486
6487         // Node 3 is expecting payment of 100_000 but receive 10_000,
6488         // fail htlc like we didn't know the preimage.
6489         nodes[1].node.claim_funds(payment_preimage, 100_000);
6490         nodes[1].node.process_pending_htlc_forwards();
6491
6492         let events = nodes[1].node.get_and_clear_pending_msg_events();
6493         assert_eq!(events.len(), 1);
6494         let (update_fail_htlc, commitment_signed) = match events[0] {
6495                 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 } } => {
6496                         assert!(update_add_htlcs.is_empty());
6497                         assert!(update_fulfill_htlcs.is_empty());
6498                         assert_eq!(update_fail_htlcs.len(), 1);
6499                         assert!(update_fail_malformed_htlcs.is_empty());
6500                         assert!(update_fee.is_none());
6501                         (update_fail_htlcs[0].clone(), commitment_signed)
6502                 },
6503                 _ => panic!("Unexpected event"),
6504         };
6505         check_added_monitors!(nodes[1], 1);
6506
6507         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6508         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6509
6510         let events = nodes[0].node.get_and_clear_pending_events();
6511         assert_eq!(events.len(), 1);
6512         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6513                 assert_eq!(*rejected_by_dest, true);
6514                 assert_eq!(error_code.unwrap(), 0x4000|15);
6515         } else {
6516                 panic!("Unexpected event");
6517         }
6518         nodes[1].node.get_and_clear_pending_events();
6519 }
6520
6521 #[test]
6522 fn test_announce_disable_channels() {
6523         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6524         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6525
6526         let node_cfgs = create_node_cfgs(2);
6527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6528         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6529
6530         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6531         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6532         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6533
6534         // Disconnect peers
6535         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6536         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6537
6538         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6539         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6540         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6541         assert_eq!(msg_events.len(), 3);
6542         for e in msg_events {
6543                 match e {
6544                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6545                                 let short_id = msg.contents.short_channel_id;
6546                                 // Check generated channel_update match list in PendingChannelUpdate
6547                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6548                                         panic!("Generated ChannelUpdate for wrong chan!");
6549                                 }
6550                         },
6551                         _ => panic!("Unexpected event"),
6552                 }
6553         }
6554         // Reconnect peers
6555         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6556         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6557         assert_eq!(reestablish_1.len(), 3);
6558         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6559         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6560         assert_eq!(reestablish_2.len(), 3);
6561
6562         // Reestablish chan_1
6563         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6564         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6565         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6566         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6567         // Reestablish chan_2
6568         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6569         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6570         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6571         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6572         // Reestablish chan_3
6573         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6574         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6575         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6576         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6577
6578         nodes[0].node.timer_chan_freshness_every_min();
6579         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6580 }
6581
6582 #[test]
6583 fn test_bump_penalty_txn_on_revoked_commitment() {
6584         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6585         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6586
6587         let node_cfgs = create_node_cfgs(2);
6588         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6589         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6590
6591         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6592         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6593         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6594         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6595
6596         let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6597         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6598         assert_eq!(revoked_txn[0].output.len(), 4);
6599         assert_eq!(revoked_txn[0].input.len(), 1);
6600         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6601         let revoked_txid = revoked_txn[0].txid();
6602
6603         let mut penalty_sum = 0;
6604         for outp in revoked_txn[0].output.iter() {
6605                 if outp.script_pubkey.is_v0_p2wsh() {
6606                         penalty_sum += outp.value;
6607                 }
6608         }
6609
6610         // Connect blocks to change height_timer range to see if we use right soonest_timelock
6611         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6612
6613         // Actually revoke tx by claiming a HTLC
6614         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6615         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6616         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6617
6618         // One or more justice tx should have been broadcast, check it
6619         let penalty_1;
6620         let feerate_1;
6621         {
6622                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6623                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6624                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6625                 assert_eq!(node_txn[0].output.len(), 1);
6626                 check_spends!(node_txn[0], revoked_txn[0].clone());
6627                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6628                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6629                 penalty_1 = node_txn[0].txid();
6630                 node_txn.clear();
6631         };
6632
6633         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6634         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
6635         let mut penalty_2 = penalty_1;
6636         let mut feerate_2 = 0;
6637         {
6638                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6639                 assert_eq!(node_txn.len(), 1);
6640                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6641                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6642                         assert_eq!(node_txn[0].output.len(), 1);
6643                         check_spends!(node_txn[0], revoked_txn[0].clone());
6644                         penalty_2 = node_txn[0].txid();
6645                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6646                         assert_ne!(penalty_2, penalty_1);
6647                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
6648                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6649                         // Verify 25% bump heuristic
6650                         assert!(feerate_2 * 100 >= feerate_1 * 125);
6651                         node_txn.clear();
6652                 }
6653         }
6654         assert_ne!(feerate_2, 0);
6655
6656         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6657         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6658         let penalty_3;
6659         let mut feerate_3 = 0;
6660         {
6661                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6662                 assert_eq!(node_txn.len(), 1);
6663                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6664                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6665                         assert_eq!(node_txn[0].output.len(), 1);
6666                         check_spends!(node_txn[0], revoked_txn[0].clone());
6667                         penalty_3 = node_txn[0].txid();
6668                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6669                         assert_ne!(penalty_3, penalty_2);
6670                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
6671                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6672                         // Verify 25% bump heuristic
6673                         assert!(feerate_3 * 100 >= feerate_2 * 125);
6674                         node_txn.clear();
6675                 }
6676         }
6677         assert_ne!(feerate_3, 0);
6678
6679         nodes[1].node.get_and_clear_pending_events();
6680         nodes[1].node.get_and_clear_pending_msg_events();
6681 }
6682
6683 #[test]
6684 fn test_bump_penalty_txn_on_revoked_htlcs() {
6685         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6686         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6687
6688         let node_cfgs = create_node_cfgs(2);
6689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6690         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6691
6692         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6693         // Lock HTLC in both directions
6694         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6695         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6696
6697         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();
6698         assert_eq!(revoked_local_txn[0].input.len(), 1);
6699         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6700
6701         // Revoke local commitment tx
6702         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6703
6704         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6705         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6706         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6707         check_closed_broadcast!(nodes[1], false);
6708
6709         let mut received = ::std::usize::MAX;
6710         let mut offered = ::std::usize::MAX;
6711         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6712         assert_eq!(revoked_htlc_txn.len(), 6);
6713         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6714                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6715                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6716                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6717                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6718                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6719                 received = 0;
6720                 offered = 1;
6721         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6722                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6723                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6724                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6725                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6726                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6727                 received = 1;
6728                 offered = 0;
6729         }
6730
6731         // Broadcast set of revoked txn on A
6732         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  true, header.bitcoin_hash());
6733         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6734         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);
6735         let first;
6736         let second;
6737         let feerate_1;
6738         let feerate_2;
6739         {
6740                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6741                 assert_eq!(node_txn.len(), 6); // 3 penalty txn on revoked commitment tx + A commitment tx + 2 penalty tnx on revoked HTLC txn
6742                 // Verify claim tx are spending revoked HTLC txn
6743                 assert_eq!(node_txn[4].input.len(), 1);
6744                 assert_eq!(node_txn[4].output.len(), 1);
6745                 check_spends!(node_txn[4], revoked_htlc_txn[0].clone());
6746                 first = node_txn[4].txid();
6747                 assert_eq!(node_txn[5].input.len(), 1);
6748                 assert_eq!(node_txn[5].output.len(), 1);
6749                 check_spends!(node_txn[5], revoked_htlc_txn[1].clone());
6750                 second = node_txn[5].txid();
6751                 // Store both feerates for later comparison
6752                 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[4].output[0].value;
6753                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
6754                 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[5].output[0].value;
6755                 feerate_2 = fee_2 * 1000 / node_txn[5].get_weight() as u64;
6756                 node_txn.clear();
6757         }
6758
6759         // Connect three more block to see if bumped penalty are issued for HTLC txn
6760         let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6761         let penalty_local_tx;
6762         {
6763                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6764                 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
6765
6766                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6767                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6768
6769                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6770
6771                 penalty_local_tx = node_txn[2].clone();
6772                 node_txn.clear();
6773         };
6774         // Few more blocks to broadcast and confirm penalty_local_tx
6775         let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6776         nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6777         let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6778         {
6779                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6780                 assert_eq!(node_txn.len(), 1);
6781                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6782                 node_txn.clear();
6783         }
6784         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6785         let node_txn = {
6786                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6787                 assert_eq!(node_txn.len(), 2);
6788
6789                 let mut penalty_offered = ::std::usize::MAX;
6790                 let mut penalty_received = ::std::usize::MAX;
6791
6792                 {
6793                         for (i, tx) in node_txn.iter().enumerate() {
6794                                 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6795                                         penalty_offered = i;
6796                                 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6797                                         penalty_received = i;
6798                                 }
6799                         }
6800                 }
6801
6802                 assert_eq!(node_txn[penalty_received].input.len(), 1);
6803                 assert_eq!(node_txn[penalty_received].output.len(), 1);
6804                 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6805                 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6806                 // Verify bumped tx is different and 25% bump heuristic
6807                 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6808                 assert_ne!(first, node_txn[penalty_offered].txid());
6809                 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6810                 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6811                 assert!(new_feerate * 100 > feerate_1 * 125);
6812
6813                 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6814                 assert_ne!(second, node_txn[penalty_received].txid());
6815                 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6816                 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6817                 assert!(new_feerate * 100 > feerate_2 * 125);
6818                 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
6819                 node_txn.clear();
6820                 txn
6821         };
6822         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6823         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6824         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
6825         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
6826         {
6827                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6828                 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
6829                 node_txn.clear();
6830         }
6831         check_closed_broadcast!(nodes[0], false);
6832 }
6833
6834 #[test]
6835 fn test_bump_penalty_txn_on_remote_commitment() {
6836         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6837         // we're able to claim outputs on remote commitment transaction before timelocks expiration
6838
6839         // Create 2 HTLCs
6840         // Provide preimage for one
6841         // Check aggregation
6842
6843         let node_cfgs = create_node_cfgs(2);
6844         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6845         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6846
6847         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6848         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6849         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6850
6851         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6852         let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6853         assert_eq!(remote_txn[0].output.len(), 4);
6854         assert_eq!(remote_txn[0].input.len(), 1);
6855         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6856
6857         // Claim a HTLC without revocation (provide B monitor with preimage)
6858         nodes[1].node.claim_funds(payment_preimage, 3_000_000);
6859         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6860         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6861         check_added_monitors!(nodes[1], 1);
6862
6863         // One or more claim tx should have been broadcast, check it
6864         let timeout;
6865         let preimage;
6866         let feerate_timeout;
6867         let feerate_preimage;
6868         {
6869                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6870                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
6871                 assert_eq!(node_txn[0].input.len(), 1);
6872                 assert_eq!(node_txn[1].input.len(), 1);
6873                 check_spends!(node_txn[0], remote_txn[0].clone());
6874                 check_spends!(node_txn[1], remote_txn[0].clone());
6875                 check_spends!(node_txn[2], chan.3);
6876                 check_spends!(node_txn[3], node_txn[2]);
6877                 check_spends!(node_txn[4], node_txn[2]);
6878                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6879                         timeout = node_txn[0].txid();
6880                         let index = node_txn[0].input[0].previous_output.vout;
6881                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6882                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6883
6884                         preimage = 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_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6888                 } else {
6889                         timeout = node_txn[1].txid();
6890                         let index = node_txn[1].input[0].previous_output.vout;
6891                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6892                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6893
6894                         preimage = node_txn[0].txid();
6895                         let index = node_txn[0].input[0].previous_output.vout;
6896                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6897                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6898                 }
6899                 node_txn.clear();
6900         };
6901         assert_ne!(feerate_timeout, 0);
6902         assert_ne!(feerate_preimage, 0);
6903
6904         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6905         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
6906         {
6907                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6908                 assert_eq!(node_txn.len(), 2);
6909                 assert_eq!(node_txn[0].input.len(), 1);
6910                 assert_eq!(node_txn[1].input.len(), 1);
6911                 check_spends!(node_txn[0], remote_txn[0].clone());
6912                 check_spends!(node_txn[1], remote_txn[0].clone());
6913                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6914                         let index = node_txn[0].input[0].previous_output.vout;
6915                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6916                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6917                         assert!(new_feerate * 100 > feerate_timeout * 125);
6918                         assert_ne!(timeout, node_txn[0].txid());
6919
6920                         let index = node_txn[1].input[0].previous_output.vout;
6921                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6922                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6923                         assert!(new_feerate * 100 > feerate_preimage * 125);
6924                         assert_ne!(preimage, node_txn[1].txid());
6925                 } else {
6926                         let index = node_txn[1].input[0].previous_output.vout;
6927                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6928                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6929                         assert!(new_feerate * 100 > feerate_timeout * 125);
6930                         assert_ne!(timeout, node_txn[1].txid());
6931
6932                         let index = node_txn[0].input[0].previous_output.vout;
6933                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6934                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6935                         assert!(new_feerate * 100 > feerate_preimage * 125);
6936                         assert_ne!(preimage, node_txn[0].txid());
6937                 }
6938                 node_txn.clear();
6939         }
6940
6941         nodes[1].node.get_and_clear_pending_events();
6942         nodes[1].node.get_and_clear_pending_msg_events();
6943 }
6944
6945 #[test]
6946 fn test_set_outpoints_partial_claiming() {
6947         // - remote party claim tx, new bump tx
6948         // - disconnect remote claiming tx, new bump
6949         // - disconnect tx, see no tx anymore
6950         let node_cfgs = create_node_cfgs(2);
6951         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6952         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6953
6954         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6955         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6956         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6957
6958         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6959         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6960         assert_eq!(remote_txn.len(), 3);
6961         assert_eq!(remote_txn[0].output.len(), 4);
6962         assert_eq!(remote_txn[0].input.len(), 1);
6963         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6964         check_spends!(remote_txn[1], remote_txn[0].clone());
6965         check_spends!(remote_txn[2], remote_txn[0].clone());
6966
6967         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6968         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6969         // Provide node A with both preimage
6970         nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
6971         nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
6972         check_added_monitors!(nodes[0], 2);
6973         nodes[0].node.get_and_clear_pending_events();
6974         nodes[0].node.get_and_clear_pending_msg_events();
6975
6976         // Connect blocks on node A commitment transaction
6977         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6978         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6979         // Verify node A broadcast tx claiming both HTLCs
6980         {
6981                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6982                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
6983                 assert_eq!(node_txn.len(), 4);
6984                 check_spends!(node_txn[0], remote_txn[0].clone());
6985                 check_spends!(node_txn[1], chan.3.clone());
6986                 check_spends!(node_txn[2], node_txn[1]);
6987                 check_spends!(node_txn[3], node_txn[1]);
6988                 assert_eq!(node_txn[0].input.len(), 2);
6989                 node_txn.clear();
6990         }
6991         nodes[0].node.get_and_clear_pending_msg_events();
6992
6993         // Connect blocks on node B
6994         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6995         // Verify node B broadcast 2 HTLC-timeout txn
6996         let partial_claim_tx = {
6997                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6998                 assert_eq!(node_txn.len(), 3);
6999                 check_spends!(node_txn[1], node_txn[0].clone());
7000                 check_spends!(node_txn[2], node_txn[0].clone());
7001                 assert_eq!(node_txn[1].input.len(), 1);
7002                 assert_eq!(node_txn[2].input.len(), 1);
7003                 node_txn[1].clone()
7004         };
7005         nodes[1].node.get_and_clear_pending_msg_events();
7006
7007         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7008         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7009         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7010         {
7011                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7012                 assert_eq!(node_txn.len(), 1);
7013                 check_spends!(node_txn[0], remote_txn[0].clone());
7014                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7015                 node_txn.clear();
7016         }
7017         nodes[0].node.get_and_clear_pending_msg_events();
7018
7019         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7020         nodes[0].block_notifier.block_disconnected(&header, 102);
7021         {
7022                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7023                 assert_eq!(node_txn.len(), 1);
7024                 check_spends!(node_txn[0], remote_txn[0].clone());
7025                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7026                 node_txn.clear();
7027         }
7028
7029         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7030         nodes[0].block_notifier.block_disconnected(&header, 101);
7031         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7032         {
7033                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7034                 assert_eq!(node_txn.len(), 0);
7035                 node_txn.clear();
7036         }
7037 }
7038
7039 #[test]
7040 fn test_counterparty_raa_skip_no_crash() {
7041         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7042         // commitment transaction, we would have happily carried on and provided them the next
7043         // commitment transaction based on one RAA forward. This would probably eventually have led to
7044         // channel closure, but it would not have resulted in funds loss. Still, our
7045         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7046         // check simply that the channel is closed in response to such an RAA, but don't check whether
7047         // we decide to punish our counterparty for revoking their funds (as we don't currently
7048         // implement that).
7049         let node_cfgs = create_node_cfgs(2);
7050         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7051         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7052         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7053
7054         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7055         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7056         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7057                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7058         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7059
7060         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7061                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7062         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7063 }
7064
7065 #[test]
7066 fn test_bump_txn_sanitize_tracking_maps() {
7067         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7068         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7069
7070         let node_cfgs = create_node_cfgs(2);
7071         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7072         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7073
7074         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7075         // Lock HTLC in both directions
7076         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7077         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7078
7079         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();
7080         assert_eq!(revoked_local_txn[0].input.len(), 1);
7081         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7082
7083         // Revoke local commitment tx
7084         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7085
7086         // Broadcast set of revoked txn on A
7087         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7088         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7089         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7090         check_closed_broadcast!(nodes[0], false);
7091         let penalty_txn = {
7092                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7093                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7094                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7095                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7096                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7097                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7098                 node_txn.clear();
7099                 penalty_txn
7100         };
7101         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7102         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7103         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7104         {
7105                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7106                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7107                         assert!(monitor.pending_claim_requests.is_empty());
7108                         assert!(monitor.claimable_outpoints.is_empty());
7109                 }
7110         }
7111 }