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