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