_ 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, 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;
  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(), 7);
1382         check_spends!(claim_txn[2], chan_1.3);
1383         check_spends!(claim_txn[3], claim_txn[2]);
1384         assert_eq!(claim_txn[0], claim_txn[5]);
1385         assert_eq!(claim_txn[1], claim_txn[6]);
1386         assert_eq!(htlc_pair.0.input.len(), 1);
1387         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1388         check_spends!(htlc_pair.0, remote_txn[0].clone());
1389         assert_eq!(htlc_pair.1.input.len(), 1);
1390         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1391         check_spends!(htlc_pair.1, remote_txn[0].clone());
1392
1393         let events = nodes[0].node.get_and_clear_pending_msg_events();
1394         assert_eq!(events.len(), 2);
1395         for e in events {
1396                 match e {
1397                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1398                         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, .. } } => {
1399                                 assert!(update_add_htlcs.is_empty());
1400                                 assert!(update_fail_htlcs.is_empty());
1401                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1402                                 assert!(update_fail_malformed_htlcs.is_empty());
1403                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1404                         },
1405                         _ => panic!("Unexpected event"),
1406                 }
1407         }
1408 }
1409
1410 fn do_channel_reserve_test(test_recv: bool) {
1411
1412         let node_cfgs = create_node_cfgs(3);
1413         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1414         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1415         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1416         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1417
1418         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1419         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1420
1421         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1422         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1423
1424         macro_rules! get_route_and_payment_hash {
1425                 ($recv_value: expr) => {{
1426                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1427                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1428                         (route, payment_hash, payment_preimage)
1429                 }}
1430         };
1431
1432         macro_rules! expect_forward {
1433                 ($node: expr) => {{
1434                         let mut events = $node.node.get_and_clear_pending_msg_events();
1435                         assert_eq!(events.len(), 1);
1436                         check_added_monitors!($node, 1);
1437                         let payment_event = SendEvent::from_event(events.remove(0));
1438                         payment_event
1439                 }}
1440         }
1441
1442         let feemsat = 239; // somehow we know?
1443         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1444
1445         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1446
1447         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1448         {
1449                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1450                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1451                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1452                 match err {
1453                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1454                         _ => panic!("Unknown error variants"),
1455                 }
1456                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1457                 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);
1458         }
1459
1460         let mut htlc_id = 0;
1461         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1462         // nodes[0]'s wealth
1463         loop {
1464                 let amt_msat = recv_value_0 + total_fee_msat;
1465                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1466                         break;
1467                 }
1468                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1469                 htlc_id += 1;
1470
1471                 let (stat01_, stat11_, stat12_, stat22_) = (
1472                         get_channel_value_stat!(nodes[0], chan_1.2),
1473                         get_channel_value_stat!(nodes[1], chan_1.2),
1474                         get_channel_value_stat!(nodes[1], chan_2.2),
1475                         get_channel_value_stat!(nodes[2], chan_2.2),
1476                 );
1477
1478                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1479                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1480                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1481                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1482                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1483         }
1484
1485         {
1486                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1487                 // attempt to get channel_reserve violation
1488                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1489                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1490                 match err {
1491                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1492                         _ => panic!("Unknown error variants"),
1493                 }
1494                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1495                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1496         }
1497
1498         // adding pending output
1499         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1500         let amt_msat_1 = recv_value_1 + total_fee_msat;
1501
1502         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1503         let payment_event_1 = {
1504                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1505                 check_added_monitors!(nodes[0], 1);
1506
1507                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1508                 assert_eq!(events.len(), 1);
1509                 SendEvent::from_event(events.remove(0))
1510         };
1511         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1512
1513         // channel reserve test with htlc pending output > 0
1514         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1515         {
1516                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1517                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1518                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1519                         _ => panic!("Unknown error variants"),
1520                 }
1521                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1522                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1523         }
1524
1525         {
1526                 // test channel_reserve test on nodes[1] side
1527                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1528
1529                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1530                 let secp_ctx = Secp256k1::new();
1531                 let session_priv = SecretKey::from_slice(&{
1532                         let mut session_key = [0; 32];
1533                         let mut rng = thread_rng();
1534                         rng.fill_bytes(&mut session_key);
1535                         session_key
1536                 }).expect("RNG is bad!");
1537
1538                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1539                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1540                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1541                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1542                 let msg = msgs::UpdateAddHTLC {
1543                         channel_id: chan_1.2,
1544                         htlc_id,
1545                         amount_msat: htlc_msat,
1546                         payment_hash: our_payment_hash,
1547                         cltv_expiry: htlc_cltv,
1548                         onion_routing_packet: onion_packet,
1549                 };
1550
1551                 if test_recv {
1552                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1553                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1554                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1555                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1556                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1557                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1558                         return;
1559                 }
1560         }
1561
1562         // split the rest to test holding cell
1563         let recv_value_21 = recv_value_2/2;
1564         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1565         {
1566                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1567                 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);
1568         }
1569
1570         // now see if they go through on both sides
1571         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1572         // but this will stuck in the holding cell
1573         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1574         check_added_monitors!(nodes[0], 0);
1575         let events = nodes[0].node.get_and_clear_pending_events();
1576         assert_eq!(events.len(), 0);
1577
1578         // test with outbound holding cell amount > 0
1579         {
1580                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1581                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1582                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1583                         _ => panic!("Unknown error variants"),
1584                 }
1585                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1586                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1587         }
1588
1589         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1590         // this will also stuck in the holding cell
1591         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1592         check_added_monitors!(nodes[0], 0);
1593         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1594         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1595
1596         // flush the pending htlc
1597         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1598         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1599         check_added_monitors!(nodes[1], 1);
1600
1601         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1602         check_added_monitors!(nodes[0], 1);
1603         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1604
1605         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1606         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1607         // No commitment_signed so get_event_msg's assert(len == 1) passes
1608         check_added_monitors!(nodes[0], 1);
1609
1610         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1611         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1612         check_added_monitors!(nodes[1], 1);
1613
1614         expect_pending_htlcs_forwardable!(nodes[1]);
1615
1616         let ref payment_event_11 = expect_forward!(nodes[1]);
1617         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1618         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1619
1620         expect_pending_htlcs_forwardable!(nodes[2]);
1621         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1622
1623         // flush the htlcs in the holding cell
1624         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1625         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1626         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1627         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1628         expect_pending_htlcs_forwardable!(nodes[1]);
1629
1630         let ref payment_event_3 = expect_forward!(nodes[1]);
1631         assert_eq!(payment_event_3.msgs.len(), 2);
1632         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1633         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1634
1635         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1636         expect_pending_htlcs_forwardable!(nodes[2]);
1637
1638         let events = nodes[2].node.get_and_clear_pending_events();
1639         assert_eq!(events.len(), 2);
1640         match events[0] {
1641                 Event::PaymentReceived { ref payment_hash, amt } => {
1642                         assert_eq!(our_payment_hash_21, *payment_hash);
1643                         assert_eq!(recv_value_21, amt);
1644                 },
1645                 _ => panic!("Unexpected event"),
1646         }
1647         match events[1] {
1648                 Event::PaymentReceived { ref payment_hash, amt } => {
1649                         assert_eq!(our_payment_hash_22, *payment_hash);
1650                         assert_eq!(recv_value_22, amt);
1651                 },
1652                 _ => panic!("Unexpected event"),
1653         }
1654
1655         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1656         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1657         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1658
1659         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);
1660         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1661         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1662         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1663
1664         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1665         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1666 }
1667
1668 #[test]
1669 fn channel_reserve_test() {
1670         do_channel_reserve_test(false);
1671         do_channel_reserve_test(true);
1672 }
1673
1674 #[test]
1675 fn channel_reserve_in_flight_removes() {
1676         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1677         // can send to its counterparty, but due to update ordering, the other side may not yet have
1678         // considered those HTLCs fully removed.
1679         // This tests that we don't count HTLCs which will not be included in the next remote
1680         // commitment transaction towards the reserve value (as it implies no commitment transaction
1681         // will be generated which violates the remote reserve value).
1682         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1683         // To test this we:
1684         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1685         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1686         //    you only consider the value of the first HTLC, it may not),
1687         //  * start routing a third HTLC from A to B,
1688         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1689         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1690         //  * deliver the first fulfill from B
1691         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1692         //    claim,
1693         //  * deliver A's response CS and RAA.
1694         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1695         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1696         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1697         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1698         let node_cfgs = create_node_cfgs(2);
1699         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1700         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1701         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1702
1703         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1704         // Route the first two HTLCs.
1705         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1706         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1707
1708         // Start routing the third HTLC (this is just used to get everyone in the right state).
1709         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1710         let send_1 = {
1711                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1712                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1713                 check_added_monitors!(nodes[0], 1);
1714                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1715                 assert_eq!(events.len(), 1);
1716                 SendEvent::from_event(events.remove(0))
1717         };
1718
1719         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1720         // initial fulfill/CS.
1721         assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1722         check_added_monitors!(nodes[1], 1);
1723         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1724
1725         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1726         // remove the second HTLC when we send the HTLC back from B to A.
1727         assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1728         check_added_monitors!(nodes[1], 1);
1729         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1730
1731         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1732         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1733         check_added_monitors!(nodes[0], 1);
1734         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1735         expect_payment_sent!(nodes[0], payment_preimage_1);
1736
1737         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1738         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1739         check_added_monitors!(nodes[1], 1);
1740         // B is already AwaitingRAA, so cant generate a CS here
1741         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1742
1743         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1744         check_added_monitors!(nodes[1], 1);
1745         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1746
1747         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1748         check_added_monitors!(nodes[0], 1);
1749         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1750
1751         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1752         check_added_monitors!(nodes[1], 1);
1753         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1754
1755         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1756         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1757         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1758         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1759         // on-chain as necessary).
1760         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1761         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1762         check_added_monitors!(nodes[0], 1);
1763         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1764         expect_payment_sent!(nodes[0], payment_preimage_2);
1765
1766         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1767         check_added_monitors!(nodes[1], 1);
1768         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1769
1770         expect_pending_htlcs_forwardable!(nodes[1]);
1771         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1772
1773         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1774         // resolve the second HTLC from A's point of view.
1775         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1776         check_added_monitors!(nodes[0], 1);
1777         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1778
1779         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1780         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1781         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1782         let send_2 = {
1783                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1784                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1785                 check_added_monitors!(nodes[1], 1);
1786                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1787                 assert_eq!(events.len(), 1);
1788                 SendEvent::from_event(events.remove(0))
1789         };
1790
1791         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1792         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1793         check_added_monitors!(nodes[0], 1);
1794         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1795
1796         // Now just resolve all the outstanding messages/HTLCs for completeness...
1797
1798         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1799         check_added_monitors!(nodes[1], 1);
1800         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1801
1802         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1803         check_added_monitors!(nodes[1], 1);
1804
1805         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1806         check_added_monitors!(nodes[0], 1);
1807         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1808
1809         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1810         check_added_monitors!(nodes[1], 1);
1811         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1812
1813         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1814         check_added_monitors!(nodes[0], 1);
1815
1816         expect_pending_htlcs_forwardable!(nodes[0]);
1817         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1818
1819         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1820         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1821 }
1822
1823 #[test]
1824 fn channel_monitor_network_test() {
1825         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1826         // tests that ChannelMonitor is able to recover from various states.
1827         let node_cfgs = create_node_cfgs(5);
1828         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1829         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1830
1831         // Create some initial channels
1832         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1833         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1834         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1835         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1836
1837         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1841         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1842
1843         // Simple case with no pending HTLCs:
1844         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1845         {
1846                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1847                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1848                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1849                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1850         }
1851         get_announce_close_broadcast_events(&nodes, 0, 1);
1852         assert_eq!(nodes[0].node.list_channels().len(), 0);
1853         assert_eq!(nodes[1].node.list_channels().len(), 1);
1854
1855         // One pending HTLC is discarded by the force-close:
1856         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1857
1858         // Simple case of one pending HTLC to HTLC-Timeout
1859         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1860         {
1861                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1862                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1863                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1864                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1865         }
1866         get_announce_close_broadcast_events(&nodes, 1, 2);
1867         assert_eq!(nodes[1].node.list_channels().len(), 0);
1868         assert_eq!(nodes[2].node.list_channels().len(), 1);
1869
1870         macro_rules! claim_funds {
1871                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1872                         {
1873                                 assert!($node.node.claim_funds($preimage, $amount));
1874                                 check_added_monitors!($node, 1);
1875
1876                                 let events = $node.node.get_and_clear_pending_msg_events();
1877                                 assert_eq!(events.len(), 1);
1878                                 match events[0] {
1879                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1880                                                 assert!(update_add_htlcs.is_empty());
1881                                                 assert!(update_fail_htlcs.is_empty());
1882                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1883                                         },
1884                                         _ => panic!("Unexpected event"),
1885                                 };
1886                         }
1887                 }
1888         }
1889
1890         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1891         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1892         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1893         let node2_commitment_txid;
1894         {
1895                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1896                 node2_commitment_txid = node_txn[0].txid();
1897
1898                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1899                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1900
1901                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1902                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1903
1904                 check_preimage_claim(&nodes[3], &node_txn);
1905         }
1906         get_announce_close_broadcast_events(&nodes, 2, 3);
1907         assert_eq!(nodes[2].node.list_channels().len(), 0);
1908         assert_eq!(nodes[3].node.list_channels().len(), 1);
1909
1910         { // Cheat and reset nodes[4]'s height to 1
1911                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1912                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1913         }
1914
1915         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1916         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1917         // One pending HTLC to time out:
1918         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1919         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1920         // buffer space).
1921
1922         {
1923                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1924                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1925                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1926                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1927                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1928                 }
1929
1930                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1931                 {
1932                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1933                         node_txn.retain(|tx| {
1934                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
1935                                         false
1936                                 } else { true }
1937                         });
1938                 }
1939
1940                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1941
1942                 // Claim the payment on nodes[4], giving it knowledge of the preimage
1943                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1944
1945                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1946
1947                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1948                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1949                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1950                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1951                 }
1952
1953                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1954
1955                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1956                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1957
1958                 check_preimage_claim(&nodes[4], &node_txn);
1959         }
1960         get_announce_close_broadcast_events(&nodes, 3, 4);
1961         assert_eq!(nodes[3].node.list_channels().len(), 0);
1962         assert_eq!(nodes[4].node.list_channels().len(), 0);
1963 }
1964
1965 #[test]
1966 fn test_justice_tx() {
1967         // Test justice txn built on revoked HTLC-Success tx, against both sides
1968         let mut alice_config = UserConfig::default();
1969         alice_config.channel_options.announced_channel = true;
1970         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1971         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1972         let mut bob_config = UserConfig::default();
1973         bob_config.channel_options.announced_channel = true;
1974         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1975         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1976         let user_cfgs = [Some(alice_config), Some(bob_config)];
1977         let node_cfgs = create_node_cfgs(2);
1978         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
1979         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1980         // Create some new channels:
1981         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1982
1983         // A pending HTLC which will be revoked:
1984         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1985         // Get the will-be-revoked local txn from nodes[0]
1986         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();
1987         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1988         assert_eq!(revoked_local_txn[0].input.len(), 1);
1989         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1990         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1991         assert_eq!(revoked_local_txn[1].input.len(), 1);
1992         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1993         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1994         // Revoke the old state
1995         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1996
1997         {
1998                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1999                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2000                 {
2001                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2002                         assert_eq!(node_txn.len(), 3);
2003                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2004                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2005
2006                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2007                         node_txn.swap_remove(0);
2008                         node_txn.truncate(1);
2009                 }
2010                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2011
2012                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2013                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2014                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2015                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2016                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2017         }
2018         get_announce_close_broadcast_events(&nodes, 0, 1);
2019
2020         assert_eq!(nodes[0].node.list_channels().len(), 0);
2021         assert_eq!(nodes[1].node.list_channels().len(), 0);
2022
2023         // We test justice_tx build by A on B's revoked HTLC-Success tx
2024         // Create some new channels:
2025         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2026         {
2027                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2028                 node_txn.clear();
2029         }
2030
2031         // A pending HTLC which will be revoked:
2032         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2033         // Get the will-be-revoked local txn from B
2034         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();
2035         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2036         assert_eq!(revoked_local_txn[0].input.len(), 1);
2037         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2038         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2039         // Revoke the old state
2040         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2041         {
2042                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2043                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2044                 {
2045                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2046                         assert_eq!(node_txn.len(), 3);
2047                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2048                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2049
2050                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2051                         node_txn.swap_remove(0);
2052                 }
2053                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2054
2055                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2056                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2057                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2058                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2059                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2060         }
2061         get_announce_close_broadcast_events(&nodes, 0, 1);
2062         assert_eq!(nodes[0].node.list_channels().len(), 0);
2063         assert_eq!(nodes[1].node.list_channels().len(), 0);
2064 }
2065
2066 #[test]
2067 fn revoked_output_claim() {
2068         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2069         // transaction is broadcast by its counterparty
2070         let node_cfgs = create_node_cfgs(2);
2071         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2072         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2073         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2074         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2075         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();
2076         assert_eq!(revoked_local_txn.len(), 1);
2077         // Only output is the full channel value back to nodes[0]:
2078         assert_eq!(revoked_local_txn[0].output.len(), 1);
2079         // Send a payment through, updating everyone's latest commitment txn
2080         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2081
2082         // Inform nodes[1] that nodes[0] broadcast a stale tx
2083         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2084         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2085         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2086         assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2087
2088         assert_eq!(node_txn[0], node_txn[2]);
2089
2090         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2091         check_spends!(node_txn[1], chan_1.3.clone());
2092
2093         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2094         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2095         get_announce_close_broadcast_events(&nodes, 0, 1);
2096 }
2097
2098 #[test]
2099 fn claim_htlc_outputs_shared_tx() {
2100         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2101         let node_cfgs = create_node_cfgs(2);
2102         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2103         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2104
2105         // Create some new channel:
2106         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2107
2108         // Rebalance the network to generate htlc in the two directions
2109         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2110         // 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
2111         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2112         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2113
2114         // Get the will-be-revoked local txn from node[0]
2115         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();
2116         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2117         assert_eq!(revoked_local_txn[0].input.len(), 1);
2118         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2119         assert_eq!(revoked_local_txn[1].input.len(), 1);
2120         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2121         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2122         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2123
2124         //Revoke the old state
2125         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2126
2127         {
2128                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2129                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2130                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2131                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2132
2133                 let events = nodes[1].node.get_and_clear_pending_events();
2134                 assert_eq!(events.len(), 1);
2135                 match events[0] {
2136                         Event::PaymentFailed { payment_hash, .. } => {
2137                                 assert_eq!(payment_hash, payment_hash_2);
2138                         },
2139                         _ => panic!("Unexpected event"),
2140                 }
2141
2142                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2143                 assert_eq!(node_txn.len(), 4);
2144
2145                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2146                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2147
2148                 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2149
2150                 let mut witness_lens = BTreeSet::new();
2151                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2152                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2153                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2154                 assert_eq!(witness_lens.len(), 3);
2155                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2156                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2157                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2158
2159                 // Next nodes[1] broadcasts its current local tx state:
2160                 assert_eq!(node_txn[1].input.len(), 1);
2161                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2162
2163                 assert_eq!(node_txn[2].input.len(), 1);
2164                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2165                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2166                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2167                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2168                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2169         }
2170         get_announce_close_broadcast_events(&nodes, 0, 1);
2171         assert_eq!(nodes[0].node.list_channels().len(), 0);
2172         assert_eq!(nodes[1].node.list_channels().len(), 0);
2173 }
2174
2175 #[test]
2176 fn claim_htlc_outputs_single_tx() {
2177         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2178         let node_cfgs = create_node_cfgs(2);
2179         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2180         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2181
2182         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2183
2184         // Rebalance the network to generate htlc in the two directions
2185         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2186         // 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
2187         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2188         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2189         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2190
2191         // Get the will-be-revoked local txn from node[0]
2192         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();
2193
2194         //Revoke the old state
2195         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2196
2197         {
2198                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2199                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2200                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2201                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2202
2203                 let events = nodes[1].node.get_and_clear_pending_events();
2204                 assert_eq!(events.len(), 1);
2205                 match events[0] {
2206                         Event::PaymentFailed { payment_hash, .. } => {
2207                                 assert_eq!(payment_hash, payment_hash_2);
2208                         },
2209                         _ => panic!("Unexpected event"),
2210                 }
2211
2212                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2213                 assert_eq!(node_txn.len(), 29); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan) + 5 * (1 local commitment tx + 1 htlc timeout tx)
2214
2215                 assert_eq!(node_txn[0], node_txn[7]);
2216                 assert_eq!(node_txn[1], node_txn[8]);
2217                 assert_eq!(node_txn[2], node_txn[9]);
2218                 assert_eq!(node_txn[3], node_txn[10]);
2219                 assert_eq!(node_txn[4], node_txn[11]);
2220                 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2221                 assert_eq!(node_txn[4], node_txn[6]);
2222
2223                 assert_eq!(node_txn[0].input.len(), 1);
2224                 assert_eq!(node_txn[1].input.len(), 1);
2225                 assert_eq!(node_txn[2].input.len(), 1);
2226
2227                 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2228                         if out_point.txid == tx.txid() {
2229                                 tx.output.get(out_point.vout as usize).cloned()
2230                         } else {
2231                                 None
2232                         }
2233                 }
2234                 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2235                 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2236                 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2237
2238                 let mut witness_lens = BTreeSet::new();
2239                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2240                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2241                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2242                 assert_eq!(witness_lens.len(), 3);
2243                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2244                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2245                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2246
2247                 assert_eq!(node_txn[3].input.len(), 1);
2248                 check_spends!(node_txn[3], chan_1.3.clone());
2249
2250                 assert_eq!(node_txn[4].input.len(), 1);
2251                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2252                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2253                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2254                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2255                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2256         }
2257         get_announce_close_broadcast_events(&nodes, 0, 1);
2258         assert_eq!(nodes[0].node.list_channels().len(), 0);
2259         assert_eq!(nodes[1].node.list_channels().len(), 0);
2260 }
2261
2262 #[test]
2263 fn test_htlc_on_chain_success() {
2264         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2265         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2266         // broadcasting the right event to other nodes in payment path.
2267         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2268         // A --------------------> B ----------------------> C (preimage)
2269         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2270         // commitment transaction was broadcast.
2271         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2272         // towards B.
2273         // B should be able to claim via preimage if A then broadcasts its local tx.
2274         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2275         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2276         // PaymentSent event).
2277
2278         let node_cfgs = create_node_cfgs(3);
2279         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2280         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2281
2282         // Create some initial channels
2283         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2284         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2285
2286         // Rebalance the network a bit by relaying one payment through all the channels...
2287         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2288         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2289
2290         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2291         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2292         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2293
2294         // Broadcast legit commitment tx from C on B's chain
2295         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2296         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();
2297         assert_eq!(commitment_tx.len(), 1);
2298         check_spends!(commitment_tx[0], chan_2.3.clone());
2299         nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2300         nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2301         check_added_monitors!(nodes[2], 2);
2302         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2303         assert!(updates.update_add_htlcs.is_empty());
2304         assert!(updates.update_fail_htlcs.is_empty());
2305         assert!(updates.update_fail_malformed_htlcs.is_empty());
2306         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2307
2308         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2309         check_closed_broadcast!(nodes[2], false);
2310         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)
2311         assert_eq!(node_txn.len(), 7);
2312         assert_eq!(node_txn[0], node_txn[3]);
2313         assert_eq!(node_txn[1], node_txn[4]);
2314         assert_eq!(node_txn[0], node_txn[5]);
2315         assert_eq!(node_txn[1], node_txn[6]);
2316         assert_eq!(node_txn[2], commitment_tx[0]);
2317         check_spends!(node_txn[0], commitment_tx[0].clone());
2318         check_spends!(node_txn[1], commitment_tx[0].clone());
2319         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2320         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2321         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2322         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2323         assert_eq!(node_txn[0].lock_time, 0);
2324         assert_eq!(node_txn[1].lock_time, 0);
2325
2326         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2327         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2328         let events = nodes[1].node.get_and_clear_pending_msg_events();
2329         {
2330                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2331                 assert_eq!(added_monitors.len(), 2);
2332                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2333                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2334                 added_monitors.clear();
2335         }
2336         assert_eq!(events.len(), 2);
2337         match events[0] {
2338                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2339                 _ => panic!("Unexpected event"),
2340         }
2341         match events[1] {
2342                 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, .. } } => {
2343                         assert!(update_add_htlcs.is_empty());
2344                         assert!(update_fail_htlcs.is_empty());
2345                         assert_eq!(update_fulfill_htlcs.len(), 1);
2346                         assert!(update_fail_malformed_htlcs.is_empty());
2347                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2348                 },
2349                 _ => panic!("Unexpected event"),
2350         };
2351         macro_rules! check_tx_local_broadcast {
2352                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2353                         // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2354                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2355                         assert_eq!(node_txn.len(), 7);
2356                         assert_eq!(node_txn[0], node_txn[5]);
2357                         assert_eq!(node_txn[1], node_txn[6]);
2358                         check_spends!(node_txn[0], $commitment_tx.clone());
2359                         check_spends!(node_txn[1], $commitment_tx.clone());
2360                         assert_ne!(node_txn[0].lock_time, 0);
2361                         assert_ne!(node_txn[1].lock_time, 0);
2362                         if $htlc_offered {
2363                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2364                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2365                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2366                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2367                         } else {
2368                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2369                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2370                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2371                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2372                         }
2373                         check_spends!(node_txn[2], $chan_tx.clone());
2374                         check_spends!(node_txn[3], node_txn[2].clone());
2375                         check_spends!(node_txn[4], node_txn[2].clone());
2376                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2377                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2378                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2379                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2380                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2381                         assert_ne!(node_txn[3].lock_time, 0);
2382                         assert_ne!(node_txn[4].lock_time, 0);
2383                         node_txn.clear();
2384                 } }
2385         }
2386         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2387         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2388         // timeout-claim of the output that nodes[2] just claimed via success.
2389         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2390
2391         // Broadcast legit commitment tx from A on B's chain
2392         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2393         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();
2394         check_spends!(commitment_tx[0], chan_1.3.clone());
2395         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2396         check_closed_broadcast!(nodes[1], false);
2397         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + 2*HTLC-Success), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2398         assert_eq!(node_txn.len(), 5);
2399         assert_eq!(node_txn[0], node_txn[4]);
2400         check_spends!(node_txn[0], commitment_tx[0].clone());
2401         assert_eq!(node_txn[0].input.len(), 2);
2402         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2403         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2404         assert_eq!(node_txn[0].lock_time, 0);
2405         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2406         check_spends!(node_txn[1], chan_1.3.clone());
2407         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2408         check_spends!(node_txn[2], node_txn[1]);
2409         check_spends!(node_txn[3], node_txn[1]);
2410         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2411         // we already checked the same situation with A.
2412
2413         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2414         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2415         check_closed_broadcast!(nodes[0], false);
2416         let events = nodes[0].node.get_and_clear_pending_events();
2417         assert_eq!(events.len(), 2);
2418         let mut first_claimed = false;
2419         for event in events {
2420                 match event {
2421                         Event::PaymentSent { payment_preimage } => {
2422                                 if payment_preimage == our_payment_preimage {
2423                                         assert!(!first_claimed);
2424                                         first_claimed = true;
2425                                 } else {
2426                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2427                                 }
2428                         },
2429                         _ => panic!("Unexpected event"),
2430                 }
2431         }
2432         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2433 }
2434
2435 #[test]
2436 fn test_htlc_on_chain_timeout() {
2437         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2438         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2439         // broadcasting the right event to other nodes in payment path.
2440         // A ------------------> B ----------------------> C (timeout)
2441         //    B's commitment tx                 C's commitment tx
2442         //            \                                  \
2443         //         B's HTLC timeout tx               B's timeout tx
2444
2445         let node_cfgs = create_node_cfgs(3);
2446         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2447         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2448
2449         // Create some intial channels
2450         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2451         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2452
2453         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2454         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2455         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2456
2457         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2458         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2459
2460         // Broadcast legit commitment tx from C on B's chain
2461         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();
2462         check_spends!(commitment_tx[0], chan_2.3.clone());
2463         nodes[2].node.fail_htlc_backwards(&payment_hash);
2464         check_added_monitors!(nodes[2], 0);
2465         expect_pending_htlcs_forwardable!(nodes[2]);
2466         check_added_monitors!(nodes[2], 1);
2467
2468         let events = nodes[2].node.get_and_clear_pending_msg_events();
2469         assert_eq!(events.len(), 1);
2470         match events[0] {
2471                 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, .. } } => {
2472                         assert!(update_add_htlcs.is_empty());
2473                         assert!(!update_fail_htlcs.is_empty());
2474                         assert!(update_fulfill_htlcs.is_empty());
2475                         assert!(update_fail_malformed_htlcs.is_empty());
2476                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2477                 },
2478                 _ => panic!("Unexpected event"),
2479         };
2480         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2481         check_closed_broadcast!(nodes[2], false);
2482         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2483         assert_eq!(node_txn.len(), 1);
2484         check_spends!(node_txn[0], chan_2.3.clone());
2485         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2486
2487         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2488         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2489         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2490         let timeout_tx;
2491         {
2492                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2493                 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2494                 assert_eq!(node_txn[0], node_txn[5]);
2495                 assert_eq!(node_txn[1], node_txn[6]);
2496                 assert_eq!(node_txn[2], node_txn[7]);
2497                 check_spends!(node_txn[0], commitment_tx[0].clone());
2498                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2499                 check_spends!(node_txn[1], chan_2.3.clone());
2500                 check_spends!(node_txn[2], node_txn[1].clone());
2501                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2502                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2503                 check_spends!(node_txn[3], chan_2.3.clone());
2504                 check_spends!(node_txn[4], node_txn[3].clone());
2505                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2506                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2507                 timeout_tx = node_txn[0].clone();
2508                 node_txn.clear();
2509         }
2510
2511         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2512         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2513         check_added_monitors!(nodes[1], 0);
2514         check_closed_broadcast!(nodes[1], false);
2515
2516         expect_pending_htlcs_forwardable!(nodes[1]);
2517         check_added_monitors!(nodes[1], 1);
2518         let events = nodes[1].node.get_and_clear_pending_msg_events();
2519         assert_eq!(events.len(), 1);
2520         match events[0] {
2521                 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, .. } } => {
2522                         assert!(update_add_htlcs.is_empty());
2523                         assert!(!update_fail_htlcs.is_empty());
2524                         assert!(update_fulfill_htlcs.is_empty());
2525                         assert!(update_fail_malformed_htlcs.is_empty());
2526                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2527                 },
2528                 _ => panic!("Unexpected event"),
2529         };
2530         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
2531         assert_eq!(node_txn.len(), 0);
2532
2533         // Broadcast legit commitment tx from B on A's chain
2534         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();
2535         check_spends!(commitment_tx[0], chan_1.3.clone());
2536
2537         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2538         check_closed_broadcast!(nodes[0], false);
2539         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2540         assert_eq!(node_txn.len(), 4);
2541         assert_eq!(node_txn[0], node_txn[3]);
2542         check_spends!(node_txn[0], commitment_tx[0].clone());
2543         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2544         check_spends!(node_txn[1], chan_1.3.clone());
2545         check_spends!(node_txn[2], node_txn[1].clone());
2546         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2547         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2548 }
2549
2550 #[test]
2551 fn test_simple_commitment_revoked_fail_backward() {
2552         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2553         // and fail backward accordingly.
2554
2555         let node_cfgs = create_node_cfgs(3);
2556         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2557         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2558
2559         // Create some initial channels
2560         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2561         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2562
2563         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2564         // Get the will-be-revoked local txn from nodes[2]
2565         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();
2566         // Revoke the old state
2567         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2568
2569         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2570
2571         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2572         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2573         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2574         check_added_monitors!(nodes[1], 0);
2575         check_closed_broadcast!(nodes[1], false);
2576
2577         expect_pending_htlcs_forwardable!(nodes[1]);
2578         check_added_monitors!(nodes[1], 1);
2579         let events = nodes[1].node.get_and_clear_pending_msg_events();
2580         assert_eq!(events.len(), 1);
2581         match events[0] {
2582                 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, .. } } => {
2583                         assert!(update_add_htlcs.is_empty());
2584                         assert_eq!(update_fail_htlcs.len(), 1);
2585                         assert!(update_fulfill_htlcs.is_empty());
2586                         assert!(update_fail_malformed_htlcs.is_empty());
2587                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2588
2589                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2590                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2591
2592                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2593                         assert_eq!(events.len(), 1);
2594                         match events[0] {
2595                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2596                                 _ => panic!("Unexpected event"),
2597                         }
2598                         let events = nodes[0].node.get_and_clear_pending_events();
2599                         assert_eq!(events.len(), 1);
2600                         match events[0] {
2601                                 Event::PaymentFailed { .. } => {},
2602                                 _ => panic!("Unexpected event"),
2603                         }
2604                 },
2605                 _ => panic!("Unexpected event"),
2606         }
2607 }
2608
2609 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2610         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2611         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2612         // commitment transaction anymore.
2613         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2614         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2615         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2616         // technically disallowed and we should probably handle it reasonably.
2617         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2618         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2619         // transactions:
2620         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2621         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2622         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2623         //   and once they revoke the previous commitment transaction (allowing us to send a new
2624         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2625         let node_cfgs = create_node_cfgs(3);
2626         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2627         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2628
2629         // Create some initial channels
2630         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2631         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2632
2633         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2634         // Get the will-be-revoked local txn from nodes[2]
2635         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();
2636         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2637         // Revoke the old state
2638         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2639
2640         let value = if use_dust {
2641                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2642                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2643                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2644         } else { 3000000 };
2645
2646         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2647         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2648         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2649
2650         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2651         expect_pending_htlcs_forwardable!(nodes[2]);
2652         check_added_monitors!(nodes[2], 1);
2653         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2654         assert!(updates.update_add_htlcs.is_empty());
2655         assert!(updates.update_fulfill_htlcs.is_empty());
2656         assert!(updates.update_fail_malformed_htlcs.is_empty());
2657         assert_eq!(updates.update_fail_htlcs.len(), 1);
2658         assert!(updates.update_fee.is_none());
2659         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2660         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2661         // Drop the last RAA from 3 -> 2
2662
2663         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2664         expect_pending_htlcs_forwardable!(nodes[2]);
2665         check_added_monitors!(nodes[2], 1);
2666         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2667         assert!(updates.update_add_htlcs.is_empty());
2668         assert!(updates.update_fulfill_htlcs.is_empty());
2669         assert!(updates.update_fail_malformed_htlcs.is_empty());
2670         assert_eq!(updates.update_fail_htlcs.len(), 1);
2671         assert!(updates.update_fee.is_none());
2672         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2673         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2674         check_added_monitors!(nodes[1], 1);
2675         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2676         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2677         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2678         check_added_monitors!(nodes[2], 1);
2679
2680         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2681         expect_pending_htlcs_forwardable!(nodes[2]);
2682         check_added_monitors!(nodes[2], 1);
2683         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2684         assert!(updates.update_add_htlcs.is_empty());
2685         assert!(updates.update_fulfill_htlcs.is_empty());
2686         assert!(updates.update_fail_malformed_htlcs.is_empty());
2687         assert_eq!(updates.update_fail_htlcs.len(), 1);
2688         assert!(updates.update_fee.is_none());
2689         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2690         // At this point first_payment_hash has dropped out of the latest two commitment
2691         // transactions that nodes[1] is tracking...
2692         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2693         check_added_monitors!(nodes[1], 1);
2694         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2695         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2696         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2697         check_added_monitors!(nodes[2], 1);
2698
2699         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2700         // on nodes[2]'s RAA.
2701         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2702         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2703         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2704         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2705         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2706         check_added_monitors!(nodes[1], 0);
2707
2708         if deliver_bs_raa {
2709                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2710                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2711                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2712                 check_added_monitors!(nodes[1], 1);
2713                 let events = nodes[1].node.get_and_clear_pending_events();
2714                 assert_eq!(events.len(), 1);
2715                 match events[0] {
2716                         Event::PendingHTLCsForwardable { .. } => { },
2717                         _ => panic!("Unexpected event"),
2718                 };
2719                 // Deliberately don't process the pending fail-back so they all fail back at once after
2720                 // block connection just like the !deliver_bs_raa case
2721         }
2722
2723         let mut failed_htlcs = HashSet::new();
2724         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2725
2726         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2727         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2728         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2729
2730         let events = nodes[1].node.get_and_clear_pending_events();
2731         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2732         match events[0] {
2733                 Event::PaymentFailed { ref payment_hash, .. } => {
2734                         assert_eq!(*payment_hash, fourth_payment_hash);
2735                 },
2736                 _ => panic!("Unexpected event"),
2737         }
2738         if !deliver_bs_raa {
2739                 match events[1] {
2740                         Event::PendingHTLCsForwardable { .. } => { },
2741                         _ => panic!("Unexpected event"),
2742                 };
2743         }
2744         nodes[1].node.process_pending_htlc_forwards();
2745         check_added_monitors!(nodes[1], 1);
2746
2747         let events = nodes[1].node.get_and_clear_pending_msg_events();
2748         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2749         match events[if deliver_bs_raa { 1 } else { 0 }] {
2750                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2751                 _ => panic!("Unexpected event"),
2752         }
2753         if deliver_bs_raa {
2754                 match events[0] {
2755                         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, .. } } => {
2756                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2757                                 assert_eq!(update_add_htlcs.len(), 1);
2758                                 assert!(update_fulfill_htlcs.is_empty());
2759                                 assert!(update_fail_htlcs.is_empty());
2760                                 assert!(update_fail_malformed_htlcs.is_empty());
2761                         },
2762                         _ => panic!("Unexpected event"),
2763                 }
2764         }
2765         match events[if deliver_bs_raa { 2 } else { 1 }] {
2766                 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, .. } } => {
2767                         assert!(update_add_htlcs.is_empty());
2768                         assert_eq!(update_fail_htlcs.len(), 3);
2769                         assert!(update_fulfill_htlcs.is_empty());
2770                         assert!(update_fail_malformed_htlcs.is_empty());
2771                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2772
2773                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2774                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2775                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2776
2777                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2778
2779                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2780                         // If we delivered B's RAA we got an unknown preimage error, not something
2781                         // that we should update our routing table for.
2782                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2783                         for event in events {
2784                                 match event {
2785                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2786                                         _ => panic!("Unexpected event"),
2787                                 }
2788                         }
2789                         let events = nodes[0].node.get_and_clear_pending_events();
2790                         assert_eq!(events.len(), 3);
2791                         match events[0] {
2792                                 Event::PaymentFailed { ref payment_hash, .. } => {
2793                                         assert!(failed_htlcs.insert(payment_hash.0));
2794                                 },
2795                                 _ => panic!("Unexpected event"),
2796                         }
2797                         match events[1] {
2798                                 Event::PaymentFailed { ref payment_hash, .. } => {
2799                                         assert!(failed_htlcs.insert(payment_hash.0));
2800                                 },
2801                                 _ => panic!("Unexpected event"),
2802                         }
2803                         match events[2] {
2804                                 Event::PaymentFailed { ref payment_hash, .. } => {
2805                                         assert!(failed_htlcs.insert(payment_hash.0));
2806                                 },
2807                                 _ => panic!("Unexpected event"),
2808                         }
2809                 },
2810                 _ => panic!("Unexpected event"),
2811         }
2812
2813         assert!(failed_htlcs.contains(&first_payment_hash.0));
2814         assert!(failed_htlcs.contains(&second_payment_hash.0));
2815         assert!(failed_htlcs.contains(&third_payment_hash.0));
2816 }
2817
2818 #[test]
2819 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2820         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2821         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2822         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2823         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2824 }
2825
2826 #[test]
2827 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2828         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2829         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2830         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2831         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2832 }
2833
2834 #[test]
2835 fn test_htlc_ignore_latest_remote_commitment() {
2836         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2837         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2838         let node_cfgs = create_node_cfgs(2);
2839         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2840         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2841         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2842
2843         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2844         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2845         check_closed_broadcast!(nodes[0], false);
2846
2847         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2848         assert_eq!(node_txn.len(), 2);
2849
2850         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2851         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2852         check_closed_broadcast!(nodes[1], false);
2853
2854         // Duplicate the block_connected call since this may happen due to other listeners
2855         // registering new transactions
2856         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2857 }
2858
2859 #[test]
2860 fn test_force_close_fail_back() {
2861         // Check which HTLCs are failed-backwards on channel force-closure
2862         let node_cfgs = create_node_cfgs(3);
2863         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2864         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2865         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2866         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2867
2868         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2869
2870         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2871
2872         let mut payment_event = {
2873                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2874                 check_added_monitors!(nodes[0], 1);
2875
2876                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2877                 assert_eq!(events.len(), 1);
2878                 SendEvent::from_event(events.remove(0))
2879         };
2880
2881         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2882         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2883
2884         expect_pending_htlcs_forwardable!(nodes[1]);
2885
2886         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2887         assert_eq!(events_2.len(), 1);
2888         payment_event = SendEvent::from_event(events_2.remove(0));
2889         assert_eq!(payment_event.msgs.len(), 1);
2890
2891         check_added_monitors!(nodes[1], 1);
2892         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2893         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2894         check_added_monitors!(nodes[2], 1);
2895         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2896
2897         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2898         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2899         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2900
2901         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2902         check_closed_broadcast!(nodes[2], false);
2903         let tx = {
2904                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2905                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2906                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2907                 // back to nodes[1] upon timeout otherwise.
2908                 assert_eq!(node_txn.len(), 1);
2909                 node_txn.remove(0)
2910         };
2911
2912         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2913         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2914
2915         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2916         check_closed_broadcast!(nodes[1], false);
2917
2918         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2919         {
2920                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2921                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2922                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2923         }
2924         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2925         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2926         assert_eq!(node_txn.len(), 1);
2927         assert_eq!(node_txn[0].input.len(), 1);
2928         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2929         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2930         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2931
2932         check_spends!(node_txn[0], tx);
2933 }
2934
2935 #[test]
2936 fn test_unconf_chan() {
2937         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2938         let node_cfgs = create_node_cfgs(2);
2939         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2940         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2941         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2942
2943         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2944         assert_eq!(channel_state.by_id.len(), 1);
2945         assert_eq!(channel_state.short_to_id.len(), 1);
2946         mem::drop(channel_state);
2947
2948         let mut headers = Vec::new();
2949         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2950         headers.push(header.clone());
2951         for _i in 2..100 {
2952                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2953                 headers.push(header.clone());
2954         }
2955         let mut height = 99;
2956         while !headers.is_empty() {
2957                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2958                 height -= 1;
2959         }
2960         check_closed_broadcast!(nodes[0], false);
2961         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2962         assert_eq!(channel_state.by_id.len(), 0);
2963         assert_eq!(channel_state.short_to_id.len(), 0);
2964 }
2965
2966 #[test]
2967 fn test_simple_peer_disconnect() {
2968         // Test that we can reconnect when there are no lost messages
2969         let node_cfgs = create_node_cfgs(3);
2970         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2971         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2972         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2973         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2974
2975         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2976         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2977         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2978
2979         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2980         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2981         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2982         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2983
2984         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2985         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2986         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2987
2988         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2989         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2990         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2991         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2992
2993         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2994         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2995
2996         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2997         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2998
2999         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3000         {
3001                 let events = nodes[0].node.get_and_clear_pending_events();
3002                 assert_eq!(events.len(), 2);
3003                 match events[0] {
3004                         Event::PaymentSent { payment_preimage } => {
3005                                 assert_eq!(payment_preimage, payment_preimage_3);
3006                         },
3007                         _ => panic!("Unexpected event"),
3008                 }
3009                 match events[1] {
3010                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3011                                 assert_eq!(payment_hash, payment_hash_5);
3012                                 assert!(rejected_by_dest);
3013                         },
3014                         _ => panic!("Unexpected event"),
3015                 }
3016         }
3017
3018         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3019         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3020 }
3021
3022 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3023         // Test that we can reconnect when in-flight HTLC updates get dropped
3024         let node_cfgs = create_node_cfgs(2);
3025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3026         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3027         if messages_delivered == 0 {
3028                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3029                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3030         } else {
3031                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3032         }
3033
3034         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();
3035         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3036
3037         let payment_event = {
3038                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3039                 check_added_monitors!(nodes[0], 1);
3040
3041                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3042                 assert_eq!(events.len(), 1);
3043                 SendEvent::from_event(events.remove(0))
3044         };
3045         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3046
3047         if messages_delivered < 2 {
3048                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3049         } else {
3050                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3051                 if messages_delivered >= 3 {
3052                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3053                         check_added_monitors!(nodes[1], 1);
3054                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3055
3056                         if messages_delivered >= 4 {
3057                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3058                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3059                                 check_added_monitors!(nodes[0], 1);
3060
3061                                 if messages_delivered >= 5 {
3062                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3063                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3064                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3065                                         check_added_monitors!(nodes[0], 1);
3066
3067                                         if messages_delivered >= 6 {
3068                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3069                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3070                                                 check_added_monitors!(nodes[1], 1);
3071                                         }
3072                                 }
3073                         }
3074                 }
3075         }
3076
3077         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3078         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3079         if messages_delivered < 3 {
3080                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3081                 // received on either side, both sides will need to resend them.
3082                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3083         } else if messages_delivered == 3 {
3084                 // nodes[0] still wants its RAA + commitment_signed
3085                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3086         } else if messages_delivered == 4 {
3087                 // nodes[0] still wants its commitment_signed
3088                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3089         } else if messages_delivered == 5 {
3090                 // nodes[1] still wants its final RAA
3091                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3092         } else if messages_delivered == 6 {
3093                 // Everything was delivered...
3094                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3095         }
3096
3097         let events_1 = nodes[1].node.get_and_clear_pending_events();
3098         assert_eq!(events_1.len(), 1);
3099         match events_1[0] {
3100                 Event::PendingHTLCsForwardable { .. } => { },
3101                 _ => panic!("Unexpected event"),
3102         };
3103
3104         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3105         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3106         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3107
3108         nodes[1].node.process_pending_htlc_forwards();
3109
3110         let events_2 = nodes[1].node.get_and_clear_pending_events();
3111         assert_eq!(events_2.len(), 1);
3112         match events_2[0] {
3113                 Event::PaymentReceived { ref payment_hash, amt } => {
3114                         assert_eq!(payment_hash_1, *payment_hash);
3115                         assert_eq!(amt, 1000000);
3116                 },
3117                 _ => panic!("Unexpected event"),
3118         }
3119
3120         nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3121         check_added_monitors!(nodes[1], 1);
3122
3123         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3124         assert_eq!(events_3.len(), 1);
3125         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3126                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3127                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3128                         assert!(updates.update_add_htlcs.is_empty());
3129                         assert!(updates.update_fail_htlcs.is_empty());
3130                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3131                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3132                         assert!(updates.update_fee.is_none());
3133                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3134                 },
3135                 _ => panic!("Unexpected event"),
3136         };
3137
3138         if messages_delivered >= 1 {
3139                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3140
3141                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3142                 assert_eq!(events_4.len(), 1);
3143                 match events_4[0] {
3144                         Event::PaymentSent { ref payment_preimage } => {
3145                                 assert_eq!(payment_preimage_1, *payment_preimage);
3146                         },
3147                         _ => panic!("Unexpected event"),
3148                 }
3149
3150                 if messages_delivered >= 2 {
3151                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3152                         check_added_monitors!(nodes[0], 1);
3153                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3154
3155                         if messages_delivered >= 3 {
3156                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3157                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3158                                 check_added_monitors!(nodes[1], 1);
3159
3160                                 if messages_delivered >= 4 {
3161                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3162                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3163                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3164                                         check_added_monitors!(nodes[1], 1);
3165
3166                                         if messages_delivered >= 5 {
3167                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3168                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3169                                                 check_added_monitors!(nodes[0], 1);
3170                                         }
3171                                 }
3172                         }
3173                 }
3174         }
3175
3176         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3177         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3178         if messages_delivered < 2 {
3179                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3180                 //TODO: Deduplicate PaymentSent events, then enable this if:
3181                 //if messages_delivered < 1 {
3182                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3183                         assert_eq!(events_4.len(), 1);
3184                         match events_4[0] {
3185                                 Event::PaymentSent { ref payment_preimage } => {
3186                                         assert_eq!(payment_preimage_1, *payment_preimage);
3187                                 },
3188                                 _ => panic!("Unexpected event"),
3189                         }
3190                 //}
3191         } else if messages_delivered == 2 {
3192                 // nodes[0] still wants its RAA + commitment_signed
3193                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3194         } else if messages_delivered == 3 {
3195                 // nodes[0] still wants its commitment_signed
3196                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3197         } else if messages_delivered == 4 {
3198                 // nodes[1] still wants its final RAA
3199                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3200         } else if messages_delivered == 5 {
3201                 // Everything was delivered...
3202                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3203         }
3204
3205         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3206         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3207         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3208
3209         // Channel should still work fine...
3210         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3211         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3212 }
3213
3214 #[test]
3215 fn test_drop_messages_peer_disconnect_a() {
3216         do_test_drop_messages_peer_disconnect(0);
3217         do_test_drop_messages_peer_disconnect(1);
3218         do_test_drop_messages_peer_disconnect(2);
3219         do_test_drop_messages_peer_disconnect(3);
3220 }
3221
3222 #[test]
3223 fn test_drop_messages_peer_disconnect_b() {
3224         do_test_drop_messages_peer_disconnect(4);
3225         do_test_drop_messages_peer_disconnect(5);
3226         do_test_drop_messages_peer_disconnect(6);
3227 }
3228
3229 #[test]
3230 fn test_funding_peer_disconnect() {
3231         // Test that we can lock in our funding tx while disconnected
3232         let node_cfgs = create_node_cfgs(2);
3233         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3234         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3235         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3236
3237         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3238         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3239
3240         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3241         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3242         assert_eq!(events_1.len(), 1);
3243         match events_1[0] {
3244                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3245                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3246                 },
3247                 _ => panic!("Unexpected event"),
3248         }
3249
3250         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3251
3252         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3253         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3254
3255         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3256         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3257         assert_eq!(events_2.len(), 2);
3258         let funding_locked = match events_2[0] {
3259                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3260                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3261                         msg.clone()
3262                 },
3263                 _ => panic!("Unexpected event"),
3264         };
3265         let bs_announcement_sigs = match events_2[1] {
3266                 MessageSendEvent::SendAnnouncementSignatures { 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
3273         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3274
3275         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3276         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3277         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3278         assert_eq!(events_3.len(), 2);
3279         let as_announcement_sigs = match events_3[0] {
3280                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3281                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3282                         msg.clone()
3283                 },
3284                 _ => panic!("Unexpected event"),
3285         };
3286         let (as_announcement, as_update) = match events_3[1] {
3287                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3288                         (msg.clone(), update_msg.clone())
3289                 },
3290                 _ => panic!("Unexpected event"),
3291         };
3292
3293         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3294         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3295         assert_eq!(events_4.len(), 1);
3296         let (_, bs_update) = match events_4[0] {
3297                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3298                         (msg.clone(), update_msg.clone())
3299                 },
3300                 _ => panic!("Unexpected event"),
3301         };
3302
3303         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3304         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3305         nodes[0].router.handle_channel_update(&as_update).unwrap();
3306
3307         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3308         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3309         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3310 }
3311
3312 #[test]
3313 fn test_drop_messages_peer_disconnect_dual_htlc() {
3314         // Test that we can handle reconnecting when both sides of a channel have pending
3315         // commitment_updates when we disconnect.
3316         let node_cfgs = create_node_cfgs(2);
3317         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3318         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3319         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3320
3321         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3322
3323         // Now try to send a second payment which will fail to send
3324         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3325         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3326
3327         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3328         check_added_monitors!(nodes[0], 1);
3329
3330         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3331         assert_eq!(events_1.len(), 1);
3332         match events_1[0] {
3333                 MessageSendEvent::UpdateHTLCs { .. } => {},
3334                 _ => panic!("Unexpected event"),
3335         }
3336
3337         assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3338         check_added_monitors!(nodes[1], 1);
3339
3340         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3341         assert_eq!(events_2.len(), 1);
3342         match events_2[0] {
3343                 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 } } => {
3344                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3345                         assert!(update_add_htlcs.is_empty());
3346                         assert_eq!(update_fulfill_htlcs.len(), 1);
3347                         assert!(update_fail_htlcs.is_empty());
3348                         assert!(update_fail_malformed_htlcs.is_empty());
3349                         assert!(update_fee.is_none());
3350
3351                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3352                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3353                         assert_eq!(events_3.len(), 1);
3354                         match events_3[0] {
3355                                 Event::PaymentSent { ref payment_preimage } => {
3356                                         assert_eq!(*payment_preimage, payment_preimage_1);
3357                                 },
3358                                 _ => panic!("Unexpected event"),
3359                         }
3360
3361                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3362                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3363                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3364                         check_added_monitors!(nodes[0], 1);
3365                 },
3366                 _ => panic!("Unexpected event"),
3367         }
3368
3369         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3370         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3371
3372         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3373         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3374         assert_eq!(reestablish_1.len(), 1);
3375         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3376         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3377         assert_eq!(reestablish_2.len(), 1);
3378
3379         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3380         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3381         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3382         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3383
3384         assert!(as_resp.0.is_none());
3385         assert!(bs_resp.0.is_none());
3386
3387         assert!(bs_resp.1.is_none());
3388         assert!(bs_resp.2.is_none());
3389
3390         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3391
3392         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3393         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3394         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3395         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3396         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3397         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3398         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3399         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3400         // No commitment_signed so get_event_msg's assert(len == 1) passes
3401         check_added_monitors!(nodes[1], 1);
3402
3403         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3404         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3405         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3406         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3407         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3408         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3409         assert!(bs_second_commitment_signed.update_fee.is_none());
3410         check_added_monitors!(nodes[1], 1);
3411
3412         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3413         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3414         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3415         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3416         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3417         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3418         assert!(as_commitment_signed.update_fee.is_none());
3419         check_added_monitors!(nodes[0], 1);
3420
3421         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3422         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3423         // No commitment_signed so get_event_msg's assert(len == 1) passes
3424         check_added_monitors!(nodes[0], 1);
3425
3426         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3427         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3428         // No commitment_signed so get_event_msg's assert(len == 1) passes
3429         check_added_monitors!(nodes[1], 1);
3430
3431         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3432         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3433         check_added_monitors!(nodes[1], 1);
3434
3435         expect_pending_htlcs_forwardable!(nodes[1]);
3436
3437         let events_5 = nodes[1].node.get_and_clear_pending_events();
3438         assert_eq!(events_5.len(), 1);
3439         match events_5[0] {
3440                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3441                         assert_eq!(payment_hash_2, *payment_hash);
3442                 },
3443                 _ => panic!("Unexpected event"),
3444         }
3445
3446         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3447         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3448         check_added_monitors!(nodes[0], 1);
3449
3450         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3451 }
3452
3453 #[test]
3454 fn test_invalid_channel_announcement() {
3455         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3456         let secp_ctx = Secp256k1::new();
3457         let node_cfgs = create_node_cfgs(2);
3458         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3459         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3460
3461         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3462
3463         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3464         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3465         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3466         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3467
3468         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3469
3470         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3471         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3472
3473         let as_network_key = nodes[0].node.get_our_node_id();
3474         let bs_network_key = nodes[1].node.get_our_node_id();
3475
3476         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3477
3478         let mut chan_announcement;
3479
3480         macro_rules! dummy_unsigned_msg {
3481                 () => {
3482                         msgs::UnsignedChannelAnnouncement {
3483                                 features: ChannelFeatures::supported(),
3484                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3485                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3486                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3487                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3488                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3489                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3490                                 excess_data: Vec::new(),
3491                         };
3492                 }
3493         }
3494
3495         macro_rules! sign_msg {
3496                 ($unsigned_msg: expr) => {
3497                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3498                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3499                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3500                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3501                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3502                         chan_announcement = msgs::ChannelAnnouncement {
3503                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3504                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3505                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3506                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3507                                 contents: $unsigned_msg
3508                         }
3509                 }
3510         }
3511
3512         let unsigned_msg = dummy_unsigned_msg!();
3513         sign_msg!(unsigned_msg);
3514         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3515         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 } );
3516
3517         // Configured with Network::Testnet
3518         let mut unsigned_msg = dummy_unsigned_msg!();
3519         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3520         sign_msg!(unsigned_msg);
3521         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3522
3523         let mut unsigned_msg = dummy_unsigned_msg!();
3524         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3525         sign_msg!(unsigned_msg);
3526         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3527 }
3528
3529 #[test]
3530 fn test_no_txn_manager_serialize_deserialize() {
3531         let node_cfgs = create_node_cfgs(2);
3532         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3533         let new_chan_monitor: test_utils::TestChannelMonitor;
3534         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3535         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3536
3537         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3538
3539         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3540
3541         let nodes_0_serialized = nodes[0].node.encode();
3542         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3543         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3544
3545         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 }));
3546         nodes[0].chan_monitor = &new_chan_monitor;
3547         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3548         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3549         assert!(chan_0_monitor_read.is_empty());
3550
3551         let mut nodes_0_read = &nodes_0_serialized[..];
3552         let config = UserConfig::default();
3553         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3554         let (_, nodes_0_deserialized_tmp) = {
3555                 let mut channel_monitors = HashMap::new();
3556                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3557                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3558                         default_config: config,
3559                         keys_manager,
3560                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3561                         monitor: nodes[0].chan_monitor,
3562                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3563                         logger: Arc::new(test_utils::TestLogger::new()),
3564                         channel_monitors: &mut channel_monitors,
3565                 }).unwrap()
3566         };
3567         nodes_0_deserialized = nodes_0_deserialized_tmp;
3568         assert!(nodes_0_read.is_empty());
3569
3570         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3571         nodes[0].node = &nodes_0_deserialized;
3572         nodes[0].block_notifier.register_listener(nodes[0].node);
3573         assert_eq!(nodes[0].node.list_channels().len(), 1);
3574         check_added_monitors!(nodes[0], 1);
3575
3576         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3577         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3578         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3579         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3580
3581         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3582         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3583         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3584         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3585
3586         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3587         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3588         for node in nodes.iter() {
3589                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3590                 node.router.handle_channel_update(&as_update).unwrap();
3591                 node.router.handle_channel_update(&bs_update).unwrap();
3592         }
3593
3594         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3595 }
3596
3597 #[test]
3598 fn test_simple_manager_serialize_deserialize() {
3599         let node_cfgs = create_node_cfgs(2);
3600         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3601         let new_chan_monitor: test_utils::TestChannelMonitor;
3602         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3603         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3604         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3605
3606         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3607         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3608
3609         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3610
3611         let nodes_0_serialized = nodes[0].node.encode();
3612         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3613         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3614
3615         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 }));
3616         nodes[0].chan_monitor = &new_chan_monitor;
3617         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3618         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3619         assert!(chan_0_monitor_read.is_empty());
3620
3621         let mut nodes_0_read = &nodes_0_serialized[..];
3622         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3623         let (_, nodes_0_deserialized_tmp) = {
3624                 let mut channel_monitors = HashMap::new();
3625                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3626                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3627                         default_config: UserConfig::default(),
3628                         keys_manager,
3629                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3630                         monitor: nodes[0].chan_monitor,
3631                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3632                         logger: Arc::new(test_utils::TestLogger::new()),
3633                         channel_monitors: &mut channel_monitors,
3634                 }).unwrap()
3635         };
3636         nodes_0_deserialized = nodes_0_deserialized_tmp;
3637         assert!(nodes_0_read.is_empty());
3638
3639         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3640         nodes[0].node = &nodes_0_deserialized;
3641         check_added_monitors!(nodes[0], 1);
3642
3643         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3644
3645         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3646         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3647 }
3648
3649 #[test]
3650 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3651         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3652         let node_cfgs = create_node_cfgs(4);
3653         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3654         let new_chan_monitor: test_utils::TestChannelMonitor;
3655         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3656         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3657         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3658         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3659         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3660
3661         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3662
3663         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3664         let nodes_0_serialized = nodes[0].node.encode();
3665
3666         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3667         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3668         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3669         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3670
3671         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3672         // nodes[3])
3673         let mut node_0_monitors_serialized = Vec::new();
3674         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3675                 let mut writer = test_utils::TestVecWriter(Vec::new());
3676                 monitor.1.write_for_disk(&mut writer).unwrap();
3677                 node_0_monitors_serialized.push(writer.0);
3678         }
3679
3680         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 }));
3681         nodes[0].chan_monitor = &new_chan_monitor;
3682         let mut node_0_monitors = Vec::new();
3683         for serialized in node_0_monitors_serialized.iter() {
3684                 let mut read = &serialized[..];
3685                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3686                 assert!(read.is_empty());
3687                 node_0_monitors.push(monitor);
3688         }
3689
3690         let mut nodes_0_read = &nodes_0_serialized[..];
3691         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3692         let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3693                 default_config: UserConfig::default(),
3694                 keys_manager,
3695                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3696                 monitor: nodes[0].chan_monitor,
3697                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3698                 logger: Arc::new(test_utils::TestLogger::new()),
3699                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3700         }).unwrap();
3701         nodes_0_deserialized = nodes_0_deserialized_tmp;
3702         assert!(nodes_0_read.is_empty());
3703
3704         { // Channel close should result in a commitment tx and an HTLC tx
3705                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3706                 assert_eq!(txn.len(), 2);
3707                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3708                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3709         }
3710
3711         for monitor in node_0_monitors.drain(..) {
3712                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3713                 check_added_monitors!(nodes[0], 1);
3714         }
3715         nodes[0].node = &nodes_0_deserialized;
3716
3717         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3718         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3719         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3720         //... and we can even still claim the payment!
3721         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3722
3723         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3724         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3725         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3726         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3727         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3728         assert_eq!(msg_events.len(), 1);
3729         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3730                 match action {
3731                         &ErrorAction::SendErrorMessage { ref msg } => {
3732                                 assert_eq!(msg.channel_id, channel_id);
3733                         },
3734                         _ => panic!("Unexpected event!"),
3735                 }
3736         }
3737 }
3738
3739 macro_rules! check_spendable_outputs {
3740         ($node: expr, $der_idx: expr) => {
3741                 {
3742                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3743                         let mut txn = Vec::new();
3744                         for event in events {
3745                                 match event {
3746                                         Event::SpendableOutputs { ref outputs } => {
3747                                                 for outp in outputs {
3748                                                         match *outp {
3749                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3750                                                                         let input = TxIn {
3751                                                                                 previous_output: outpoint.clone(),
3752                                                                                 script_sig: Script::new(),
3753                                                                                 sequence: 0,
3754                                                                                 witness: Vec::new(),
3755                                                                         };
3756                                                                         let outp = TxOut {
3757                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3758                                                                                 value: output.value,
3759                                                                         };
3760                                                                         let mut spend_tx = Transaction {
3761                                                                                 version: 2,
3762                                                                                 lock_time: 0,
3763                                                                                 input: vec![input],
3764                                                                                 output: vec![outp],
3765                                                                         };
3766                                                                         let secp_ctx = Secp256k1::new();
3767                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3768                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3769                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3770                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3771                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3772                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3773                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3774                                                                         txn.push(spend_tx);
3775                                                                 },
3776                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3777                                                                         let input = TxIn {
3778                                                                                 previous_output: outpoint.clone(),
3779                                                                                 script_sig: Script::new(),
3780                                                                                 sequence: *to_self_delay as u32,
3781                                                                                 witness: Vec::new(),
3782                                                                         };
3783                                                                         let outp = TxOut {
3784                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3785                                                                                 value: output.value,
3786                                                                         };
3787                                                                         let mut spend_tx = Transaction {
3788                                                                                 version: 2,
3789                                                                                 lock_time: 0,
3790                                                                                 input: vec![input],
3791                                                                                 output: vec![outp],
3792                                                                         };
3793                                                                         let secp_ctx = Secp256k1::new();
3794                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3795                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3796                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3797                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3798                                                                         spend_tx.input[0].witness.push(vec!(0));
3799                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3800                                                                         txn.push(spend_tx);
3801                                                                 },
3802                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3803                                                                         let secp_ctx = Secp256k1::new();
3804                                                                         let input = TxIn {
3805                                                                                 previous_output: outpoint.clone(),
3806                                                                                 script_sig: Script::new(),
3807                                                                                 sequence: 0,
3808                                                                                 witness: Vec::new(),
3809                                                                         };
3810                                                                         let outp = TxOut {
3811                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3812                                                                                 value: output.value,
3813                                                                         };
3814                                                                         let mut spend_tx = Transaction {
3815                                                                                 version: 2,
3816                                                                                 lock_time: 0,
3817                                                                                 input: vec![input],
3818                                                                                 output: vec![outp.clone()],
3819                                                                         };
3820                                                                         let secret = {
3821                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3822                                                                                         Ok(master_key) => {
3823                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3824                                                                                                         Ok(key) => key,
3825                                                                                                         Err(_) => panic!("Your RNG is busted"),
3826                                                                                                 }
3827                                                                                         }
3828                                                                                         Err(_) => panic!("Your rng is busted"),
3829                                                                                 }
3830                                                                         };
3831                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3832                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3833                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3834                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3835                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3836                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3837                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3838                                                                         txn.push(spend_tx);
3839                                                                 },
3840                                                         }
3841                                                 }
3842                                         },
3843                                         _ => panic!("Unexpected event"),
3844                                 };
3845                         }
3846                         txn
3847                 }
3848         }
3849 }
3850
3851 #[test]
3852 fn test_claim_sizeable_push_msat() {
3853         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3854         let node_cfgs = create_node_cfgs(2);
3855         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3856         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3857
3858         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3859         nodes[1].node.force_close_channel(&chan.2);
3860         check_closed_broadcast!(nodes[1], false);
3861         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3862         assert_eq!(node_txn.len(), 1);
3863         check_spends!(node_txn[0], chan.3.clone());
3864         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
3865
3866         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3867         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3868         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3869         assert_eq!(spend_txn.len(), 1);
3870         check_spends!(spend_txn[0], node_txn[0].clone());
3871 }
3872
3873 #[test]
3874 fn test_claim_on_remote_sizeable_push_msat() {
3875         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3876         // to_remote output is encumbered by a P2WPKH
3877         let node_cfgs = create_node_cfgs(2);
3878         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3879         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3880
3881         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3882         nodes[0].node.force_close_channel(&chan.2);
3883         check_closed_broadcast!(nodes[0], false);
3884
3885         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3886         assert_eq!(node_txn.len(), 1);
3887         check_spends!(node_txn[0], chan.3.clone());
3888         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
3889
3890         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3891         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3892         check_closed_broadcast!(nodes[1], false);
3893         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3894         assert_eq!(spend_txn.len(), 2);
3895         assert_eq!(spend_txn[0], spend_txn[1]);
3896         check_spends!(spend_txn[0], node_txn[0].clone());
3897 }
3898
3899 #[test]
3900 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3901         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3902         // to_remote output is encumbered by a P2WPKH
3903
3904         let node_cfgs = create_node_cfgs(2);
3905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3906         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3907
3908         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
3909         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3910         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();
3911         assert_eq!(revoked_local_txn[0].input.len(), 1);
3912         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3913
3914         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3915         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3916         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3917         check_closed_broadcast!(nodes[1], false);
3918
3919         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3920         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3921         assert_eq!(spend_txn.len(), 4);
3922         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3923         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3924         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3925         check_spends!(spend_txn[1], node_txn[0].clone());
3926 }
3927
3928 #[test]
3929 fn test_static_spendable_outputs_preimage_tx() {
3930         let node_cfgs = create_node_cfgs(2);
3931         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3932         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3933
3934         // Create some initial channels
3935         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3936
3937         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3938
3939         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();
3940         assert_eq!(commitment_tx[0].input.len(), 1);
3941         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3942
3943         // Settle A's commitment tx on B's chain
3944         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3945         assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
3946         check_added_monitors!(nodes[1], 1);
3947         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3948         let events = nodes[1].node.get_and_clear_pending_msg_events();
3949         match events[0] {
3950                 MessageSendEvent::UpdateHTLCs { .. } => {},
3951                 _ => panic!("Unexpected event"),
3952         }
3953         match events[1] {
3954                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3955                 _ => panic!("Unexepected event"),
3956         }
3957
3958         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3959         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: 2 (1 preimage tx)
3960         assert_eq!(node_txn.len(), 4);
3961         check_spends!(node_txn[0], commitment_tx[0].clone());
3962         assert_eq!(node_txn[0], node_txn[3]);
3963         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3964 eprintln!("{:?}", node_txn[1]);
3965         check_spends!(node_txn[1], chan_1.3.clone());
3966         check_spends!(node_txn[2], node_txn[1]);
3967
3968         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3969         assert_eq!(spend_txn.len(), 2);
3970         assert_eq!(spend_txn[0], spend_txn[1]);
3971         check_spends!(spend_txn[0], node_txn[0].clone());
3972 }
3973
3974 #[test]
3975 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3976         let node_cfgs = create_node_cfgs(2);
3977         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3978         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3979
3980         // Create some initial channels
3981         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3982
3983         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3984         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();
3985         assert_eq!(revoked_local_txn[0].input.len(), 1);
3986         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3987
3988         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3989
3990         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3991         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3992         check_closed_broadcast!(nodes[1], false);
3993
3994         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3995         assert_eq!(node_txn.len(), 3);
3996         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3997         assert_eq!(node_txn[0].input.len(), 2);
3998         check_spends!(node_txn[0], revoked_local_txn[0].clone());
3999
4000         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4001         assert_eq!(spend_txn.len(), 2);
4002         assert_eq!(spend_txn[0], spend_txn[1]);
4003         check_spends!(spend_txn[0], node_txn[0].clone());
4004 }
4005
4006 #[test]
4007 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4008         let node_cfgs = create_node_cfgs(2);
4009         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4010         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4011
4012         // Create some initial channels
4013         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4014
4015         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4016         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();
4017         assert_eq!(revoked_local_txn[0].input.len(), 1);
4018         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4019
4020         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4021
4022         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4023         // A will generate HTLC-Timeout from revoked commitment tx
4024         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4025         check_closed_broadcast!(nodes[0], false);
4026
4027         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4028         assert_eq!(revoked_htlc_txn.len(), 3);
4029         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4030         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4031         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4032         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4033         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
4034
4035         // B will generate justice tx from A's revoked commitment/HTLC tx
4036         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4037         check_closed_broadcast!(nodes[1], false);
4038
4039         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4040         assert_eq!(node_txn.len(), 5);
4041         assert_eq!(node_txn[3].input.len(), 1);
4042         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4043
4044         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4045         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4046         assert_eq!(spend_txn.len(), 3);
4047         assert_eq!(spend_txn[0], spend_txn[1]);
4048         check_spends!(spend_txn[0], node_txn[0].clone());
4049         check_spends!(spend_txn[2], node_txn[3].clone());
4050 }
4051
4052 #[test]
4053 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4054         let node_cfgs = create_node_cfgs(2);
4055         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4056         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4057
4058         // Create some initial channels
4059         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4060
4061         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4062         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();
4063         assert_eq!(revoked_local_txn[0].input.len(), 1);
4064         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4065
4066         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4067
4068         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4069         // B will generate HTLC-Success from revoked commitment tx
4070         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4071         check_closed_broadcast!(nodes[1], false);
4072         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4073
4074         assert_eq!(revoked_htlc_txn.len(), 3);
4075         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4076         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4077         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4078         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4079
4080         // A will generate justice tx from B's revoked commitment/HTLC tx
4081         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4082         check_closed_broadcast!(nodes[0], false);
4083
4084         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4085         assert_eq!(node_txn.len(), 4);
4086         assert_eq!(node_txn[3].input.len(), 1);
4087         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4088
4089         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4090         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4091         assert_eq!(spend_txn.len(), 5);
4092         assert_eq!(spend_txn[0], spend_txn[2]);
4093         assert_eq!(spend_txn[1], spend_txn[3]);
4094         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4095         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
4096         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
4097 }
4098
4099 #[test]
4100 fn test_onchain_to_onchain_claim() {
4101         // Test that in case of channel closure, we detect the state of output thanks to
4102         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4103         // First, have C claim an HTLC against its own latest commitment transaction.
4104         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4105         // channel.
4106         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4107         // gets broadcast.
4108
4109         let node_cfgs = create_node_cfgs(3);
4110         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4111         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4112
4113         // Create some initial channels
4114         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4115         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4116
4117         // Rebalance the network a bit by relaying one payment through all the channels ...
4118         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4119         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4120
4121         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4122         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4123         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();
4124         check_spends!(commitment_tx[0], chan_2.3.clone());
4125         nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4126         check_added_monitors!(nodes[2], 1);
4127         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4128         assert!(updates.update_add_htlcs.is_empty());
4129         assert!(updates.update_fail_htlcs.is_empty());
4130         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4131         assert!(updates.update_fail_malformed_htlcs.is_empty());
4132
4133         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4134         check_closed_broadcast!(nodes[2], false);
4135
4136         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4137         assert_eq!(c_txn.len(), 4);
4138         assert_eq!(c_txn[0], c_txn[2]);
4139         assert_eq!(c_txn[0], c_txn[3]);
4140         assert_eq!(commitment_tx[0], c_txn[1]);
4141         check_spends!(c_txn[1], chan_2.3.clone());
4142         check_spends!(c_txn[2], c_txn[1].clone());
4143         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4144         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4145         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4146         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4147
4148         // 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
4149         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4150         {
4151                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4152                 assert_eq!(b_txn.len(), 4);
4153                 assert_eq!(b_txn[0], b_txn[3]);
4154                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4155                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4156                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4157                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4158                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4159                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4160                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4161                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4162                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4163                 b_txn.clear();
4164         }
4165         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4166         check_added_monitors!(nodes[1], 1);
4167         match msg_events[0] {
4168                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4169                 _ => panic!("Unexpected event"),
4170         }
4171         match msg_events[1] {
4172                 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, .. } } => {
4173                         assert!(update_add_htlcs.is_empty());
4174                         assert!(update_fail_htlcs.is_empty());
4175                         assert_eq!(update_fulfill_htlcs.len(), 1);
4176                         assert!(update_fail_malformed_htlcs.is_empty());
4177                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4178                 },
4179                 _ => panic!("Unexpected event"),
4180         };
4181         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4182         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();
4183         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4184         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4185         assert_eq!(b_txn.len(), 4);
4186         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
4187         check_spends!(b_txn[2], b_txn[1]); // HTLC-Success tx, as a part of the local txn rebroadcast by ChannelManager in the force close
4188         assert_eq!(b_txn[0], b_txn[3]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
4189         check_spends!(b_txn[0], commitment_tx[0].clone());
4190         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4191         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4192         assert_eq!(b_txn[2].lock_time, 0); // Success tx
4193
4194         check_closed_broadcast!(nodes[1], false);
4195 }
4196
4197 #[test]
4198 fn test_duplicate_payment_hash_one_failure_one_success() {
4199         // Topology : A --> B --> C
4200         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4201         let node_cfgs = create_node_cfgs(3);
4202         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4203         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4204
4205         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4206         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4207
4208         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4209         *nodes[0].network_payment_count.borrow_mut() -= 1;
4210         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4211
4212         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();
4213         assert_eq!(commitment_txn[0].input.len(), 1);
4214         check_spends!(commitment_txn[0], chan_2.3.clone());
4215
4216         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4217         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4218         check_closed_broadcast!(nodes[1], false);
4219
4220         let htlc_timeout_tx;
4221         { // Extract one of the two HTLC-Timeout transaction
4222                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4223                 assert_eq!(node_txn.len(), 7);
4224                 assert_eq!(node_txn[0], node_txn[5]);
4225                 assert_eq!(node_txn[1], node_txn[6]);
4226                 check_spends!(node_txn[0], commitment_txn[0].clone());
4227                 assert_eq!(node_txn[0].input.len(), 1);
4228                 check_spends!(node_txn[1], commitment_txn[0].clone());
4229                 assert_eq!(node_txn[1].input.len(), 1);
4230                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4231                 check_spends!(node_txn[2], chan_2.3.clone());
4232                 check_spends!(node_txn[3], node_txn[2].clone());
4233                 check_spends!(node_txn[4], node_txn[2].clone());
4234                 htlc_timeout_tx = node_txn[1].clone();
4235         }
4236
4237         nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4238         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4239         check_added_monitors!(nodes[2], 2);
4240         let events = nodes[2].node.get_and_clear_pending_msg_events();
4241         match events[0] {
4242                 MessageSendEvent::UpdateHTLCs { .. } => {},
4243                 _ => panic!("Unexpected event"),
4244         }
4245         match events[1] {
4246                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4247                 _ => panic!("Unexepected event"),
4248         }
4249         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4250         assert_eq!(htlc_success_txn.len(), 7);
4251         check_spends!(htlc_success_txn[2], chan_2.3.clone());
4252         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4253         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4254         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4255         assert_eq!(htlc_success_txn[0].input.len(), 1);
4256         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4257         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4258         assert_eq!(htlc_success_txn[1].input.len(), 1);
4259         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4260         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4261         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4262         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4263
4264         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4265         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4266         expect_pending_htlcs_forwardable!(nodes[1]);
4267         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4268         assert!(htlc_updates.update_add_htlcs.is_empty());
4269         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4270         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4271         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4272         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4273         check_added_monitors!(nodes[1], 1);
4274
4275         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4276         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4277         {
4278                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4279                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4280                 assert_eq!(events.len(), 1);
4281                 match events[0] {
4282                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4283                         },
4284                         _ => { panic!("Unexpected event"); }
4285                 }
4286         }
4287         let events = nodes[0].node.get_and_clear_pending_events();
4288         match events[0] {
4289                 Event::PaymentFailed { ref payment_hash, .. } => {
4290                         assert_eq!(*payment_hash, duplicate_payment_hash);
4291                 }
4292                 _ => panic!("Unexpected event"),
4293         }
4294
4295         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4296         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4297         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4298         assert!(updates.update_add_htlcs.is_empty());
4299         assert!(updates.update_fail_htlcs.is_empty());
4300         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4301         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4302         assert!(updates.update_fail_malformed_htlcs.is_empty());
4303         check_added_monitors!(nodes[1], 1);
4304
4305         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4306         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4307
4308         let events = nodes[0].node.get_and_clear_pending_events();
4309         match events[0] {
4310                 Event::PaymentSent { ref payment_preimage } => {
4311                         assert_eq!(*payment_preimage, our_payment_preimage);
4312                 }
4313                 _ => panic!("Unexpected event"),
4314         }
4315 }
4316
4317 #[test]
4318 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4319         let node_cfgs = create_node_cfgs(2);
4320         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4321         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4322
4323         // Create some initial channels
4324         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4325
4326         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4327         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();
4328         assert_eq!(local_txn[0].input.len(), 1);
4329         check_spends!(local_txn[0], chan_1.3.clone());
4330
4331         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4332         nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4333         check_added_monitors!(nodes[1], 1);
4334         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4335         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4336         let events = nodes[1].node.get_and_clear_pending_msg_events();
4337         match events[0] {
4338                 MessageSendEvent::UpdateHTLCs { .. } => {},
4339                 _ => panic!("Unexpected event"),
4340         }
4341         match events[1] {
4342                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4343                 _ => panic!("Unexepected event"),
4344         }
4345         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4346         assert_eq!(node_txn[0].input.len(), 1);
4347         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4348         check_spends!(node_txn[0], local_txn[0].clone());
4349
4350         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4351         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4352         assert_eq!(spend_txn.len(), 2);
4353         check_spends!(spend_txn[0], node_txn[0].clone());
4354         check_spends!(spend_txn[1], node_txn[2].clone());
4355 }
4356
4357 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4358         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4359         // unrevoked commitment transaction.
4360         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4361         // a remote RAA before they could be failed backwards (and combinations thereof).
4362         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4363         // use the same payment hashes.
4364         // Thus, we use a six-node network:
4365         //
4366         // A \         / E
4367         //    - C - D -
4368         // B /         \ F
4369         // And test where C fails back to A/B when D announces its latest commitment transaction
4370         let node_cfgs = create_node_cfgs(6);
4371         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4372         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4373
4374         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4375         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4376         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4377         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4378         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4379
4380         // Rebalance and check output sanity...
4381         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4382         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4383         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);
4384
4385         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4386         // 0th HTLC:
4387         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
4388         // 1st HTLC:
4389         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
4390         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();
4391         // 2nd HTLC:
4392         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
4393         // 3rd HTLC:
4394         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
4395         // 4th HTLC:
4396         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4397         // 5th HTLC:
4398         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4399         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4400         // 6th HTLC:
4401         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4402         // 7th HTLC:
4403         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4404
4405         // 8th HTLC:
4406         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4407         // 9th HTLC:
4408         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();
4409         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
4410
4411         // 10th HTLC:
4412         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
4413         // 11th HTLC:
4414         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4415         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4416
4417         // Double-check that six of the new HTLC were added
4418         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4419         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4420         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);
4421         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);
4422
4423         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4424         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4425         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4426         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4427         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4428         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4429         check_added_monitors!(nodes[4], 0);
4430         expect_pending_htlcs_forwardable!(nodes[4]);
4431         check_added_monitors!(nodes[4], 1);
4432
4433         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4434         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4435         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4436         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4437         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4438         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4439
4440         // Fail 3rd below-dust and 7th above-dust HTLCs
4441         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4442         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4443         check_added_monitors!(nodes[5], 0);
4444         expect_pending_htlcs_forwardable!(nodes[5]);
4445         check_added_monitors!(nodes[5], 1);
4446
4447         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4448         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4449         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4450         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4451
4452         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();
4453
4454         expect_pending_htlcs_forwardable!(nodes[3]);
4455         check_added_monitors!(nodes[3], 1);
4456         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4457         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4458         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4459         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4460         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4461         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4462         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4463         if deliver_last_raa {
4464                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4465         } else {
4466                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4467         }
4468
4469         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4470         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4471         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4472         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4473         //
4474         // We now broadcast the latest commitment transaction, which *should* result in failures for
4475         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4476         // the non-broadcast above-dust HTLCs.
4477         //
4478         // Alternatively, we may broadcast the previous commitment transaction, which should only
4479         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4480         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();
4481
4482         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4483         if announce_latest {
4484                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4485         } else {
4486                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4487         }
4488         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4489         check_closed_broadcast!(nodes[2], false);
4490         expect_pending_htlcs_forwardable!(nodes[2]);
4491         check_added_monitors!(nodes[2], 2);
4492
4493         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4494         assert_eq!(cs_msgs.len(), 2);
4495         let mut a_done = false;
4496         for msg in cs_msgs {
4497                 match msg {
4498                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4499                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4500                                 // should be failed-backwards here.
4501                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4502                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4503                                         for htlc in &updates.update_fail_htlcs {
4504                                                 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 });
4505                                         }
4506                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4507                                         assert!(!a_done);
4508                                         a_done = true;
4509                                         &nodes[0]
4510                                 } else {
4511                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4512                                         for htlc in &updates.update_fail_htlcs {
4513                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4514                                         }
4515                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4516                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4517                                         &nodes[1]
4518                                 };
4519                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4520                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4521                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4522                                 if announce_latest {
4523                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4524                                         if *node_id == nodes[0].node.get_our_node_id() {
4525                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4526                                         }
4527                                 }
4528                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4529                         },
4530                         _ => panic!("Unexpected event"),
4531                 }
4532         }
4533
4534         let as_events = nodes[0].node.get_and_clear_pending_events();
4535         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4536         let mut as_failds = HashSet::new();
4537         for event in as_events.iter() {
4538                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4539                         assert!(as_failds.insert(*payment_hash));
4540                         if *payment_hash != payment_hash_2 {
4541                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4542                         } else {
4543                                 assert!(!rejected_by_dest);
4544                         }
4545                 } else { panic!("Unexpected event"); }
4546         }
4547         assert!(as_failds.contains(&payment_hash_1));
4548         assert!(as_failds.contains(&payment_hash_2));
4549         if announce_latest {
4550                 assert!(as_failds.contains(&payment_hash_3));
4551                 assert!(as_failds.contains(&payment_hash_5));
4552         }
4553         assert!(as_failds.contains(&payment_hash_6));
4554
4555         let bs_events = nodes[1].node.get_and_clear_pending_events();
4556         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4557         let mut bs_failds = HashSet::new();
4558         for event in bs_events.iter() {
4559                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4560                         assert!(bs_failds.insert(*payment_hash));
4561                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4562                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4563                         } else {
4564                                 assert!(!rejected_by_dest);
4565                         }
4566                 } else { panic!("Unexpected event"); }
4567         }
4568         assert!(bs_failds.contains(&payment_hash_1));
4569         assert!(bs_failds.contains(&payment_hash_2));
4570         if announce_latest {
4571                 assert!(bs_failds.contains(&payment_hash_4));
4572         }
4573         assert!(bs_failds.contains(&payment_hash_5));
4574
4575         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4576         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4577         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4578         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4579         // PaymentFailureNetworkUpdates.
4580         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4581         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4582         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4583         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4584         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4585                 match event {
4586                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4587                         _ => panic!("Unexpected event"),
4588                 }
4589         }
4590 }
4591
4592 #[test]
4593 fn test_fail_backwards_latest_remote_announce_a() {
4594         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4595 }
4596
4597 #[test]
4598 fn test_fail_backwards_latest_remote_announce_b() {
4599         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4600 }
4601
4602 #[test]
4603 fn test_fail_backwards_previous_remote_announce() {
4604         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4605         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4606         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4607 }
4608
4609 #[test]
4610 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4611         let node_cfgs = create_node_cfgs(2);
4612         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4613         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4614
4615         // Create some initial channels
4616         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4617
4618         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4619         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();
4620         assert_eq!(local_txn[0].input.len(), 1);
4621         check_spends!(local_txn[0], chan_1.3.clone());
4622
4623         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4624         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4625         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4626         check_closed_broadcast!(nodes[0], false);
4627
4628         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4629         assert_eq!(node_txn[0].input.len(), 1);
4630         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4631         check_spends!(node_txn[0], local_txn[0].clone());
4632
4633         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4634         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4635         assert_eq!(spend_txn.len(), 8);
4636         assert_eq!(spend_txn[0], spend_txn[2]);
4637         assert_eq!(spend_txn[0], spend_txn[4]);
4638         assert_eq!(spend_txn[0], spend_txn[6]);
4639         assert_eq!(spend_txn[1], spend_txn[3]);
4640         assert_eq!(spend_txn[1], spend_txn[5]);
4641         assert_eq!(spend_txn[1], spend_txn[7]);
4642         check_spends!(spend_txn[0], local_txn[0].clone());
4643         check_spends!(spend_txn[1], node_txn[0].clone());
4644 }
4645
4646 #[test]
4647 fn test_static_output_closing_tx() {
4648         let node_cfgs = create_node_cfgs(2);
4649         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4650         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4651
4652         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4653
4654         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4655         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4656
4657         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4658         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4659         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4660         assert_eq!(spend_txn.len(), 1);
4661         check_spends!(spend_txn[0], closing_tx.clone());
4662
4663         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4664         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4665         assert_eq!(spend_txn.len(), 1);
4666         check_spends!(spend_txn[0], closing_tx);
4667 }
4668
4669 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4670         let node_cfgs = create_node_cfgs(2);
4671         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4672         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4673         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4674
4675         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4676
4677         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4678         // present in B's local commitment transaction, but none of A's commitment transactions.
4679         assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4680         check_added_monitors!(nodes[1], 1);
4681
4682         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4683         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4684         let events = nodes[0].node.get_and_clear_pending_events();
4685         assert_eq!(events.len(), 1);
4686         match events[0] {
4687                 Event::PaymentSent { payment_preimage } => {
4688                         assert_eq!(payment_preimage, our_payment_preimage);
4689                 },
4690                 _ => panic!("Unexpected event"),
4691         }
4692
4693         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4694         check_added_monitors!(nodes[0], 1);
4695         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4696         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4697         check_added_monitors!(nodes[1], 1);
4698
4699         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4700         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4701                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4702                 header.prev_blockhash = header.bitcoin_hash();
4703         }
4704         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4705         check_closed_broadcast!(nodes[1], false);
4706 }
4707
4708 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4709         let node_cfgs = create_node_cfgs(2);
4710         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4711         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4712         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4713
4714         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();
4715         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4716         nodes[0].node.send_payment(route, payment_hash).unwrap();
4717         check_added_monitors!(nodes[0], 1);
4718
4719         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4720
4721         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4722         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4723         // to "time out" the HTLC.
4724
4725         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4726
4727         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4728                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4729                 header.prev_blockhash = header.bitcoin_hash();
4730         }
4731         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4732         check_closed_broadcast!(nodes[0], false);
4733 }
4734
4735 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4736         let node_cfgs = create_node_cfgs(3);
4737         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4738         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4739         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4740
4741         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4742         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4743         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4744         // actually revoked.
4745         let htlc_value = if use_dust { 50000 } else { 3000000 };
4746         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4747         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4748         expect_pending_htlcs_forwardable!(nodes[1]);
4749         check_added_monitors!(nodes[1], 1);
4750
4751         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4752         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4753         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4754         check_added_monitors!(nodes[0], 1);
4755         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4756         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4757         check_added_monitors!(nodes[1], 1);
4758         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4759         check_added_monitors!(nodes[1], 1);
4760         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4761
4762         if check_revoke_no_close {
4763                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4764                 check_added_monitors!(nodes[0], 1);
4765         }
4766
4767         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4768         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4769                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4770                 header.prev_blockhash = header.bitcoin_hash();
4771         }
4772         if !check_revoke_no_close {
4773                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4774                 check_closed_broadcast!(nodes[0], false);
4775         } else {
4776                 let events = nodes[0].node.get_and_clear_pending_events();
4777                 assert_eq!(events.len(), 1);
4778                 match events[0] {
4779                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4780                                 assert_eq!(payment_hash, our_payment_hash);
4781                                 assert!(rejected_by_dest);
4782                         },
4783                         _ => panic!("Unexpected event"),
4784                 }
4785         }
4786 }
4787
4788 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4789 // There are only a few cases to test here:
4790 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4791 //    broadcastable commitment transactions result in channel closure,
4792 //  * its included in an unrevoked-but-previous remote commitment transaction,
4793 //  * its included in the latest remote or local commitment transactions.
4794 // We test each of the three possible commitment transactions individually and use both dust and
4795 // non-dust HTLCs.
4796 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4797 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4798 // tested for at least one of the cases in other tests.
4799 #[test]
4800 fn htlc_claim_single_commitment_only_a() {
4801         do_htlc_claim_local_commitment_only(true);
4802         do_htlc_claim_local_commitment_only(false);
4803
4804         do_htlc_claim_current_remote_commitment_only(true);
4805         do_htlc_claim_current_remote_commitment_only(false);
4806 }
4807
4808 #[test]
4809 fn htlc_claim_single_commitment_only_b() {
4810         do_htlc_claim_previous_remote_commitment_only(true, false);
4811         do_htlc_claim_previous_remote_commitment_only(false, false);
4812         do_htlc_claim_previous_remote_commitment_only(true, true);
4813         do_htlc_claim_previous_remote_commitment_only(false, true);
4814 }
4815
4816 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>)
4817         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4818                                 F2: FnMut(),
4819 {
4820         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);
4821 }
4822
4823 // test_case
4824 // 0: node1 fails backward
4825 // 1: final node fails backward
4826 // 2: payment completed but the user rejects the payment
4827 // 3: final node fails backward (but tamper onion payloads from node0)
4828 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4829 // 200: trigger error in the final node and tamper returning fail_htlc
4830 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>)
4831         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4832                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4833                                 F3: FnMut(),
4834 {
4835
4836         // reset block height
4837         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4838         for ix in 0..nodes.len() {
4839                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4840         }
4841
4842         macro_rules! expect_event {
4843                 ($node: expr, $event_type: path) => {{
4844                         let events = $node.node.get_and_clear_pending_events();
4845                         assert_eq!(events.len(), 1);
4846                         match events[0] {
4847                                 $event_type { .. } => {},
4848                                 _ => panic!("Unexpected event"),
4849                         }
4850                 }}
4851         }
4852
4853         macro_rules! expect_htlc_forward {
4854                 ($node: expr) => {{
4855                         expect_event!($node, Event::PendingHTLCsForwardable);
4856                         $node.node.process_pending_htlc_forwards();
4857                 }}
4858         }
4859
4860         // 0 ~~> 2 send payment
4861         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4862         check_added_monitors!(nodes[0], 1);
4863         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4864         // temper update_add (0 => 1)
4865         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4866         if test_case == 0 || test_case == 3 || test_case == 100 {
4867                 callback_msg(&mut update_add_0);
4868                 callback_node();
4869         }
4870         // 0 => 1 update_add & CS
4871         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4872         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4873
4874         let update_1_0 = match test_case {
4875                 0|100 => { // intermediate node failure; fail backward to 0
4876                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4877                         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));
4878                         update_1_0
4879                 },
4880                 1|2|3|200 => { // final node failure; forwarding to 2
4881                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4882                         // forwarding on 1
4883                         if test_case != 200 {
4884                                 callback_node();
4885                         }
4886                         expect_htlc_forward!(&nodes[1]);
4887
4888                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4889                         check_added_monitors!(&nodes[1], 1);
4890                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4891                         // tamper update_add (1 => 2)
4892                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4893                         if test_case != 3 && test_case != 200 {
4894                                 callback_msg(&mut update_add_1);
4895                         }
4896
4897                         // 1 => 2
4898                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4899                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4900
4901                         if test_case == 2 || test_case == 200 {
4902                                 expect_htlc_forward!(&nodes[2]);
4903                                 expect_event!(&nodes[2], Event::PaymentReceived);
4904                                 callback_node();
4905                                 expect_pending_htlcs_forwardable!(nodes[2]);
4906                         }
4907
4908                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4909                         if test_case == 2 || test_case == 200 {
4910                                 check_added_monitors!(&nodes[2], 1);
4911                         }
4912                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4913
4914                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4915                         if test_case == 200 {
4916                                 callback_fail(&mut fail_msg);
4917                         }
4918
4919                         // 2 => 1
4920                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4921                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4922
4923                         // backward fail on 1
4924                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4925                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4926                         update_1_0
4927                 },
4928                 _ => unreachable!(),
4929         };
4930
4931         // 1 => 0 commitment_signed_dance
4932         if update_1_0.update_fail_htlcs.len() > 0 {
4933                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4934                 if test_case == 100 {
4935                         callback_fail(&mut fail_msg);
4936                 }
4937                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4938         } else {
4939                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4940         };
4941
4942         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4943
4944         let events = nodes[0].node.get_and_clear_pending_events();
4945         assert_eq!(events.len(), 1);
4946         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4947                 assert_eq!(*rejected_by_dest, !expected_retryable);
4948                 assert_eq!(*error_code, expected_error_code);
4949         } else {
4950                 panic!("Uexpected event");
4951         }
4952
4953         let events = nodes[0].node.get_and_clear_pending_msg_events();
4954         if expected_channel_update.is_some() {
4955                 assert_eq!(events.len(), 1);
4956                 match events[0] {
4957                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4958                                 match update {
4959                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4960                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4961                                                         panic!("channel_update not found!");
4962                                                 }
4963                                         },
4964                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4965                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4966                                                         assert!(*short_channel_id == *expected_short_channel_id);
4967                                                         assert!(*is_permanent == *expected_is_permanent);
4968                                                 } else {
4969                                                         panic!("Unexpected message event");
4970                                                 }
4971                                         },
4972                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4973                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4974                                                         assert!(*node_id == *expected_node_id);
4975                                                         assert!(*is_permanent == *expected_is_permanent);
4976                                                 } else {
4977                                                         panic!("Unexpected message event");
4978                                                 }
4979                                         },
4980                                 }
4981                         },
4982                         _ => panic!("Unexpected message event"),
4983                 }
4984         } else {
4985                 assert_eq!(events.len(), 0);
4986         }
4987 }
4988
4989 impl msgs::ChannelUpdate {
4990         fn dummy() -> msgs::ChannelUpdate {
4991                 use secp256k1::ffi::Signature as FFISignature;
4992                 use secp256k1::Signature;
4993                 msgs::ChannelUpdate {
4994                         signature: Signature::from(FFISignature::new()),
4995                         contents: msgs::UnsignedChannelUpdate {
4996                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4997                                 short_channel_id: 0,
4998                                 timestamp: 0,
4999                                 flags: 0,
5000                                 cltv_expiry_delta: 0,
5001                                 htlc_minimum_msat: 0,
5002                                 fee_base_msat: 0,
5003                                 fee_proportional_millionths: 0,
5004                                 excess_data: vec![],
5005                         }
5006                 }
5007         }
5008 }
5009
5010 #[test]
5011 fn test_onion_failure() {
5012         use ln::msgs::ChannelUpdate;
5013         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5014         use secp256k1;
5015
5016         const BADONION: u16 = 0x8000;
5017         const PERM: u16 = 0x4000;
5018         const NODE: u16 = 0x2000;
5019         const UPDATE: u16 = 0x1000;
5020
5021         let node_cfgs = create_node_cfgs(3);
5022         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5023         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5024         for node in nodes.iter() {
5025                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5026         }
5027         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())];
5028         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5029         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5030         // positve case
5031         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5032
5033         // intermediate node failure
5034         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5035                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5036                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5037                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5038                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5039                 onion_payloads[0].format = msgs::OnionHopDataFormat::BogusRealm(3);
5040                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5041         }, ||{}, true, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
5042
5043         // final node failure
5044         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5045                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5046                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5047                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5048                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5049                 onion_payloads[1].format = msgs::OnionHopDataFormat::BogusRealm(3);
5050                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5051         }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5052
5053         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5054         // receiving simulated fail messages
5055         // intermediate node failure
5056         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5057                 // trigger error
5058                 msg.amount_msat -= 1;
5059         }, |msg| {
5060                 // and tamper returning error message
5061                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5062                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5063                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5064         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5065
5066         // final node failure
5067         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5068                 // and tamper returning error message
5069                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5070                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5071                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5072         }, ||{
5073                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5074         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5075
5076         // intermediate node failure
5077         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5078                 msg.amount_msat -= 1;
5079         }, |msg| {
5080                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5081                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5082                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5083         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5084
5085         // final node failure
5086         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5087                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5088                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5089                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5090         }, ||{
5091                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5092         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5093
5094         // intermediate node failure
5095         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5096                 msg.amount_msat -= 1;
5097         }, |msg| {
5098                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5099                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5100                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5101         }, ||{
5102                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5103         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5104
5105         // final node failure
5106         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5107                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5108                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5109                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5110         }, ||{
5111                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5112         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5113
5114         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5115                 Some(BADONION|PERM|4), None);
5116
5117         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5118                 Some(BADONION|PERM|5), None);
5119
5120         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5121                 Some(BADONION|PERM|6), None);
5122
5123         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5124                 msg.amount_msat -= 1;
5125         }, |msg| {
5126                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5127                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5128                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5129         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5130
5131         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5132                 msg.amount_msat -= 1;
5133         }, |msg| {
5134                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5135                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5136                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5137                 // short_channel_id from the processing node
5138         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5139
5140         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5141                 msg.amount_msat -= 1;
5142         }, |msg| {
5143                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5144                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5145                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5146                 // short_channel_id from the processing node
5147         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5148
5149         let mut bogus_route = route.clone();
5150         bogus_route.hops[1].short_channel_id -= 1;
5151         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5152           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5153
5154         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5155         let mut bogus_route = route.clone();
5156         let route_len = bogus_route.hops.len();
5157         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5158         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5159
5160         //TODO: with new config API, we will be able to generate both valid and
5161         //invalid channel_update cases.
5162         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5163                 msg.amount_msat -= 1;
5164         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5165
5166         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5167                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5168                 msg.cltv_expiry -= 1;
5169         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5170
5171         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5172                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5173                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5174
5175                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5176         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5177
5178         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5179                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5180         }, false, Some(PERM|15), None);
5181
5182         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5183                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5184                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5185
5186                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5187         }, || {}, true, Some(17), None);
5188
5189         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5190                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5191                         for f in pending_forwards.iter_mut() {
5192                                 match f {
5193                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5194                                                 forward_info.outgoing_cltv_value += 1,
5195                                         _ => {},
5196                                 }
5197                         }
5198                 }
5199         }, true, Some(18), None);
5200
5201         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5202                 // violate amt_to_forward > msg.amount_msat
5203                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5204                         for f in pending_forwards.iter_mut() {
5205                                 match f {
5206                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5207                                                 forward_info.amt_to_forward -= 1,
5208                                         _ => {},
5209                                 }
5210                         }
5211                 }
5212         }, true, Some(19), None);
5213
5214         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5215                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5216                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5217                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5218         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5219         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5220
5221         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5222                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5223                 let mut route = route.clone();
5224                 let height = 1;
5225                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5226                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5227                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5228                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5229                 msg.cltv_expiry = htlc_cltv;
5230                 msg.onion_routing_packet = onion_packet;
5231         }, ||{}, true, Some(21), None);
5232 }
5233
5234 #[test]
5235 #[should_panic]
5236 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5237         let node_cfgs = create_node_cfgs(2);
5238         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5239         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5240         //Force duplicate channel ids
5241         for node in nodes.iter() {
5242                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5243         }
5244
5245         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5246         let channel_value_satoshis=10000;
5247         let push_msat=10001;
5248         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5249         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5250         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5251
5252         //Create a second channel with a channel_id collision
5253         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5254 }
5255
5256 #[test]
5257 fn bolt2_open_channel_sending_node_checks_part2() {
5258         let node_cfgs = create_node_cfgs(2);
5259         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5260         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5261
5262         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5263         let channel_value_satoshis=2^24;
5264         let push_msat=10001;
5265         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5266
5267         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5268         let channel_value_satoshis=10000;
5269         // Test when push_msat is equal to 1000 * funding_satoshis.
5270         let push_msat=1000*channel_value_satoshis+1;
5271         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5272
5273         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5274         let channel_value_satoshis=10000;
5275         let push_msat=10001;
5276         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
5277         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5278         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5279
5280         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5281         // 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
5282         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5283
5284         // 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.
5285         assert!(BREAKDOWN_TIMEOUT>0);
5286         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5287
5288         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5289         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5290         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5291
5292         // 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.
5293         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5294         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5295         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5296         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5297         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5298 }
5299
5300 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5301 // 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.
5302 //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.
5303
5304 #[test]
5305 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5306         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5307         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5308         let node_cfgs = create_node_cfgs(2);
5309         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5310         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5311         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5312         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5313         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5314
5315         route.hops[0].fee_msat = 0;
5316
5317         let err = nodes[0].node.send_payment(route, our_payment_hash);
5318
5319         if let Err(APIError::ChannelUnavailable{err}) = err {
5320                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5321         } else {
5322                 assert!(false);
5323         }
5324         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5325         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5326 }
5327
5328 #[test]
5329 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5330         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5331         //It is enforced when constructing a route.
5332         let node_cfgs = create_node_cfgs(2);
5333         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5334         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5335         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5336         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5337         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5338
5339         let err = nodes[0].node.send_payment(route, our_payment_hash);
5340
5341         if let Err(APIError::RouteError{err}) = err {
5342                 assert_eq!(err, "Channel CLTV overflowed?!");
5343         } else {
5344                 assert!(false);
5345         }
5346 }
5347
5348 #[test]
5349 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5350         //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.
5351         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5352         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5353         let node_cfgs = create_node_cfgs(2);
5354         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5355         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5356         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5357         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5358
5359         for i in 0..max_accepted_htlcs {
5360                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5361                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5362                 let payment_event = {
5363                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5364                         check_added_monitors!(nodes[0], 1);
5365
5366                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5367                         assert_eq!(events.len(), 1);
5368                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5369                                 assert_eq!(htlcs[0].htlc_id, i);
5370                         } else {
5371                                 assert!(false);
5372                         }
5373                         SendEvent::from_event(events.remove(0))
5374                 };
5375                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5376                 check_added_monitors!(nodes[1], 0);
5377                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5378
5379                 expect_pending_htlcs_forwardable!(nodes[1]);
5380                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5381         }
5382         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5383         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5384         let err = nodes[0].node.send_payment(route, our_payment_hash);
5385
5386         if let Err(APIError::ChannelUnavailable{err}) = err {
5387                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5388         } else {
5389                 assert!(false);
5390         }
5391         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5392         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5393 }
5394
5395 #[test]
5396 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5397         //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.
5398         let node_cfgs = create_node_cfgs(2);
5399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5400         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5401         let channel_value = 100000;
5402         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5403         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5404
5405         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5406
5407         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5408         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5409         let err = nodes[0].node.send_payment(route, our_payment_hash);
5410
5411         if let Err(APIError::ChannelUnavailable{err}) = err {
5412                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5413         } else {
5414                 assert!(false);
5415         }
5416         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5417         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);
5418
5419         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5420 }
5421
5422 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5423 #[test]
5424 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5425         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5426         let node_cfgs = create_node_cfgs(2);
5427         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5428         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5429         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5430         let htlc_minimum_msat: u64;
5431         {
5432                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5433                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5434                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5435         }
5436         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5437         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5438         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5439         check_added_monitors!(nodes[0], 1);
5440         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5441         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5442         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5443         assert!(nodes[1].node.list_channels().is_empty());
5444         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5445         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5446 }
5447
5448 #[test]
5449 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5450         //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
5451         let node_cfgs = create_node_cfgs(2);
5452         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5453         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5454         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5455
5456         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5457
5458         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5459         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5460         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5461         check_added_monitors!(nodes[0], 1);
5462         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5463
5464         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5465         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5466
5467         assert!(nodes[1].node.list_channels().is_empty());
5468         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5469         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5470 }
5471
5472 #[test]
5473 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5474         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5475         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5476         let node_cfgs = create_node_cfgs(2);
5477         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5478         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5479         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5480         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5481         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5482
5483         let session_priv = SecretKey::from_slice(&{
5484                 let mut session_key = [0; 32];
5485                 let mut rng = thread_rng();
5486                 rng.fill_bytes(&mut session_key);
5487                 session_key
5488         }).expect("RNG is bad!");
5489
5490         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5491         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5492         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5493         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5494
5495         let mut msg = msgs::UpdateAddHTLC {
5496                 channel_id: chan.2,
5497                 htlc_id: 0,
5498                 amount_msat: 1000,
5499                 payment_hash: our_payment_hash,
5500                 cltv_expiry: htlc_cltv,
5501                 onion_routing_packet: onion_packet.clone(),
5502         };
5503
5504         for i in 0..super::channel::OUR_MAX_HTLCS {
5505                 msg.htlc_id = i as u64;
5506                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5507         }
5508         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5509         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5510
5511         assert!(nodes[1].node.list_channels().is_empty());
5512         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5513         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5514 }
5515
5516 #[test]
5517 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5518         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5519         let node_cfgs = create_node_cfgs(2);
5520         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5521         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5522         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5523         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5524         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5525         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5526         check_added_monitors!(nodes[0], 1);
5527         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5528         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5529         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5530
5531         assert!(nodes[1].node.list_channels().is_empty());
5532         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5533         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5534 }
5535
5536 #[test]
5537 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5538         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5539         let node_cfgs = create_node_cfgs(2);
5540         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5541         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5542         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5543         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5544         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5545         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5546         check_added_monitors!(nodes[0], 1);
5547         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5548         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5549         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5550
5551         assert!(nodes[1].node.list_channels().is_empty());
5552         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5553         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5554 }
5555
5556 #[test]
5557 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5558         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5559         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5560         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5561         let node_cfgs = create_node_cfgs(2);
5562         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5563         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5564         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5565         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5566         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5567         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5568         check_added_monitors!(nodes[0], 1);
5569         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5570         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5571
5572         //Disconnect and Reconnect
5573         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5574         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5575         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5576         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5577         assert_eq!(reestablish_1.len(), 1);
5578         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5579         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5580         assert_eq!(reestablish_2.len(), 1);
5581         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5582         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5583         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5584         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5585
5586         //Resend HTLC
5587         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5588         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5589         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5590         check_added_monitors!(nodes[1], 1);
5591         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5592
5593         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5594
5595         assert!(nodes[1].node.list_channels().is_empty());
5596         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5597         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5598 }
5599
5600 #[test]
5601 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5602         //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.
5603
5604         let node_cfgs = create_node_cfgs(2);
5605         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5606         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5607         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5608
5609         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5610         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5611         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5612         check_added_monitors!(nodes[0], 1);
5613         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5614         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5615
5616         let update_msg = msgs::UpdateFulfillHTLC{
5617                 channel_id: chan.2,
5618                 htlc_id: 0,
5619                 payment_preimage: our_payment_preimage,
5620         };
5621
5622         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5623
5624         assert!(nodes[0].node.list_channels().is_empty());
5625         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5626         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5627 }
5628
5629 #[test]
5630 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5631         //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.
5632
5633         let node_cfgs = create_node_cfgs(2);
5634         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5635         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5636         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5637
5638         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5639         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5640         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5641         check_added_monitors!(nodes[0], 1);
5642         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5643         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5644
5645         let update_msg = msgs::UpdateFailHTLC{
5646                 channel_id: chan.2,
5647                 htlc_id: 0,
5648                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5649         };
5650
5651         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5652
5653         assert!(nodes[0].node.list_channels().is_empty());
5654         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5655         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5656 }
5657
5658 #[test]
5659 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5660         //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.
5661
5662         let node_cfgs = create_node_cfgs(2);
5663         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5664         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5665         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5666
5667         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5668         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5669         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5670         check_added_monitors!(nodes[0], 1);
5671         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5672         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5673
5674         let update_msg = msgs::UpdateFailMalformedHTLC{
5675                 channel_id: chan.2,
5676                 htlc_id: 0,
5677                 sha256_of_onion: [1; 32],
5678                 failure_code: 0x8000,
5679         };
5680
5681         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5682
5683         assert!(nodes[0].node.list_channels().is_empty());
5684         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5685         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5686 }
5687
5688 #[test]
5689 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5690         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5691
5692         let node_cfgs = create_node_cfgs(2);
5693         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5694         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5695         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5696
5697         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5698
5699         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5700         check_added_monitors!(nodes[1], 1);
5701
5702         let events = nodes[1].node.get_and_clear_pending_msg_events();
5703         assert_eq!(events.len(), 1);
5704         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5705                 match events[0] {
5706                         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, .. } } => {
5707                                 assert!(update_add_htlcs.is_empty());
5708                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5709                                 assert!(update_fail_htlcs.is_empty());
5710                                 assert!(update_fail_malformed_htlcs.is_empty());
5711                                 assert!(update_fee.is_none());
5712                                 update_fulfill_htlcs[0].clone()
5713                         },
5714                         _ => panic!("Unexpected event"),
5715                 }
5716         };
5717
5718         update_fulfill_msg.htlc_id = 1;
5719
5720         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5721
5722         assert!(nodes[0].node.list_channels().is_empty());
5723         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5724         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5725 }
5726
5727 #[test]
5728 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5729         //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.
5730
5731         let node_cfgs = create_node_cfgs(2);
5732         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5733         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5734         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5735
5736         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5737
5738         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5739         check_added_monitors!(nodes[1], 1);
5740
5741         let events = nodes[1].node.get_and_clear_pending_msg_events();
5742         assert_eq!(events.len(), 1);
5743         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5744                 match events[0] {
5745                         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, .. } } => {
5746                                 assert!(update_add_htlcs.is_empty());
5747                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5748                                 assert!(update_fail_htlcs.is_empty());
5749                                 assert!(update_fail_malformed_htlcs.is_empty());
5750                                 assert!(update_fee.is_none());
5751                                 update_fulfill_htlcs[0].clone()
5752                         },
5753                         _ => panic!("Unexpected event"),
5754                 }
5755         };
5756
5757         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5758
5759         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5760
5761         assert!(nodes[0].node.list_channels().is_empty());
5762         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5763         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5764 }
5765
5766
5767 #[test]
5768 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5769         //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.
5770
5771         let node_cfgs = create_node_cfgs(2);
5772         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5773         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5774         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5775         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5776         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5777         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5778         check_added_monitors!(nodes[0], 1);
5779
5780         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5781         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5782
5783         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5784         check_added_monitors!(nodes[1], 0);
5785         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5786
5787         let events = nodes[1].node.get_and_clear_pending_msg_events();
5788
5789         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5790                 match events[0] {
5791                         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, .. } } => {
5792                                 assert!(update_add_htlcs.is_empty());
5793                                 assert!(update_fulfill_htlcs.is_empty());
5794                                 assert!(update_fail_htlcs.is_empty());
5795                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5796                                 assert!(update_fee.is_none());
5797                                 update_fail_malformed_htlcs[0].clone()
5798                         },
5799                         _ => panic!("Unexpected event"),
5800                 }
5801         };
5802         update_msg.failure_code &= !0x8000;
5803         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5804
5805         assert!(nodes[0].node.list_channels().is_empty());
5806         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5807         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5808 }
5809
5810 #[test]
5811 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5812         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5813         //    * 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.
5814
5815         let node_cfgs = create_node_cfgs(3);
5816         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5817         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5818         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5819         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5820
5821         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5822         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5823
5824         //First hop
5825         let mut payment_event = {
5826                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5827                 check_added_monitors!(nodes[0], 1);
5828                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5829                 assert_eq!(events.len(), 1);
5830                 SendEvent::from_event(events.remove(0))
5831         };
5832         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5833         check_added_monitors!(nodes[1], 0);
5834         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5835         expect_pending_htlcs_forwardable!(nodes[1]);
5836         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5837         assert_eq!(events_2.len(), 1);
5838         check_added_monitors!(nodes[1], 1);
5839         payment_event = SendEvent::from_event(events_2.remove(0));
5840         assert_eq!(payment_event.msgs.len(), 1);
5841
5842         //Second Hop
5843         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5844         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5845         check_added_monitors!(nodes[2], 0);
5846         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5847
5848         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5849         assert_eq!(events_3.len(), 1);
5850         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5851                 match events_3[0] {
5852                         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 } } => {
5853                                 assert!(update_add_htlcs.is_empty());
5854                                 assert!(update_fulfill_htlcs.is_empty());
5855                                 assert!(update_fail_htlcs.is_empty());
5856                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5857                                 assert!(update_fee.is_none());
5858                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5859                         },
5860                         _ => panic!("Unexpected event"),
5861                 }
5862         };
5863
5864         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5865
5866         check_added_monitors!(nodes[1], 0);
5867         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5868         expect_pending_htlcs_forwardable!(nodes[1]);
5869         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5870         assert_eq!(events_4.len(), 1);
5871
5872         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5873         match events_4[0] {
5874                 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, .. } } => {
5875                         assert!(update_add_htlcs.is_empty());
5876                         assert!(update_fulfill_htlcs.is_empty());
5877                         assert_eq!(update_fail_htlcs.len(), 1);
5878                         assert!(update_fail_malformed_htlcs.is_empty());
5879                         assert!(update_fee.is_none());
5880                 },
5881                 _ => panic!("Unexpected event"),
5882         };
5883
5884         check_added_monitors!(nodes[1], 1);
5885 }
5886
5887 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5888         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5889         // 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
5890         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5891
5892         let node_cfgs = create_node_cfgs(2);
5893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5894         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5895         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5896
5897         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5898
5899         // We route 2 dust-HTLCs between A and B
5900         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5901         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5902         route_payment(&nodes[0], &[&nodes[1]], 1000000);
5903
5904         // Cache one local commitment tx as previous
5905         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();
5906
5907         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5908         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
5909         check_added_monitors!(nodes[1], 0);
5910         expect_pending_htlcs_forwardable!(nodes[1]);
5911         check_added_monitors!(nodes[1], 1);
5912
5913         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5914         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5915         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5916         check_added_monitors!(nodes[0], 1);
5917
5918         // Cache one local commitment tx as lastest
5919         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();
5920
5921         let events = nodes[0].node.get_and_clear_pending_msg_events();
5922         match events[0] {
5923                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5924                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5925                 },
5926                 _ => panic!("Unexpected event"),
5927         }
5928         match events[1] {
5929                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5930                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5931                 },
5932                 _ => panic!("Unexpected event"),
5933         }
5934
5935         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5936         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5937         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5938
5939         if announce_latest {
5940                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5941         } else {
5942                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5943         }
5944
5945         let events = nodes[0].node.get_and_clear_pending_msg_events();
5946         assert_eq!(events.len(), 1);
5947         match events[0] {
5948                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5949                 _ => panic!("Unexpected event"),
5950         }
5951
5952         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5953         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5954         let events = nodes[0].node.get_and_clear_pending_events();
5955         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5956         assert_eq!(events.len(), 2);
5957         let mut first_failed = false;
5958         for event in events {
5959                 match event {
5960                         Event::PaymentFailed { payment_hash, .. } => {
5961                                 if payment_hash == payment_hash_1 {
5962                                         assert!(!first_failed);
5963                                         first_failed = true;
5964                                 } else {
5965                                         assert_eq!(payment_hash, payment_hash_2);
5966                                 }
5967                         }
5968                         _ => panic!("Unexpected event"),
5969                 }
5970         }
5971 }
5972
5973 #[test]
5974 fn test_failure_delay_dust_htlc_local_commitment() {
5975         do_test_failure_delay_dust_htlc_local_commitment(true);
5976         do_test_failure_delay_dust_htlc_local_commitment(false);
5977 }
5978
5979 #[test]
5980 fn test_no_failure_dust_htlc_local_commitment() {
5981         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5982         // prone to error, we test here that a dummy transaction don't fail them.
5983
5984         let node_cfgs = create_node_cfgs(2);
5985         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5986         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5987         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5988
5989         // Rebalance a bit
5990         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5991
5992         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5993         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5994
5995         // We route 2 dust-HTLCs between A and B
5996         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5997         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
5998
5999         // Build a dummy invalid transaction trying to spend a commitment tx
6000         let input = TxIn {
6001                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6002                 script_sig: Script::new(),
6003                 sequence: 0,
6004                 witness: Vec::new(),
6005         };
6006
6007         let outp = TxOut {
6008                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6009                 value: 10000,
6010         };
6011
6012         let dummy_tx = Transaction {
6013                 version: 2,
6014                 lock_time: 0,
6015                 input: vec![input],
6016                 output: vec![outp]
6017         };
6018
6019         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6020         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6021         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6022         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6023         // We broadcast a few more block to check everything is all right
6024         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6025         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6026         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6027
6028         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6029         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6030 }
6031
6032 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6033         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6034         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6035         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6036         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6037         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6038         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6039
6040         let node_cfgs = create_node_cfgs(3);
6041         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6042         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6043         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6044
6045         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6046
6047         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6048         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6049
6050         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();
6051         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();
6052
6053         // We revoked bs_commitment_tx
6054         if revoked {
6055                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6056                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6057         }
6058
6059         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6060         let mut timeout_tx = Vec::new();
6061         if local {
6062                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6063                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6064                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6065                 assert_eq!(events.len(), 1);
6066                 match events[0] {
6067                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6068                         _ => panic!("Unexpected event"),
6069                 }
6070                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6071                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6072                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6073                 let events = nodes[0].node.get_and_clear_pending_events();
6074                 assert_eq!(events.len(), 1);
6075                 match events[0] {
6076                         Event::PaymentFailed { payment_hash, .. } => {
6077                                 assert_eq!(payment_hash, dust_hash);
6078                         },
6079                         _ => panic!("Unexpected event"),
6080                 }
6081                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6082                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6083                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6084                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6085                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6086                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6087                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6088                 let events = nodes[0].node.get_and_clear_pending_events();
6089                 assert_eq!(events.len(), 1);
6090                 match events[0] {
6091                         Event::PaymentFailed { payment_hash, .. } => {
6092                                 assert_eq!(payment_hash, non_dust_hash);
6093                         },
6094                         _ => panic!("Unexpected event"),
6095                 }
6096         } else {
6097                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6098                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6099                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6100                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6101                 assert_eq!(events.len(), 1);
6102                 match events[0] {
6103                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6104                         _ => panic!("Unexpected event"),
6105                 }
6106                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6107                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6108                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6109                 if !revoked {
6110                         let events = nodes[0].node.get_and_clear_pending_events();
6111                         assert_eq!(events.len(), 1);
6112                         match events[0] {
6113                                 Event::PaymentFailed { payment_hash, .. } => {
6114                                         assert_eq!(payment_hash, dust_hash);
6115                                 },
6116                                 _ => panic!("Unexpected event"),
6117                         }
6118                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6119                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6120                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6121                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6122                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6123                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6124                         let events = nodes[0].node.get_and_clear_pending_events();
6125                         assert_eq!(events.len(), 1);
6126                         match events[0] {
6127                                 Event::PaymentFailed { payment_hash, .. } => {
6128                                         assert_eq!(payment_hash, non_dust_hash);
6129                                 },
6130                                 _ => panic!("Unexpected event"),
6131                         }
6132                 } else {
6133                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6134                         // commitment tx
6135                         let events = nodes[0].node.get_and_clear_pending_events();
6136                         assert_eq!(events.len(), 2);
6137                         let first;
6138                         match events[0] {
6139                                 Event::PaymentFailed { payment_hash, .. } => {
6140                                         if payment_hash == dust_hash { first = true; }
6141                                         else { first = false; }
6142                                 },
6143                                 _ => panic!("Unexpected event"),
6144                         }
6145                         match events[1] {
6146                                 Event::PaymentFailed { payment_hash, .. } => {
6147                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6148                                         else { assert_eq!(payment_hash, dust_hash); }
6149                                 },
6150                                 _ => panic!("Unexpected event"),
6151                         }
6152                 }
6153         }
6154 }
6155
6156 #[test]
6157 fn test_sweep_outbound_htlc_failure_update() {
6158         do_test_sweep_outbound_htlc_failure_update(false, true);
6159         do_test_sweep_outbound_htlc_failure_update(false, false);
6160         do_test_sweep_outbound_htlc_failure_update(true, false);
6161 }
6162
6163 #[test]
6164 fn test_upfront_shutdown_script() {
6165         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6166         // enforce it at shutdown message
6167
6168         let mut config = UserConfig::default();
6169         config.channel_options.announced_channel = true;
6170         config.peer_channel_config_limits.force_announced_channel_preference = false;
6171         config.channel_options.commit_upfront_shutdown_pubkey = false;
6172         let user_cfgs = [None, Some(config), None];
6173         let node_cfgs = create_node_cfgs(3);
6174         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6175         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6176
6177         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6178         let flags = InitFeatures::supported();
6179         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6180         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6181         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6182         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6183         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6184         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6185         let events = nodes[2].node.get_and_clear_pending_msg_events();
6186         assert_eq!(events.len(), 2);
6187         match events[0] {
6188                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6189                 _ => panic!("Unexpected event"),
6190         }
6191         if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6192                 match action {
6193                         &ErrorAction::SendErrorMessage { ref msg } => {
6194                                 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6195                         },
6196                         _ => { assert!(false); }
6197                 }
6198         } else { assert!(false); }
6199
6200         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6201         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6202         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6203         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6204         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6205         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6206         let events = nodes[2].node.get_and_clear_pending_msg_events();
6207         assert_eq!(events.len(), 1);
6208         match events[0] {
6209                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6210                 _ => panic!("Unexpected event"),
6211         }
6212
6213         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6214         let mut flags_no = InitFeatures::supported();
6215         flags_no.unset_upfront_shutdown_script();
6216         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6217         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6218         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6219         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6220         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6221         let events = nodes[1].node.get_and_clear_pending_msg_events();
6222         assert_eq!(events.len(), 1);
6223         match events[0] {
6224                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6225                 _ => panic!("Unexpected event"),
6226         }
6227
6228         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6229         // channel smoothly, opt-out is from channel initiator here
6230         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6231         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6232         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6233         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6234         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6235         let events = nodes[0].node.get_and_clear_pending_msg_events();
6236         assert_eq!(events.len(), 1);
6237         match events[0] {
6238                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6239                 _ => panic!("Unexpected event"),
6240         }
6241
6242         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6243         //// channel smoothly
6244         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6245         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6246         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6247         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6248         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6249         let events = nodes[0].node.get_and_clear_pending_msg_events();
6250         assert_eq!(events.len(), 2);
6251         match events[0] {
6252                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6253                 _ => panic!("Unexpected event"),
6254         }
6255         match events[1] {
6256                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6257                 _ => panic!("Unexpected event"),
6258         }
6259 }
6260
6261 #[test]
6262 fn test_user_configurable_csv_delay() {
6263         // We test our channel constructors yield errors when we pass them absurd csv delay
6264
6265         let mut low_our_to_self_config = UserConfig::default();
6266         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6267         let mut high_their_to_self_config = UserConfig::default();
6268         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6269         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6270         let node_cfgs = create_node_cfgs(2);
6271         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6272         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6273
6274         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6275         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())));
6276         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) {
6277                 match error {
6278                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6279                         _ => panic!("Unexpected event"),
6280                 }
6281         } else { assert!(false) }
6282
6283         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6284         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6285         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6286         open_channel.to_self_delay = 200;
6287         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) {
6288                 match error {
6289                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6290                         _ => panic!("Unexpected event"),
6291                 }
6292         } else { assert!(false); }
6293
6294         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6295         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6296         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()));
6297         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6298         accept_channel.to_self_delay = 200;
6299         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6300         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6301                 match action {
6302                         &ErrorAction::SendErrorMessage { ref msg } => {
6303                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6304                         },
6305                         _ => { assert!(false); }
6306                 }
6307         } else { assert!(false); }
6308
6309         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6310         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6311         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6312         open_channel.to_self_delay = 200;
6313         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) {
6314                 match error {
6315                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6316                         _ => panic!("Unexpected event"),
6317                 }
6318         } else { assert!(false); }
6319 }
6320
6321 #[test]
6322 fn test_data_loss_protect() {
6323         // We want to be sure that :
6324         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6325         // * we close channel in case of detecting other being fallen behind
6326         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6327         let monitor;
6328         let node_state_0;
6329         let node_cfgs = create_node_cfgs(2);
6330         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6331         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6332
6333         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6334
6335         // Cache node A state before any channel update
6336         let previous_node_state = nodes[0].node.encode();
6337         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6338         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6339
6340         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6341         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6342
6343         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6344         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6345
6346         // Restore node A from previous state
6347         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6348         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6349         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6350         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6351         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6352         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone());
6353         node_state_0 = {
6354                 let mut channel_monitors = HashMap::new();
6355                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6356                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6357                         keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6358                         fee_estimator: feeest.clone(),
6359                         monitor: &monitor,
6360                         logger: Arc::clone(&logger),
6361                         tx_broadcaster,
6362                         default_config: UserConfig::default(),
6363                         channel_monitors: &mut channel_monitors,
6364                 }).unwrap().1
6365         };
6366         nodes[0].node = &node_state_0;
6367         assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6368         nodes[0].chan_monitor = &monitor;
6369         nodes[0].chain_monitor = chain_monitor;
6370
6371         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6372         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6373         nodes[0].block_notifier.register_listener(nodes[0].node);
6374
6375         check_added_monitors!(nodes[0], 1);
6376
6377         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6378         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6379
6380         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6381
6382         // Check we update monitor following learning of per_commitment_point from B
6383         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6384         check_added_monitors!(nodes[0], 1);
6385
6386         {
6387                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6388                 assert_eq!(node_txn.len(), 0);
6389         }
6390
6391         let mut reestablish_1 = Vec::with_capacity(1);
6392         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6393                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6394                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6395                         reestablish_1.push(msg.clone());
6396                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6397                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6398                         match action {
6399                                 &ErrorAction::SendErrorMessage { ref msg } => {
6400                                         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");
6401                                 },
6402                                 _ => panic!("Unexpected event!"),
6403                         }
6404                 } else {
6405                         panic!("Unexpected event")
6406                 }
6407         }
6408
6409         // Check we close channel detecting A is fallen-behind
6410         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6411         let events = nodes[1].node.get_and_clear_pending_msg_events();
6412         assert_eq!(events.len(), 2);
6413         match events[0] {
6414                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6415                 _ => panic!("Unexpected event"),
6416         }
6417         match events [1] {
6418                 MessageSendEvent::HandleError { ref action, .. } => {
6419                         match action {
6420                                 &ErrorAction::SendErrorMessage { ref msg } => {
6421                                         assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6422                                 _ => panic!("Unexpected event!"),
6423                         }
6424                 },
6425                 _ => panic!("Unexpected event"),
6426         }
6427
6428         // Check A is able to claim to_remote output
6429         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6430         assert_eq!(node_txn.len(), 1);
6431         check_spends!(node_txn[0], chan.3.clone());
6432         assert_eq!(node_txn[0].output.len(), 2);
6433         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6434         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6435         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6436         assert_eq!(spend_txn.len(), 1);
6437         check_spends!(spend_txn[0], node_txn[0].clone());
6438 }
6439
6440 #[test]
6441 fn test_check_htlc_underpaying() {
6442         // Send payment through A -> B but A is maliciously
6443         // sending a probe payment (i.e less than expected value0
6444         // to B, B should refuse payment.
6445
6446         let node_cfgs = create_node_cfgs(2);
6447         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6448         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6449
6450         // Create some initial channels
6451         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6452
6453         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6454
6455         // Node 3 is expecting payment of 100_000 but receive 10_000,
6456         // fail htlc like we didn't know the preimage.
6457         nodes[1].node.claim_funds(payment_preimage, 100_000);
6458         nodes[1].node.process_pending_htlc_forwards();
6459
6460         let events = nodes[1].node.get_and_clear_pending_msg_events();
6461         assert_eq!(events.len(), 1);
6462         let (update_fail_htlc, commitment_signed) = match events[0] {
6463                 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 } } => {
6464                         assert!(update_add_htlcs.is_empty());
6465                         assert!(update_fulfill_htlcs.is_empty());
6466                         assert_eq!(update_fail_htlcs.len(), 1);
6467                         assert!(update_fail_malformed_htlcs.is_empty());
6468                         assert!(update_fee.is_none());
6469                         (update_fail_htlcs[0].clone(), commitment_signed)
6470                 },
6471                 _ => panic!("Unexpected event"),
6472         };
6473         check_added_monitors!(nodes[1], 1);
6474
6475         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6476         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6477
6478         let events = nodes[0].node.get_and_clear_pending_events();
6479         assert_eq!(events.len(), 1);
6480         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6481                 assert_eq!(*rejected_by_dest, true);
6482                 assert_eq!(error_code.unwrap(), 0x4000|15);
6483         } else {
6484                 panic!("Unexpected event");
6485         }
6486         nodes[1].node.get_and_clear_pending_events();
6487 }
6488
6489 #[test]
6490 fn test_announce_disable_channels() {
6491         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6492         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6493
6494         let node_cfgs = create_node_cfgs(2);
6495         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6496         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6497
6498         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6499         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6500         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6501
6502         // Disconnect peers
6503         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6504         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6505
6506         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6507         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6508         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6509         assert_eq!(msg_events.len(), 3);
6510         for e in msg_events {
6511                 match e {
6512                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6513                                 let short_id = msg.contents.short_channel_id;
6514                                 // Check generated channel_update match list in PendingChannelUpdate
6515                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6516                                         panic!("Generated ChannelUpdate for wrong chan!");
6517                                 }
6518                         },
6519                         _ => panic!("Unexpected event"),
6520                 }
6521         }
6522         // Reconnect peers
6523         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6524         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6525         assert_eq!(reestablish_1.len(), 3);
6526         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6527         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6528         assert_eq!(reestablish_2.len(), 3);
6529
6530         // Reestablish chan_1
6531         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6532         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6533         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6534         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6535         // Reestablish chan_2
6536         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6537         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6538         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6539         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6540         // Reestablish chan_3
6541         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6542         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6543         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6544         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6545
6546         nodes[0].node.timer_chan_freshness_every_min();
6547         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6548 }
6549
6550 #[test]
6551 fn test_bump_penalty_txn_on_revoked_commitment() {
6552         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6553         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6554
6555         let node_cfgs = create_node_cfgs(2);
6556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6557         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6558
6559         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6560         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6561         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6562         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6563
6564         let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6565         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6566         assert_eq!(revoked_txn[0].output.len(), 4);
6567         assert_eq!(revoked_txn[0].input.len(), 1);
6568         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6569         let revoked_txid = revoked_txn[0].txid();
6570
6571         let mut penalty_sum = 0;
6572         for outp in revoked_txn[0].output.iter() {
6573                 if outp.script_pubkey.is_v0_p2wsh() {
6574                         penalty_sum += outp.value;
6575                 }
6576         }
6577
6578         // Connect blocks to change height_timer range to see if we use right soonest_timelock
6579         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6580
6581         // Actually revoke tx by claiming a HTLC
6582         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6583         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6584         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6585
6586         // One or more justice tx should have been broadcast, check it
6587         let penalty_1;
6588         let feerate_1;
6589         {
6590                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6591                 assert_eq!(node_txn.len(), 4); // justice tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6592                 assert_eq!(node_txn[0], node_txn[3]);
6593                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6594                 assert_eq!(node_txn[0].output.len(), 1);
6595                 check_spends!(node_txn[0], revoked_txn[0].clone());
6596                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6597                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6598                 penalty_1 = node_txn[0].txid();
6599                 node_txn.clear();
6600         };
6601
6602         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6603         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
6604         let mut penalty_2 = penalty_1;
6605         let mut feerate_2 = 0;
6606         {
6607                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6608                 assert_eq!(node_txn.len(), 1);
6609                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6610                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6611                         assert_eq!(node_txn[0].output.len(), 1);
6612                         check_spends!(node_txn[0], revoked_txn[0].clone());
6613                         penalty_2 = node_txn[0].txid();
6614                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6615                         assert_ne!(penalty_2, penalty_1);
6616                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
6617                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6618                         // Verify 25% bump heuristic
6619                         assert!(feerate_2 * 100 >= feerate_1 * 125);
6620                         node_txn.clear();
6621                 }
6622         }
6623         assert_ne!(feerate_2, 0);
6624
6625         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6626         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6627         let penalty_3;
6628         let mut feerate_3 = 0;
6629         {
6630                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6631                 assert_eq!(node_txn.len(), 1);
6632                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6633                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6634                         assert_eq!(node_txn[0].output.len(), 1);
6635                         check_spends!(node_txn[0], revoked_txn[0].clone());
6636                         penalty_3 = node_txn[0].txid();
6637                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6638                         assert_ne!(penalty_3, penalty_2);
6639                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
6640                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6641                         // Verify 25% bump heuristic
6642                         assert!(feerate_3 * 100 >= feerate_2 * 125);
6643                         node_txn.clear();
6644                 }
6645         }
6646         assert_ne!(feerate_3, 0);
6647
6648         nodes[1].node.get_and_clear_pending_events();
6649         nodes[1].node.get_and_clear_pending_msg_events();
6650 }
6651
6652 #[test]
6653 fn test_bump_penalty_txn_on_revoked_htlcs() {
6654         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6655         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6656
6657         let node_cfgs = create_node_cfgs(2);
6658         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6659         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6660
6661         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6662         // Lock HTLC in both directions
6663         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6664         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6665
6666         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();
6667         assert_eq!(revoked_local_txn[0].input.len(), 1);
6668         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6669
6670         // Revoke local commitment tx
6671         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6672
6673         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6674         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6675         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6676         check_closed_broadcast!(nodes[1], false);
6677
6678         let mut received = ::std::usize::MAX;
6679         let mut offered = ::std::usize::MAX;
6680         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6681         assert_eq!(revoked_htlc_txn.len(), 6);
6682         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6683                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6684                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6685                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6686                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6687                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6688                 received = 0;
6689                 offered = 1;
6690         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6691                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6692                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6693                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6694                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6695                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6696                 received = 1;
6697                 offered = 0;
6698         }
6699
6700         // Broadcast set of revoked txn on A
6701         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  true, header.bitcoin_hash());
6702         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6703         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);
6704         let first;
6705         let second;
6706         let feerate_1;
6707         let feerate_2;
6708         {
6709                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6710                 assert_eq!(node_txn.len(), 9); // 3 penalty txn on revoked commitment tx * 2 (block-rescan) + A commitment tx + 2 penalty tnx on revoked HTLC txn
6711                 // Verify claim tx are spending revoked HTLC txn
6712                 assert_eq!(node_txn[7].input.len(), 1);
6713                 assert_eq!(node_txn[7].output.len(), 1);
6714                 check_spends!(node_txn[7], revoked_htlc_txn[0].clone());
6715                 first = node_txn[7].txid();
6716                 assert_eq!(node_txn[8].input.len(), 1);
6717                 assert_eq!(node_txn[8].output.len(), 1);
6718                 check_spends!(node_txn[8], revoked_htlc_txn[1].clone());
6719                 second = node_txn[8].txid();
6720                 // Store both feerates for later comparison
6721                 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[7].output[0].value;
6722                 feerate_1 = fee_1 * 1000 / node_txn[7].get_weight() as u64;
6723                 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[8].output[0].value;
6724                 feerate_2 = fee_2 * 1000 / node_txn[8].get_weight() as u64;
6725                 node_txn.clear();
6726         }
6727
6728         // Connect three more block to see if bumped penalty are issued for HTLC txn
6729         let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6730         let penalty_local_tx;
6731         {
6732                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6733                 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
6734
6735                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6736                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6737
6738                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6739
6740                 penalty_local_tx = node_txn[2].clone();
6741                 node_txn.clear();
6742         };
6743         // Few more blocks to broadcast and confirm penalty_local_tx
6744         let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6745         nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6746         let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6747         {
6748                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6749                 assert_eq!(node_txn.len(), 1);
6750                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6751                 node_txn.clear();
6752         }
6753         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6754         let node_txn = {
6755                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6756                 assert_eq!(node_txn.len(), 2);
6757
6758                 let mut penalty_offered = ::std::usize::MAX;
6759                 let mut penalty_received = ::std::usize::MAX;
6760
6761                 {
6762                         for (i, tx) in node_txn.iter().enumerate() {
6763                                 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6764                                         penalty_offered = i;
6765                                 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6766                                         penalty_received = i;
6767                                 }
6768                         }
6769                 }
6770
6771                 assert_eq!(node_txn[penalty_received].input.len(), 1);
6772                 assert_eq!(node_txn[penalty_received].output.len(), 1);
6773                 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6774                 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6775                 // Verify bumped tx is different and 25% bump heuristic
6776                 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6777                 assert_ne!(first, node_txn[penalty_offered].txid());
6778                 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6779                 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6780                 assert!(new_feerate * 100 > feerate_1 * 125);
6781
6782                 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6783                 assert_ne!(second, node_txn[penalty_received].txid());
6784                 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6785                 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6786                 assert!(new_feerate * 100 > feerate_2 * 125);
6787                 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
6788                 node_txn.clear();
6789                 txn
6790         };
6791         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6792         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6793         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
6794         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
6795         {
6796                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6797                 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
6798                 node_txn.clear();
6799         }
6800         check_closed_broadcast!(nodes[0], false);
6801 }
6802
6803 #[test]
6804 fn test_bump_penalty_txn_on_remote_commitment() {
6805         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6806         // we're able to claim outputs on remote commitment transaction before timelocks expiration
6807
6808         // Create 2 HTLCs
6809         // Provide preimage for one
6810         // Check aggregation
6811
6812         let node_cfgs = create_node_cfgs(2);
6813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6814         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6815
6816         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6817         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6818         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6819
6820         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6821         let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6822         assert_eq!(remote_txn[0].output.len(), 4);
6823         assert_eq!(remote_txn[0].input.len(), 1);
6824         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6825
6826         // Claim a HTLC without revocation (provide B monitor with preimage)
6827         nodes[1].node.claim_funds(payment_preimage, 3_000_000);
6828         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6829         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6830         check_added_monitors!(nodes[1], 1);
6831
6832         // One or more claim tx should have been broadcast, check it
6833         let timeout;
6834         let preimage;
6835         let feerate_timeout;
6836         let feerate_preimage;
6837         {
6838                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6839                 assert_eq!(node_txn.len(), 7); // 2 * claim tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout + HTLC-success (broadcasted from ChannelManager)
6840                 assert_eq!(node_txn[0], node_txn[5]);
6841                 assert_eq!(node_txn[1], node_txn[6]);
6842                 assert_eq!(node_txn[0].input.len(), 1);
6843                 assert_eq!(node_txn[1].input.len(), 1);
6844                 check_spends!(node_txn[0], remote_txn[0].clone());
6845                 check_spends!(node_txn[1], remote_txn[0].clone());
6846                 check_spends!(node_txn[2], chan.3);
6847                 check_spends!(node_txn[3], node_txn[2]);
6848                 check_spends!(node_txn[4], node_txn[2]);
6849                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6850                         timeout = node_txn[0].txid();
6851                         let index = node_txn[0].input[0].previous_output.vout;
6852                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6853                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6854
6855                         preimage = node_txn[1].txid();
6856                         let index = node_txn[1].input[0].previous_output.vout;
6857                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6858                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6859                 } else {
6860                         timeout = node_txn[1].txid();
6861                         let index = node_txn[1].input[0].previous_output.vout;
6862                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6863                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6864
6865                         preimage = node_txn[0].txid();
6866                         let index = node_txn[0].input[0].previous_output.vout;
6867                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6868                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6869                 }
6870                 node_txn.clear();
6871         };
6872         assert_ne!(feerate_timeout, 0);
6873         assert_ne!(feerate_preimage, 0);
6874
6875         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6876         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
6877         {
6878                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6879                 assert_eq!(node_txn.len(), 2);
6880                 assert_eq!(node_txn[0].input.len(), 1);
6881                 assert_eq!(node_txn[1].input.len(), 1);
6882                 check_spends!(node_txn[0], remote_txn[0].clone());
6883                 check_spends!(node_txn[1], remote_txn[0].clone());
6884                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6885                         let index = node_txn[0].input[0].previous_output.vout;
6886                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6887                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6888                         assert!(new_feerate * 100 > feerate_timeout * 125);
6889                         assert_ne!(timeout, node_txn[0].txid());
6890
6891                         let index = node_txn[1].input[0].previous_output.vout;
6892                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6893                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6894                         assert!(new_feerate * 100 > feerate_preimage * 125);
6895                         assert_ne!(preimage, node_txn[1].txid());
6896                 } else {
6897                         let index = node_txn[1].input[0].previous_output.vout;
6898                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6899                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6900                         assert!(new_feerate * 100 > feerate_timeout * 125);
6901                         assert_ne!(timeout, node_txn[1].txid());
6902
6903                         let index = node_txn[0].input[0].previous_output.vout;
6904                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6905                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6906                         assert!(new_feerate * 100 > feerate_preimage * 125);
6907                         assert_ne!(preimage, node_txn[0].txid());
6908                 }
6909                 node_txn.clear();
6910         }
6911
6912         nodes[1].node.get_and_clear_pending_events();
6913         nodes[1].node.get_and_clear_pending_msg_events();
6914 }
6915
6916 #[test]
6917 fn test_set_outpoints_partial_claiming() {
6918         // - remote party claim tx, new bump tx
6919         // - disconnect remote claiming tx, new bump
6920         // - disconnect tx, see no tx anymore
6921         let node_cfgs = create_node_cfgs(2);
6922         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6923         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6924
6925         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6926         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6927         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6928
6929         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6930         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6931         assert_eq!(remote_txn.len(), 3);
6932         assert_eq!(remote_txn[0].output.len(), 4);
6933         assert_eq!(remote_txn[0].input.len(), 1);
6934         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6935         check_spends!(remote_txn[1], remote_txn[0].clone());
6936         check_spends!(remote_txn[2], remote_txn[0].clone());
6937
6938         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6939         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6940         // Provide node A with both preimage
6941         nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
6942         nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
6943         check_added_monitors!(nodes[0], 2);
6944         nodes[0].node.get_and_clear_pending_events();
6945         nodes[0].node.get_and_clear_pending_msg_events();
6946
6947         // Connect blocks on node A commitment transaction
6948         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6949         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6950         // Verify node A broadcast tx claiming both HTLCs
6951         {
6952                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6953                 assert_eq!(node_txn.len(), 5);
6954                 assert_eq!(node_txn[0], node_txn[4]);
6955                 check_spends!(node_txn[0], remote_txn[0].clone());
6956                 check_spends!(node_txn[1], chan.3.clone());
6957                 check_spends!(node_txn[2], node_txn[1]);
6958                 check_spends!(node_txn[3], node_txn[1]);
6959                 assert_eq!(node_txn[0].input.len(), 2);
6960                 node_txn.clear();
6961         }
6962         nodes[0].node.get_and_clear_pending_msg_events();
6963
6964         // Connect blocks on node B
6965         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6966         // Verify node B broadcast 2 HTLC-timeout txn
6967         let partial_claim_tx = {
6968                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6969                 assert_eq!(node_txn.len(), 3);
6970                 check_spends!(node_txn[1], node_txn[0].clone());
6971                 check_spends!(node_txn[2], node_txn[0].clone());
6972                 assert_eq!(node_txn[1].input.len(), 1);
6973                 assert_eq!(node_txn[2].input.len(), 1);
6974                 node_txn[1].clone()
6975         };
6976         nodes[1].node.get_and_clear_pending_msg_events();
6977
6978         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
6979         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6980         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
6981         {
6982                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6983                 assert_eq!(node_txn.len(), 1);
6984                 check_spends!(node_txn[0], remote_txn[0].clone());
6985                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
6986                 node_txn.clear();
6987         }
6988         nodes[0].node.get_and_clear_pending_msg_events();
6989
6990         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
6991         nodes[0].block_notifier.block_disconnected(&header, 102);
6992         {
6993                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6994                 assert_eq!(node_txn.len(), 1);
6995                 check_spends!(node_txn[0], remote_txn[0].clone());
6996                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
6997                 node_txn.clear();
6998         }
6999
7000         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7001         nodes[0].block_notifier.block_disconnected(&header, 101);
7002         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7003         {
7004                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7005                 assert_eq!(node_txn.len(), 0);
7006                 node_txn.clear();
7007         }
7008 }
7009
7010 #[test]
7011 fn test_counterparty_raa_skip_no_crash() {
7012         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7013         // commitment transaction, we would have happily carried on and provided them the next
7014         // commitment transaction based on one RAA forward. This would probably eventually have led to
7015         // channel closure, but it would not have resulted in funds loss. Still, our
7016         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7017         // check simply that the channel is closed in response to such an RAA, but don't check whether
7018         // we decide to punish our counterparty for revoking their funds (as we don't currently
7019         // implement that).
7020         let node_cfgs = create_node_cfgs(2);
7021         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7022         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7023         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7024
7025         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7026         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7027         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7028                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7029         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7030
7031         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7032                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7033         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7034 }
7035
7036 #[test]
7037 fn test_bump_txn_sanitize_tracking_maps() {
7038         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7039         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7040
7041         let node_cfgs = create_node_cfgs(2);
7042         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7043         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7044
7045         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7046         // Lock HTLC in both directions
7047         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7048         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7049
7050         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();
7051         assert_eq!(revoked_local_txn[0].input.len(), 1);
7052         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7053
7054         // Revoke local commitment tx
7055         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7056
7057         // Broadcast set of revoked txn on A
7058         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7059         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7060         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7061         check_closed_broadcast!(nodes[0], false);
7062         let penalty_txn = {
7063                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7064                 assert_eq!(node_txn.len(), 7);
7065                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7066                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7067                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7068                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7069                 node_txn.clear();
7070                 penalty_txn
7071         };
7072         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7073         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7074         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7075         {
7076                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7077                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7078                         assert!(monitor.pending_claim_requests.is_empty());
7079                         assert!(monitor.claimable_outpoints.is_empty());
7080                 }
7081         }
7082 }