_ Git - rust-lightning/blob - lightning/src/ln/functional_tests.rs

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