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

   1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
   2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
   3 //! claim outputs on-chain.
   4
   5 use chain::transaction::OutPoint;
   6 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
   7 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
   9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT};
  10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  11 use ln::channel::{Channel, ChannelError};
  12 use ln::{chan_utils, onion_utils};
  13 use ln::router::{Route, RouteHop};
  14 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  15 use ln::msgs;
  16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  17 use util::enforcing_trait_impls::EnforcingChannelKeys;
  18 use util::test_utils;
  19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  20 use util::errors::APIError;
  21 use util::ser::{Writeable, Writer, ReadableArgs};
  22 use util::config::UserConfig;
  23 use util::logger::Logger;
  24
  25 use bitcoin::util::hash::BitcoinHash;
  26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  27 use bitcoin::util::bip143;
  28 use bitcoin::util::address::Address;
  29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  30 use bitcoin::blockdata::block::{Block, BlockHeader};
  31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  32 use bitcoin::blockdata::script::{Builder, Script};
  33 use bitcoin::blockdata::opcodes;
  34 use bitcoin::blockdata::constants::genesis_block;
  35 use bitcoin::network::constants::Network;
  36
  37 use bitcoin_hashes::sha256::Hash as Sha256;
  38 use bitcoin_hashes::Hash;
  39
  40 use secp256k1::{Secp256k1, Message};
  41 use secp256k1::key::{PublicKey,SecretKey};
  42
  43 use std::collections::{BTreeSet, HashMap, HashSet};
  44 use std::default::Default;
  45 use std::sync::{Arc, Mutex};
  46 use std::sync::atomic::Ordering;
  47 use std::{mem, io};
  48
  49 use rand::{thread_rng, Rng};
  50
  51 use ln::functional_test_utils::*;
  52
  53 #[test]
  54 fn test_insane_channel_opens() {
  55         // Stand up a network of 2 nodes
  56         let node_cfgs = create_node_cfgs(2);
  57         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  58         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  59
  60         // Instantiate channel parameters where we push the maximum msats given our
  61         // funding satoshis
  62         let channel_value_sat = 31337; // same as funding satoshis
  63         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
  64         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  65
  66         // Have node0 initiate a channel to node1 with aforementioned parameters
  67         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
  68
  69         // Extract the channel open message from node0 to node1
  70         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  71
  72         // Test helper that asserts we get the correct error string given a mutator
  73         // that supposedly makes the channel open message insane
  74         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  75                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
  76                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  77                 assert_eq!(msg_events.len(), 1);
  78                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  79                         match action {
  80                                 &ErrorAction::SendErrorMessage { .. } => {
  81                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  82                                 },
  83                                 _ => panic!("unexpected event!"),
  84                         }
  85                 } else { assert!(false); }
  86         };
  87
  88         use ln::channel::MAX_FUNDING_SATOSHIS;
  89         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  90
  91         // Test all mutations that would make the channel open message insane
  92         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  93
  94         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  95
  96         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  97
  98         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
  99
 100         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 101
 102         insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 103
 104         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 105
 106         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 107
 108         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 109 }
 110
 111 #[test]
 112 fn test_async_inbound_update_fee() {
 113         let node_cfgs = create_node_cfgs(2);
 114         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 115         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 116         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 117         let channel_id = chan.2;
 118
 119         // balancing
 120         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 121
 122         // A                                        B
 123         // update_fee                            ->
 124         // send (1) commitment_signed            -.
 125         //                                       <- update_add_htlc/commitment_signed
 126         // send (2) RAA (awaiting remote revoke) -.
 127         // (1) commitment_signed is delivered    ->
 128         //                                       .- send (3) RAA (awaiting remote revoke)
 129         // (2) RAA is delivered                  ->
 130         //                                       .- send (4) commitment_signed
 131         //                                       <- (3) RAA is delivered
 132         // send (5) commitment_signed            -.
 133         //                                       <- (4) commitment_signed is delivered
 134         // send (6) RAA                          -.
 135         // (5) commitment_signed is delivered    ->
 136         //                                       <- RAA
 137         // (6) RAA is delivered                  ->
 138
 139         // First nodes[0] generates an update_fee
 140         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 141         check_added_monitors!(nodes[0], 1);
 142
 143         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 144         assert_eq!(events_0.len(), 1);
 145         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 146                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 147                         (update_fee.as_ref(), commitment_signed)
 148                 },
 149                 _ => panic!("Unexpected event"),
 150         };
 151
 152         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 153
 154         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 155         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 156         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
 157         check_added_monitors!(nodes[1], 1);
 158
 159         let payment_event = {
 160                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 161                 assert_eq!(events_1.len(), 1);
 162                 SendEvent::from_event(events_1.remove(0))
 163         };
 164         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 165         assert_eq!(payment_event.msgs.len(), 1);
 166
 167         // ...now when the messages get delivered everyone should be happy
 168         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 169         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 170         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 171         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 172         check_added_monitors!(nodes[0], 1);
 173
 174         // deliver(1), generate (3):
 175         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 176         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 177         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 178         check_added_monitors!(nodes[1], 1);
 179
 180         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 181         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 182         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 183         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 184         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 185         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 186         assert!(bs_update.update_fee.is_none()); // (4)
 187         check_added_monitors!(nodes[1], 1);
 188
 189         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 190         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 191         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 192         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 193         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 194         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 195         assert!(as_update.update_fee.is_none()); // (5)
 196         check_added_monitors!(nodes[0], 1);
 197
 198         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 199         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 200         // only (6) so get_event_msg's assert(len == 1) passes
 201         check_added_monitors!(nodes[0], 1);
 202
 203         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 204         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 205         check_added_monitors!(nodes[1], 1);
 206
 207         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 208         check_added_monitors!(nodes[0], 1);
 209
 210         let events_2 = nodes[0].node.get_and_clear_pending_events();
 211         assert_eq!(events_2.len(), 1);
 212         match events_2[0] {
 213                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 214                 _ => panic!("Unexpected event"),
 215         }
 216
 217         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 218         check_added_monitors!(nodes[1], 1);
 219 }
 220
 221 #[test]
 222 fn test_update_fee_unordered_raa() {
 223         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 224         // crash in an earlier version of the update_fee patch)
 225         let node_cfgs = create_node_cfgs(2);
 226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 227         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 228         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 229         let channel_id = chan.2;
 230
 231         // balancing
 232         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 233
 234         // First nodes[0] generates an update_fee
 235         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 236         check_added_monitors!(nodes[0], 1);
 237
 238         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 239         assert_eq!(events_0.len(), 1);
 240         let update_msg = match events_0[0] { // (1)
 241                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 242                         update_fee.as_ref()
 243                 },
 244                 _ => panic!("Unexpected event"),
 245         };
 246
 247         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 248
 249         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 250         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 251         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
 252         check_added_monitors!(nodes[1], 1);
 253
 254         let payment_event = {
 255                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 256                 assert_eq!(events_1.len(), 1);
 257                 SendEvent::from_event(events_1.remove(0))
 258         };
 259         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 260         assert_eq!(payment_event.msgs.len(), 1);
 261
 262         // ...now when the messages get delivered everyone should be happy
 263         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 264         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 265         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 266         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 267         check_added_monitors!(nodes[0], 1);
 268
 269         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 270         check_added_monitors!(nodes[1], 1);
 271
 272         // We can't continue, sadly, because our (1) now has a bogus signature
 273 }
 274
 275 #[test]
 276 fn test_multi_flight_update_fee() {
 277         let node_cfgs = create_node_cfgs(2);
 278         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 279         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 280         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 281         let channel_id = chan.2;
 282
 283         // A                                        B
 284         // update_fee/commitment_signed          ->
 285         //                                       .- send (1) RAA and (2) commitment_signed
 286         // update_fee (never committed)          ->
 287         // (3) update_fee                        ->
 288         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 289         // don't track which updates correspond to which revoke_and_ack responses so we're in
 290         // AwaitingRAA mode and will not generate the update_fee yet.
 291         //                                       <- (1) RAA delivered
 292         // (3) is generated and send (4) CS      -.
 293         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 294         // know the per_commitment_point to use for it.
 295         //                                       <- (2) commitment_signed delivered
 296         // revoke_and_ack                        ->
 297         //                                          B should send no response here
 298         // (4) commitment_signed delivered       ->
 299         //                                       <- RAA/commitment_signed delivered
 300         // revoke_and_ack                        ->
 301
 302         // First nodes[0] generates an update_fee
 303         let initial_feerate = get_feerate!(nodes[0], channel_id);
 304         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 305         check_added_monitors!(nodes[0], 1);
 306
 307         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 308         assert_eq!(events_0.len(), 1);
 309         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 310                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 311                         (update_fee.as_ref().unwrap(), commitment_signed)
 312                 },
 313                 _ => panic!("Unexpected event"),
 314         };
 315
 316         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 317         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 318         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 319         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 320         check_added_monitors!(nodes[1], 1);
 321
 322         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 323         // transaction:
 324         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 325         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 326         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 327
 328         // Create the (3) update_fee message that nodes[0] will generate before it does...
 329         let mut update_msg_2 = msgs::UpdateFee {
 330                 channel_id: update_msg_1.channel_id.clone(),
 331                 feerate_per_kw: (initial_feerate + 30) as u32,
 332         };
 333
 334         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 335
 336         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 337         // Deliver (3)
 338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 339
 340         // Deliver (1), generating (3) and (4)
 341         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 342         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 343         check_added_monitors!(nodes[0], 1);
 344         assert!(as_second_update.update_add_htlcs.is_empty());
 345         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 346         assert!(as_second_update.update_fail_htlcs.is_empty());
 347         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 348         // Check that the update_fee newly generated matches what we delivered:
 349         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 350         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 351
 352         // Deliver (2) commitment_signed
 353         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 354         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 355         check_added_monitors!(nodes[0], 1);
 356         // No commitment_signed so get_event_msg's assert(len == 1) passes
 357
 358         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 359         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 360         check_added_monitors!(nodes[1], 1);
 361
 362         // Delever (4)
 363         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 364         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 365         check_added_monitors!(nodes[1], 1);
 366
 367         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 368         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 369         check_added_monitors!(nodes[0], 1);
 370
 371         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 372         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 373         // No commitment_signed so get_event_msg's assert(len == 1) passes
 374         check_added_monitors!(nodes[0], 1);
 375
 376         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 377         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 378         check_added_monitors!(nodes[1], 1);
 379 }
 380
 381 #[test]
 382 fn test_1_conf_open() {
 383         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 384         // tests that we properly send one in that case.
 385         let mut alice_config = UserConfig::default();
 386         alice_config.own_channel_config.minimum_depth = 1;
 387         alice_config.channel_options.announced_channel = true;
 388         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 389         let mut bob_config = UserConfig::default();
 390         bob_config.own_channel_config.minimum_depth = 1;
 391         bob_config.channel_options.announced_channel = true;
 392         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 393         let node_cfgs = create_node_cfgs(2);
 394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 396
 397         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
 398         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 399         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 400
 401         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 402         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 403         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 404
 405         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 406         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 407         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 408
 409         for node in nodes {
 410                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
 411                 node.router.handle_channel_update(&as_update).unwrap();
 412                 node.router.handle_channel_update(&bs_update).unwrap();
 413         }
 414 }
 415
 416 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 417         // Previously, we had issues deserializing channels when we hadn't connected the first block
 418         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 419         // serialization round-trips and simply do steps towards opening a channel and then drop the
 420         // Node objects.
 421
 422         let node_cfgs = create_node_cfgs(2);
 423         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 424         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 425
 426         if steps & 0b1000_0000 != 0{
 427                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 428                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 429                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 430         }
 431
 432         if steps & 0x0f == 0 { return; }
 433         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42).unwrap();
 434         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 435
 436         if steps & 0x0f == 1 { return; }
 437         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &open_channel);
 438         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 439
 440         if steps & 0x0f == 2 { return; }
 441         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
 442
 443         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 444
 445         if steps & 0x0f == 3 { return; }
 446         {
 447                 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 448                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 449                 assert_eq!(added_monitors.len(), 1);
 450                 assert_eq!(added_monitors[0].0, funding_output);
 451                 added_monitors.clear();
 452         }
 453         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 454
 455         if steps & 0x0f == 4 { return; }
 456         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 457         {
 458                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 459                 assert_eq!(added_monitors.len(), 1);
 460                 assert_eq!(added_monitors[0].0, funding_output);
 461                 added_monitors.clear();
 462         }
 463         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 464
 465         if steps & 0x0f == 5 { return; }
 466         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 467         {
 468                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 469                 assert_eq!(added_monitors.len(), 1);
 470                 assert_eq!(added_monitors[0].0, funding_output);
 471                 added_monitors.clear();
 472         }
 473
 474         let events_4 = nodes[0].node.get_and_clear_pending_events();
 475         assert_eq!(events_4.len(), 1);
 476         match events_4[0] {
 477                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 478                         assert_eq!(user_channel_id, 42);
 479                         assert_eq!(*funding_txo, funding_output);
 480                 },
 481                 _ => panic!("Unexpected event"),
 482         };
 483
 484         if steps & 0x0f == 6 { return; }
 485         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 486
 487         if steps & 0x0f == 7 { return; }
 488         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 489         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 490 }
 491
 492 #[test]
 493 fn test_sanity_on_in_flight_opens() {
 494         do_test_sanity_on_in_flight_opens(0);
 495         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 496         do_test_sanity_on_in_flight_opens(1);
 497         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 498         do_test_sanity_on_in_flight_opens(2);
 499         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 500         do_test_sanity_on_in_flight_opens(3);
 501         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 502         do_test_sanity_on_in_flight_opens(4);
 503         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 504         do_test_sanity_on_in_flight_opens(5);
 505         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 506         do_test_sanity_on_in_flight_opens(6);
 507         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 508         do_test_sanity_on_in_flight_opens(7);
 509         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(8);
 511         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 512 }
 513
 514 #[test]
 515 fn test_update_fee_vanilla() {
 516         let node_cfgs = create_node_cfgs(2);
 517         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 518         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 519         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 520         let channel_id = chan.2;
 521
 522         let feerate = get_feerate!(nodes[0], channel_id);
 523         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 524         check_added_monitors!(nodes[0], 1);
 525
 526         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 527         assert_eq!(events_0.len(), 1);
 528         let (update_msg, commitment_signed) = match events_0[0] {
 529                         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 } } => {
 530                         (update_fee.as_ref(), commitment_signed)
 531                 },
 532                 _ => panic!("Unexpected event"),
 533         };
 534         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 535
 536         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 537         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 538         check_added_monitors!(nodes[1], 1);
 539
 540         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 541         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 542         check_added_monitors!(nodes[0], 1);
 543
 544         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 545         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 546         // No commitment_signed so get_event_msg's assert(len == 1) passes
 547         check_added_monitors!(nodes[0], 1);
 548
 549         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 550         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 551         check_added_monitors!(nodes[1], 1);
 552 }
 553
 554 #[test]
 555 fn test_update_fee_that_funder_cannot_afford() {
 556         let node_cfgs = create_node_cfgs(2);
 557         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 558         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 559         let channel_value = 1888;
 560         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 561         let channel_id = chan.2;
 562
 563         let feerate = 260;
 564         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 565         check_added_monitors!(nodes[0], 1);
 566         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 567
 568         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 569
 570         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 571
 572         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 573         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 574         {
 575                 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
 576                 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
 577
 578                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 579                 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
 580                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 581                 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
 582                 actual_fee = channel_value - actual_fee;
 583                 assert_eq!(total_fee, actual_fee);
 584         } //drop the mutex
 585
 586         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 587         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 588         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 589         check_added_monitors!(nodes[0], 1);
 590
 591         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 592
 593         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 594
 595         //While producing the commitment_signed response after handling a received update_fee request the
 596         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 597         //Should produce and error.
 598         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 599         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 600
 601         //clear the message we could not handle
 602         nodes[1].node.get_and_clear_pending_msg_events();
 603 }
 604
 605 #[test]
 606 fn test_update_fee_with_fundee_update_add_htlc() {
 607         let node_cfgs = create_node_cfgs(2);
 608         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 609         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 610         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 611         let channel_id = chan.2;
 612
 613         // balancing
 614         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 615
 616         let feerate = get_feerate!(nodes[0], channel_id);
 617         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 618         check_added_monitors!(nodes[0], 1);
 619
 620         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 621         assert_eq!(events_0.len(), 1);
 622         let (update_msg, commitment_signed) = match events_0[0] {
 623                         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 } } => {
 624                         (update_fee.as_ref(), commitment_signed)
 625                 },
 626                 _ => panic!("Unexpected event"),
 627         };
 628         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 629         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 630         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 631         check_added_monitors!(nodes[1], 1);
 632
 633         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 634
 635         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 636
 637         // nothing happens since node[1] is in AwaitingRemoteRevoke
 638         nodes[1].node.send_payment(route, our_payment_hash).unwrap();
 639         {
 640                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 641                 assert_eq!(added_monitors.len(), 0);
 642                 added_monitors.clear();
 643         }
 644         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 645         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 646         // node[1] has nothing to do
 647
 648         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 649         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 650         check_added_monitors!(nodes[0], 1);
 651
 652         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 653         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 654         // No commitment_signed so get_event_msg's assert(len == 1) passes
 655         check_added_monitors!(nodes[0], 1);
 656         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 657         check_added_monitors!(nodes[1], 1);
 658         // AwaitingRemoteRevoke ends here
 659
 660         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 661         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 662         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 663         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 664         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 665         assert_eq!(commitment_update.update_fee.is_none(), true);
 666
 667         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 668         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 669         check_added_monitors!(nodes[0], 1);
 670         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 671
 672         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 673         check_added_monitors!(nodes[1], 1);
 674         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 675
 676         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 677         check_added_monitors!(nodes[1], 1);
 678         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 679         // No commitment_signed so get_event_msg's assert(len == 1) passes
 680
 681         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 682         check_added_monitors!(nodes[0], 1);
 683         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 684
 685         expect_pending_htlcs_forwardable!(nodes[0]);
 686
 687         let events = nodes[0].node.get_and_clear_pending_events();
 688         assert_eq!(events.len(), 1);
 689         match events[0] {
 690                 Event::PaymentReceived { .. } => { },
 691                 _ => panic!("Unexpected event"),
 692         };
 693
 694         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 695
 696         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 697         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 698         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 699 }
 700
 701 #[test]
 702 fn test_update_fee() {
 703         let node_cfgs = create_node_cfgs(2);
 704         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 705         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 706         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 707         let channel_id = chan.2;
 708
 709         // A                                        B
 710         // (1) update_fee/commitment_signed      ->
 711         //                                       <- (2) revoke_and_ack
 712         //                                       .- send (3) commitment_signed
 713         // (4) update_fee/commitment_signed      ->
 714         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 715         //                                       <- (3) commitment_signed delivered
 716         // send (6) revoke_and_ack               -.
 717         //                                       <- (5) deliver revoke_and_ack
 718         // (6) deliver revoke_and_ack            ->
 719         //                                       .- send (7) commitment_signed in response to (4)
 720         //                                       <- (7) deliver commitment_signed
 721         // revoke_and_ack                        ->
 722
 723         // Create and deliver (1)...
 724         let feerate = get_feerate!(nodes[0], channel_id);
 725         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 726         check_added_monitors!(nodes[0], 1);
 727
 728         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 729         assert_eq!(events_0.len(), 1);
 730         let (update_msg, commitment_signed) = match events_0[0] {
 731                         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 } } => {
 732                         (update_fee.as_ref(), commitment_signed)
 733                 },
 734                 _ => panic!("Unexpected event"),
 735         };
 736         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 737
 738         // Generate (2) and (3):
 739         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 740         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 741         check_added_monitors!(nodes[1], 1);
 742
 743         // Deliver (2):
 744         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 745         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 746         check_added_monitors!(nodes[0], 1);
 747
 748         // Create and deliver (4)...
 749         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 750         check_added_monitors!(nodes[0], 1);
 751         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 752         assert_eq!(events_0.len(), 1);
 753         let (update_msg, commitment_signed) = match events_0[0] {
 754                         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 } } => {
 755                         (update_fee.as_ref(), commitment_signed)
 756                 },
 757                 _ => panic!("Unexpected event"),
 758         };
 759
 760         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 761         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 762         check_added_monitors!(nodes[1], 1);
 763         // ... creating (5)
 764         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 765         // No commitment_signed so get_event_msg's assert(len == 1) passes
 766
 767         // Handle (3), creating (6):
 768         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 769         check_added_monitors!(nodes[0], 1);
 770         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 771         // No commitment_signed so get_event_msg's assert(len == 1) passes
 772
 773         // Deliver (5):
 774         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 775         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 776         check_added_monitors!(nodes[0], 1);
 777
 778         // Deliver (6), creating (7):
 779         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 780         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 781         assert!(commitment_update.update_add_htlcs.is_empty());
 782         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 783         assert!(commitment_update.update_fail_htlcs.is_empty());
 784         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 785         assert!(commitment_update.update_fee.is_none());
 786         check_added_monitors!(nodes[1], 1);
 787
 788         // Deliver (7)
 789         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 790         check_added_monitors!(nodes[0], 1);
 791         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 792         // No commitment_signed so get_event_msg's assert(len == 1) passes
 793
 794         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 795         check_added_monitors!(nodes[1], 1);
 796         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 797
 798         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 799         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 800         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 801 }
 802
 803 #[test]
 804 fn pre_funding_lock_shutdown_test() {
 805         // Test sending a shutdown prior to funding_locked after funding generation
 806         let node_cfgs = create_node_cfgs(2);
 807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 808         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 809         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 810         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 811         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 812         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 813
 814         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 815         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 816         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 817         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 818         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 819
 820         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 821         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 822         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 823         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 824         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 825         assert!(node_0_none.is_none());
 826
 827         assert!(nodes[0].node.list_channels().is_empty());
 828         assert!(nodes[1].node.list_channels().is_empty());
 829 }
 830
 831 #[test]
 832 fn updates_shutdown_wait() {
 833         // Test sending a shutdown with outstanding updates pending
 834         let node_cfgs = create_node_cfgs(3);
 835         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 836         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 837         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 838         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 839         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 840         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 841
 842         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 843
 844         nodes[0].node.close_channel(&chan_1.2).unwrap();
 845         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 846         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 847         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 848         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 849
 850         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 851         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 852
 853         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 854         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
 855         else { panic!("New sends should fail!") };
 856         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
 857         else { panic!("New sends should fail!") };
 858
 859         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 860         check_added_monitors!(nodes[2], 1);
 861         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 862         assert!(updates.update_add_htlcs.is_empty());
 863         assert!(updates.update_fail_htlcs.is_empty());
 864         assert!(updates.update_fail_malformed_htlcs.is_empty());
 865         assert!(updates.update_fee.is_none());
 866         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 867         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 868         check_added_monitors!(nodes[1], 1);
 869         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 870         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 871
 872         assert!(updates_2.update_add_htlcs.is_empty());
 873         assert!(updates_2.update_fail_htlcs.is_empty());
 874         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 875         assert!(updates_2.update_fee.is_none());
 876         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 877         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 878         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 879
 880         let events = nodes[0].node.get_and_clear_pending_events();
 881         assert_eq!(events.len(), 1);
 882         match events[0] {
 883                 Event::PaymentSent { ref payment_preimage } => {
 884                         assert_eq!(our_payment_preimage, *payment_preimage);
 885                 },
 886                 _ => panic!("Unexpected event"),
 887         }
 888
 889         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 890         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 891         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 892         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 893         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 894         assert!(node_0_none.is_none());
 895
 896         assert!(nodes[0].node.list_channels().is_empty());
 897
 898         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 899         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 900         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 901         assert!(nodes[1].node.list_channels().is_empty());
 902         assert!(nodes[2].node.list_channels().is_empty());
 903 }
 904
 905 #[test]
 906 fn htlc_fail_async_shutdown() {
 907         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 908         let node_cfgs = create_node_cfgs(3);
 909         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 910         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 911         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 912         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 913
 914         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 915         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 916         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
 917         check_added_monitors!(nodes[0], 1);
 918         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 919         assert_eq!(updates.update_add_htlcs.len(), 1);
 920         assert!(updates.update_fulfill_htlcs.is_empty());
 921         assert!(updates.update_fail_htlcs.is_empty());
 922         assert!(updates.update_fail_malformed_htlcs.is_empty());
 923         assert!(updates.update_fee.is_none());
 924
 925         nodes[1].node.close_channel(&chan_1.2).unwrap();
 926         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 927         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 928         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 929
 930         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 931         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 932         check_added_monitors!(nodes[1], 1);
 933         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 934         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 935
 936         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 937         assert!(updates_2.update_add_htlcs.is_empty());
 938         assert!(updates_2.update_fulfill_htlcs.is_empty());
 939         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 940         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 941         assert!(updates_2.update_fee.is_none());
 942
 943         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 944         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 945
 946         let events = nodes[0].node.get_and_clear_pending_events();
 947         assert_eq!(events.len(), 1);
 948         match events[0] {
 949                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 950                         assert_eq!(our_payment_hash, *payment_hash);
 951                         assert!(!rejected_by_dest);
 952                 },
 953                 _ => panic!("Unexpected event"),
 954         }
 955
 956         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 957         assert_eq!(msg_events.len(), 2);
 958         let node_0_closing_signed = match msg_events[0] {
 959                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 960                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 961                         (*msg).clone()
 962                 },
 963                 _ => panic!("Unexpected event"),
 964         };
 965         match msg_events[1] {
 966                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 967                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 968                 },
 969                 _ => panic!("Unexpected event"),
 970         }
 971
 972         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 973         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 974         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 975         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 976         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 977         assert!(node_0_none.is_none());
 978
 979         assert!(nodes[0].node.list_channels().is_empty());
 980
 981         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 982         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 983         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 984         assert!(nodes[1].node.list_channels().is_empty());
 985         assert!(nodes[2].node.list_channels().is_empty());
 986 }
 987
 988 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 989         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 990         // messages delivered prior to disconnect
 991         let node_cfgs = create_node_cfgs(3);
 992         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 993         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 994         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 995         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 996
 997         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 998
 999         nodes[1].node.close_channel(&chan_1.2).unwrap();
1000         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1001         if recv_count > 0 {
1002                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1003                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1004                 if recv_count > 1 {
1005                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1006                 }
1007         }
1008
1009         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1010         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1011
1012         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1013         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1014         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1015         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1016
1017         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1018         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1019         assert!(node_1_shutdown == node_1_2nd_shutdown);
1020
1021         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1022         let node_0_2nd_shutdown = if recv_count > 0 {
1023                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1024                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1025                 node_0_2nd_shutdown
1026         } else {
1027                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1028                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1029                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1030         };
1031         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1032
1033         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1034         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1035
1036         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
1037         check_added_monitors!(nodes[2], 1);
1038         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1039         assert!(updates.update_add_htlcs.is_empty());
1040         assert!(updates.update_fail_htlcs.is_empty());
1041         assert!(updates.update_fail_malformed_htlcs.is_empty());
1042         assert!(updates.update_fee.is_none());
1043         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1044         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1045         check_added_monitors!(nodes[1], 1);
1046         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1047         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1048
1049         assert!(updates_2.update_add_htlcs.is_empty());
1050         assert!(updates_2.update_fail_htlcs.is_empty());
1051         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1052         assert!(updates_2.update_fee.is_none());
1053         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1054         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1055         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1056
1057         let events = nodes[0].node.get_and_clear_pending_events();
1058         assert_eq!(events.len(), 1);
1059         match events[0] {
1060                 Event::PaymentSent { ref payment_preimage } => {
1061                         assert_eq!(our_payment_preimage, *payment_preimage);
1062                 },
1063                 _ => panic!("Unexpected event"),
1064         }
1065
1066         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1067         if recv_count > 0 {
1068                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1069                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1070                 assert!(node_1_closing_signed.is_some());
1071         }
1072
1073         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1074         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1075
1076         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1077         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1078         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1079         if recv_count == 0 {
1080                 // If all closing_signeds weren't delivered we can just resume where we left off...
1081                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1082
1083                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1084                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1085                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1086
1087                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1088                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1089                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1090
1091                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1092                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1093
1094                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1095                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1096                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1097
1098                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1099                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1100                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1101                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1102                 assert!(node_0_none.is_none());
1103         } else {
1104                 // If one node, however, received + responded with an identical closing_signed we end
1105                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1106                 // There isn't really anything better we can do simply, but in the future we might
1107                 // explore storing a set of recently-closed channels that got disconnected during
1108                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1109                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1110                 // transaction.
1111                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1112
1113                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1114                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1115                 assert_eq!(msg_events.len(), 1);
1116                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1117                         match action {
1118                                 &ErrorAction::SendErrorMessage { ref msg } => {
1119                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1120                                         assert_eq!(msg.channel_id, chan_1.2);
1121                                 },
1122                                 _ => panic!("Unexpected event!"),
1123                         }
1124                 } else { panic!("Needed SendErrorMessage close"); }
1125
1126                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1127                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1128                 // closing_signed so we do it ourselves
1129                 check_closed_broadcast!(nodes[0], false);
1130         }
1131
1132         assert!(nodes[0].node.list_channels().is_empty());
1133
1134         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1135         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1136         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1137         assert!(nodes[1].node.list_channels().is_empty());
1138         assert!(nodes[2].node.list_channels().is_empty());
1139 }
1140
1141 #[test]
1142 fn test_shutdown_rebroadcast() {
1143         do_test_shutdown_rebroadcast(0);
1144         do_test_shutdown_rebroadcast(1);
1145         do_test_shutdown_rebroadcast(2);
1146 }
1147
1148 #[test]
1149 fn fake_network_test() {
1150         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1151         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1152         let node_cfgs = create_node_cfgs(4);
1153         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1154         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1155
1156         // Create some initial channels
1157         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1158         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1159         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1160
1161         // Rebalance the network a bit by relaying one payment through all the channels...
1162         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1163         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1164         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1165         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1166
1167         // Send some more payments
1168         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1169         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1170         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1171
1172         // Test failure packets
1173         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1174         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1175
1176         // Add a new channel that skips 3
1177         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1178
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1180         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1181         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1182         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1183         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1184         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1185         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1186
1187         // Do some rebalance loop payments, simultaneously
1188         let mut hops = Vec::with_capacity(3);
1189         hops.push(RouteHop {
1190                 pubkey: nodes[2].node.get_our_node_id(),
1191                 node_features: NodeFeatures::empty(),
1192                 short_channel_id: chan_2.0.contents.short_channel_id,
1193                 channel_features: ChannelFeatures::empty(),
1194                 fee_msat: 0,
1195                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1196         });
1197         hops.push(RouteHop {
1198                 pubkey: nodes[3].node.get_our_node_id(),
1199                 node_features: NodeFeatures::empty(),
1200                 short_channel_id: chan_3.0.contents.short_channel_id,
1201                 channel_features: ChannelFeatures::empty(),
1202                 fee_msat: 0,
1203                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1204         });
1205         hops.push(RouteHop {
1206                 pubkey: nodes[1].node.get_our_node_id(),
1207                 node_features: NodeFeatures::empty(),
1208                 short_channel_id: chan_4.0.contents.short_channel_id,
1209                 channel_features: ChannelFeatures::empty(),
1210                 fee_msat: 1000000,
1211                 cltv_expiry_delta: TEST_FINAL_CLTV,
1212         });
1213         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;
1214         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;
1215         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1216
1217         let mut hops = Vec::with_capacity(3);
1218         hops.push(RouteHop {
1219                 pubkey: nodes[3].node.get_our_node_id(),
1220                 node_features: NodeFeatures::empty(),
1221                 short_channel_id: chan_4.0.contents.short_channel_id,
1222                 channel_features: ChannelFeatures::empty(),
1223                 fee_msat: 0,
1224                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1225         });
1226         hops.push(RouteHop {
1227                 pubkey: nodes[2].node.get_our_node_id(),
1228                 node_features: NodeFeatures::empty(),
1229                 short_channel_id: chan_3.0.contents.short_channel_id,
1230                 channel_features: ChannelFeatures::empty(),
1231                 fee_msat: 0,
1232                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1233         });
1234         hops.push(RouteHop {
1235                 pubkey: nodes[1].node.get_our_node_id(),
1236                 node_features: NodeFeatures::empty(),
1237                 short_channel_id: chan_2.0.contents.short_channel_id,
1238                 channel_features: ChannelFeatures::empty(),
1239                 fee_msat: 1000000,
1240                 cltv_expiry_delta: TEST_FINAL_CLTV,
1241         });
1242         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;
1243         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;
1244         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1245
1246         // Claim the rebalances...
1247         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1248         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1249
1250         // Add a duplicate new channel from 2 to 4
1251         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1252
1253         // Send some payments across both channels
1254         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1255         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1256         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1257
1258
1259         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1260         let events = nodes[0].node.get_and_clear_pending_msg_events();
1261         assert_eq!(events.len(), 0);
1262         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);
1263
1264         //TODO: Test that routes work again here as we've been notified that the channel is full
1265
1266         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1267         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1268         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1269
1270         // Close down the channels...
1271         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1272         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1273         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1274         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1275         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1276 }
1277
1278 #[test]
1279 fn holding_cell_htlc_counting() {
1280         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1281         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1282         // commitment dance rounds.
1283         let node_cfgs = create_node_cfgs(3);
1284         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1285         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1286         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1287         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1288
1289         let mut payments = Vec::new();
1290         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1291                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1292                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1293                 nodes[1].node.send_payment(route, payment_hash).unwrap();
1294                 payments.push((payment_preimage, payment_hash));
1295         }
1296         check_added_monitors!(nodes[1], 1);
1297
1298         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1299         assert_eq!(events.len(), 1);
1300         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1301         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1302
1303         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1304         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1305         // another HTLC.
1306         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1307         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1308         if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1309                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1310         } else { panic!("Unexpected event"); }
1311         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1312         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1313
1314         // This should also be true if we try to forward a payment.
1315         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1316         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1317         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1318         check_added_monitors!(nodes[0], 1);
1319
1320         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1321         assert_eq!(events.len(), 1);
1322         let payment_event = SendEvent::from_event(events.pop().unwrap());
1323         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1324
1325         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1326         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1327         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1328         // fails), the second will process the resulting failure and fail the HTLC backward.
1329         expect_pending_htlcs_forwardable!(nodes[1]);
1330         expect_pending_htlcs_forwardable!(nodes[1]);
1331         check_added_monitors!(nodes[1], 1);
1332
1333         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1334         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1335         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1336
1337         let events = nodes[0].node.get_and_clear_pending_msg_events();
1338         assert_eq!(events.len(), 1);
1339         match events[0] {
1340                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1341                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1342                 },
1343                 _ => panic!("Unexpected event"),
1344         }
1345
1346         let events = nodes[0].node.get_and_clear_pending_events();
1347         assert_eq!(events.len(), 1);
1348         match events[0] {
1349                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1350                         assert_eq!(payment_hash, payment_hash_2);
1351                         assert!(!rejected_by_dest);
1352                 },
1353                 _ => panic!("Unexpected event"),
1354         }
1355
1356         // Now forward all the pending HTLCs and claim them back
1357         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1358         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1359         check_added_monitors!(nodes[2], 1);
1360
1361         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1362         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1363         check_added_monitors!(nodes[1], 1);
1364         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1365
1366         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1367         check_added_monitors!(nodes[1], 1);
1368         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1369
1370         for ref update in as_updates.update_add_htlcs.iter() {
1371                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1372         }
1373         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1374         check_added_monitors!(nodes[2], 1);
1375         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1376         check_added_monitors!(nodes[2], 1);
1377         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378
1379         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1380         check_added_monitors!(nodes[1], 1);
1381         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1382         check_added_monitors!(nodes[1], 1);
1383         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1384
1385         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1386         check_added_monitors!(nodes[2], 1);
1387
1388         expect_pending_htlcs_forwardable!(nodes[2]);
1389
1390         let events = nodes[2].node.get_and_clear_pending_events();
1391         assert_eq!(events.len(), payments.len());
1392         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1393                 match event {
1394                         &Event::PaymentReceived { ref payment_hash, .. } => {
1395                                 assert_eq!(*payment_hash, *hash);
1396                         },
1397                         _ => panic!("Unexpected event"),
1398                 };
1399         }
1400
1401         for (preimage, _) in payments.drain(..) {
1402                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1403         }
1404
1405         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1406 }
1407
1408 #[test]
1409 fn duplicate_htlc_test() {
1410         // Test that we accept duplicate payment_hash HTLCs across the network and that
1411         // claiming/failing them are all separate and don't affect each other
1412         let node_cfgs = create_node_cfgs(6);
1413         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1414         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1415
1416         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1417         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1418         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1419         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1420         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1421         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1422
1423         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1424
1425         *nodes[0].network_payment_count.borrow_mut() -= 1;
1426         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1427
1428         *nodes[0].network_payment_count.borrow_mut() -= 1;
1429         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1430
1431         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1432         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1433         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1434 }
1435
1436 #[test]
1437 fn test_duplicate_htlc_different_direction_onchain() {
1438         // Test that ChannelMonitor doesn't generate 2 preimage txn
1439         // when we have 2 HTLCs with same preimage that go across a node
1440         // in opposite directions.
1441         let node_cfgs = create_node_cfgs(2);
1442         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1443         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1444
1445         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1446
1447         // balancing
1448         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1449
1450         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1451
1452         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1453         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1454
1455         // Provide preimage to node 0 by claiming payment
1456         nodes[0].node.claim_funds(payment_preimage, 800_000);
1457         check_added_monitors!(nodes[0], 1);
1458
1459         // Broadcast node 1 commitment txn
1460         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();
1461
1462         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1463         let mut has_both_htlcs = 0; // check htlcs match ones committed
1464         for outp in remote_txn[0].output.iter() {
1465                 if outp.value == 800_000 / 1000 {
1466                         has_both_htlcs += 1;
1467                 } else if outp.value == 900_000 / 1000 {
1468                         has_both_htlcs += 1;
1469                 }
1470         }
1471         assert_eq!(has_both_htlcs, 2);
1472
1473         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1474         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1475
1476         // Check we only broadcast 1 timeout tx
1477         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1478         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()) };
1479         assert_eq!(claim_txn.len(), 5);
1480         check_spends!(claim_txn[2], chan_1.3);
1481         check_spends!(claim_txn[3], claim_txn[2]);
1482         assert_eq!(htlc_pair.0.input.len(), 1);
1483         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1484         check_spends!(htlc_pair.0, remote_txn[0].clone());
1485         assert_eq!(htlc_pair.1.input.len(), 1);
1486         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1487         check_spends!(htlc_pair.1, remote_txn[0].clone());
1488
1489         let events = nodes[0].node.get_and_clear_pending_msg_events();
1490         assert_eq!(events.len(), 2);
1491         for e in events {
1492                 match e {
1493                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1494                         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, .. } } => {
1495                                 assert!(update_add_htlcs.is_empty());
1496                                 assert!(update_fail_htlcs.is_empty());
1497                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1498                                 assert!(update_fail_malformed_htlcs.is_empty());
1499                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1500                         },
1501                         _ => panic!("Unexpected event"),
1502                 }
1503         }
1504 }
1505
1506 fn do_channel_reserve_test(test_recv: bool) {
1507
1508         let node_cfgs = create_node_cfgs(3);
1509         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1510         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1511         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1512         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1513
1514         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1515         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1516
1517         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1518         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1519
1520         macro_rules! get_route_and_payment_hash {
1521                 ($recv_value: expr) => {{
1522                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1523                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1524                         (route, payment_hash, payment_preimage)
1525                 }}
1526         };
1527
1528         macro_rules! expect_forward {
1529                 ($node: expr) => {{
1530                         let mut events = $node.node.get_and_clear_pending_msg_events();
1531                         assert_eq!(events.len(), 1);
1532                         check_added_monitors!($node, 1);
1533                         let payment_event = SendEvent::from_event(events.remove(0));
1534                         payment_event
1535                 }}
1536         }
1537
1538         let feemsat = 239; // somehow we know?
1539         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1540
1541         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1542
1543         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1544         {
1545                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1546                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1547                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1548                 match err {
1549                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1550                         _ => panic!("Unknown error variants"),
1551                 }
1552                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1553                 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);
1554         }
1555
1556         let mut htlc_id = 0;
1557         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1558         // nodes[0]'s wealth
1559         loop {
1560                 let amt_msat = recv_value_0 + total_fee_msat;
1561                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1562                         break;
1563                 }
1564                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1565                 htlc_id += 1;
1566
1567                 let (stat01_, stat11_, stat12_, stat22_) = (
1568                         get_channel_value_stat!(nodes[0], chan_1.2),
1569                         get_channel_value_stat!(nodes[1], chan_1.2),
1570                         get_channel_value_stat!(nodes[1], chan_2.2),
1571                         get_channel_value_stat!(nodes[2], chan_2.2),
1572                 );
1573
1574                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1575                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1576                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1577                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1578                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1579         }
1580
1581         {
1582                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1583                 // attempt to get channel_reserve violation
1584                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1585                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1586                 match err {
1587                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1588                         _ => panic!("Unknown error variants"),
1589                 }
1590                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1591                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1592         }
1593
1594         // adding pending output
1595         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1596         let amt_msat_1 = recv_value_1 + total_fee_msat;
1597
1598         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1599         let payment_event_1 = {
1600                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1601                 check_added_monitors!(nodes[0], 1);
1602
1603                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1604                 assert_eq!(events.len(), 1);
1605                 SendEvent::from_event(events.remove(0))
1606         };
1607         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1608
1609         // channel reserve test with htlc pending output > 0
1610         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1611         {
1612                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1613                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1614                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1615                         _ => panic!("Unknown error variants"),
1616                 }
1617                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1618                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1619         }
1620
1621         {
1622                 // test channel_reserve test on nodes[1] side
1623                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1624
1625                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1626                 let secp_ctx = Secp256k1::new();
1627                 let session_priv = SecretKey::from_slice(&{
1628                         let mut session_key = [0; 32];
1629                         let mut rng = thread_rng();
1630                         rng.fill_bytes(&mut session_key);
1631                         session_key
1632                 }).expect("RNG is bad!");
1633
1634                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1635                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1636                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1637                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1638                 let msg = msgs::UpdateAddHTLC {
1639                         channel_id: chan_1.2,
1640                         htlc_id,
1641                         amount_msat: htlc_msat,
1642                         payment_hash: our_payment_hash,
1643                         cltv_expiry: htlc_cltv,
1644                         onion_routing_packet: onion_packet,
1645                 };
1646
1647                 if test_recv {
1648                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1649                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1650                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1651                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1652                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1653                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1654                         return;
1655                 }
1656         }
1657
1658         // split the rest to test holding cell
1659         let recv_value_21 = recv_value_2/2;
1660         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1661         {
1662                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1663                 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);
1664         }
1665
1666         // now see if they go through on both sides
1667         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1668         // but this will stuck in the holding cell
1669         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1670         check_added_monitors!(nodes[0], 0);
1671         let events = nodes[0].node.get_and_clear_pending_events();
1672         assert_eq!(events.len(), 0);
1673
1674         // test with outbound holding cell amount > 0
1675         {
1676                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1677                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1678                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1679                         _ => panic!("Unknown error variants"),
1680                 }
1681                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1682                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1683         }
1684
1685         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1686         // this will also stuck in the holding cell
1687         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1688         check_added_monitors!(nodes[0], 0);
1689         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1691
1692         // flush the pending htlc
1693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1694         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1695         check_added_monitors!(nodes[1], 1);
1696
1697         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1698         check_added_monitors!(nodes[0], 1);
1699         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1700
1701         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1702         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1703         // No commitment_signed so get_event_msg's assert(len == 1) passes
1704         check_added_monitors!(nodes[0], 1);
1705
1706         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1707         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1708         check_added_monitors!(nodes[1], 1);
1709
1710         expect_pending_htlcs_forwardable!(nodes[1]);
1711
1712         let ref payment_event_11 = expect_forward!(nodes[1]);
1713         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1714         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1715
1716         expect_pending_htlcs_forwardable!(nodes[2]);
1717         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1718
1719         // flush the htlcs in the holding cell
1720         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1721         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1722         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1723         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1724         expect_pending_htlcs_forwardable!(nodes[1]);
1725
1726         let ref payment_event_3 = expect_forward!(nodes[1]);
1727         assert_eq!(payment_event_3.msgs.len(), 2);
1728         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1729         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1730
1731         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1732         expect_pending_htlcs_forwardable!(nodes[2]);
1733
1734         let events = nodes[2].node.get_and_clear_pending_events();
1735         assert_eq!(events.len(), 2);
1736         match events[0] {
1737                 Event::PaymentReceived { ref payment_hash, amt } => {
1738                         assert_eq!(our_payment_hash_21, *payment_hash);
1739                         assert_eq!(recv_value_21, amt);
1740                 },
1741                 _ => panic!("Unexpected event"),
1742         }
1743         match events[1] {
1744                 Event::PaymentReceived { ref payment_hash, amt } => {
1745                         assert_eq!(our_payment_hash_22, *payment_hash);
1746                         assert_eq!(recv_value_22, amt);
1747                 },
1748                 _ => panic!("Unexpected event"),
1749         }
1750
1751         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1752         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1753         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1754
1755         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);
1756         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1757         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1758         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1759
1760         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1761         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1762 }
1763
1764 #[test]
1765 fn channel_reserve_test() {
1766         do_channel_reserve_test(false);
1767         do_channel_reserve_test(true);
1768 }
1769
1770 #[test]
1771 fn channel_reserve_in_flight_removes() {
1772         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1773         // can send to its counterparty, but due to update ordering, the other side may not yet have
1774         // considered those HTLCs fully removed.
1775         // This tests that we don't count HTLCs which will not be included in the next remote
1776         // commitment transaction towards the reserve value (as it implies no commitment transaction
1777         // will be generated which violates the remote reserve value).
1778         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1779         // To test this we:
1780         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1781         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1782         //    you only consider the value of the first HTLC, it may not),
1783         //  * start routing a third HTLC from A to B,
1784         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1785         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1786         //  * deliver the first fulfill from B
1787         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1788         //    claim,
1789         //  * deliver A's response CS and RAA.
1790         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1791         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1792         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1793         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1794         let node_cfgs = create_node_cfgs(2);
1795         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1796         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1797         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1798
1799         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1800         // Route the first two HTLCs.
1801         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1802         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1803
1804         // Start routing the third HTLC (this is just used to get everyone in the right state).
1805         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1806         let send_1 = {
1807                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1808                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1809                 check_added_monitors!(nodes[0], 1);
1810                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1811                 assert_eq!(events.len(), 1);
1812                 SendEvent::from_event(events.remove(0))
1813         };
1814
1815         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1816         // initial fulfill/CS.
1817         assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1818         check_added_monitors!(nodes[1], 1);
1819         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1820
1821         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1822         // remove the second HTLC when we send the HTLC back from B to A.
1823         assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1824         check_added_monitors!(nodes[1], 1);
1825         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1826
1827         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1828         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1829         check_added_monitors!(nodes[0], 1);
1830         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1831         expect_payment_sent!(nodes[0], payment_preimage_1);
1832
1833         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1834         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1835         check_added_monitors!(nodes[1], 1);
1836         // B is already AwaitingRAA, so cant generate a CS here
1837         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1838
1839         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1840         check_added_monitors!(nodes[1], 1);
1841         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1842
1843         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1844         check_added_monitors!(nodes[0], 1);
1845         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1846
1847         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1848         check_added_monitors!(nodes[1], 1);
1849         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1850
1851         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1852         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1853         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1854         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1855         // on-chain as necessary).
1856         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1857         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1858         check_added_monitors!(nodes[0], 1);
1859         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1860         expect_payment_sent!(nodes[0], payment_preimage_2);
1861
1862         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1863         check_added_monitors!(nodes[1], 1);
1864         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1865
1866         expect_pending_htlcs_forwardable!(nodes[1]);
1867         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1868
1869         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1870         // resolve the second HTLC from A's point of view.
1871         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1872         check_added_monitors!(nodes[0], 1);
1873         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1874
1875         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1876         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1877         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1878         let send_2 = {
1879                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1880                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1881                 check_added_monitors!(nodes[1], 1);
1882                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1883                 assert_eq!(events.len(), 1);
1884                 SendEvent::from_event(events.remove(0))
1885         };
1886
1887         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1888         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1889         check_added_monitors!(nodes[0], 1);
1890         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1891
1892         // Now just resolve all the outstanding messages/HTLCs for completeness...
1893
1894         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1895         check_added_monitors!(nodes[1], 1);
1896         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1897
1898         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1899         check_added_monitors!(nodes[1], 1);
1900
1901         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1902         check_added_monitors!(nodes[0], 1);
1903         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1904
1905         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1906         check_added_monitors!(nodes[1], 1);
1907         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1908
1909         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1910         check_added_monitors!(nodes[0], 1);
1911
1912         expect_pending_htlcs_forwardable!(nodes[0]);
1913         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1914
1915         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1916         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1917 }
1918
1919 #[test]
1920 fn channel_monitor_network_test() {
1921         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1922         // tests that ChannelMonitor is able to recover from various states.
1923         let node_cfgs = create_node_cfgs(5);
1924         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1925         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1926
1927         // Create some initial channels
1928         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1929         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1930         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1931         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1932
1933         // Rebalance the network a bit by relaying one payment through all the channels...
1934         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1935         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1936         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1937         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1938
1939         // Simple case with no pending HTLCs:
1940         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1941         {
1942                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1943                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1944                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1945                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1946         }
1947         get_announce_close_broadcast_events(&nodes, 0, 1);
1948         assert_eq!(nodes[0].node.list_channels().len(), 0);
1949         assert_eq!(nodes[1].node.list_channels().len(), 1);
1950
1951         // One pending HTLC is discarded by the force-close:
1952         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1953
1954         // Simple case of one pending HTLC to HTLC-Timeout
1955         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1956         {
1957                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1958                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1959                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1960                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1961         }
1962         get_announce_close_broadcast_events(&nodes, 1, 2);
1963         assert_eq!(nodes[1].node.list_channels().len(), 0);
1964         assert_eq!(nodes[2].node.list_channels().len(), 1);
1965
1966         macro_rules! claim_funds {
1967                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1968                         {
1969                                 assert!($node.node.claim_funds($preimage, $amount));
1970                                 check_added_monitors!($node, 1);
1971
1972                                 let events = $node.node.get_and_clear_pending_msg_events();
1973                                 assert_eq!(events.len(), 1);
1974                                 match events[0] {
1975                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1976                                                 assert!(update_add_htlcs.is_empty());
1977                                                 assert!(update_fail_htlcs.is_empty());
1978                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1979                                         },
1980                                         _ => panic!("Unexpected event"),
1981                                 };
1982                         }
1983                 }
1984         }
1985
1986         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1987         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1988         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1989         let node2_commitment_txid;
1990         {
1991                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1992                 node2_commitment_txid = node_txn[0].txid();
1993
1994                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1995                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1996
1997                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1998                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1999
2000                 check_preimage_claim(&nodes[3], &node_txn);
2001         }
2002         get_announce_close_broadcast_events(&nodes, 2, 3);
2003         assert_eq!(nodes[2].node.list_channels().len(), 0);
2004         assert_eq!(nodes[3].node.list_channels().len(), 1);
2005
2006         { // Cheat and reset nodes[4]'s height to 1
2007                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2008                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2009         }
2010
2011         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2012         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2013         // One pending HTLC to time out:
2014         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2015         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2016         // buffer space).
2017
2018         {
2019                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2020                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2021                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2022                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2023                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2024                 }
2025
2026                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2027                 {
2028                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2029                         node_txn.retain(|tx| {
2030                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2031                                         false
2032                                 } else { true }
2033                         });
2034                 }
2035
2036                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2037
2038                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2039                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2040
2041                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2042
2043                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2044                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2045                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2046                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2047                 }
2048
2049                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2050
2051                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2052                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2053
2054                 check_preimage_claim(&nodes[4], &node_txn);
2055         }
2056         get_announce_close_broadcast_events(&nodes, 3, 4);
2057         assert_eq!(nodes[3].node.list_channels().len(), 0);
2058         assert_eq!(nodes[4].node.list_channels().len(), 0);
2059 }
2060
2061 #[test]
2062 fn test_justice_tx() {
2063         // Test justice txn built on revoked HTLC-Success tx, against both sides
2064         let mut alice_config = UserConfig::default();
2065         alice_config.channel_options.announced_channel = true;
2066         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2067         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2068         let mut bob_config = UserConfig::default();
2069         bob_config.channel_options.announced_channel = true;
2070         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2071         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2072         let user_cfgs = [Some(alice_config), Some(bob_config)];
2073         let node_cfgs = create_node_cfgs(2);
2074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2075         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2076         // Create some new channels:
2077         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2078
2079         // A pending HTLC which will be revoked:
2080         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2081         // Get the will-be-revoked local txn from nodes[0]
2082         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();
2083         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2084         assert_eq!(revoked_local_txn[0].input.len(), 1);
2085         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2086         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2087         assert_eq!(revoked_local_txn[1].input.len(), 1);
2088         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2089         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2090         // Revoke the old state
2091         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2092
2093         {
2094                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2095                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2096                 {
2097                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2098                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2099                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2100
2101                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2102                         node_txn.swap_remove(0);
2103                         node_txn.truncate(1);
2104                 }
2105                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2106
2107                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2108                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2109                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2110                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2111                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2112         }
2113         get_announce_close_broadcast_events(&nodes, 0, 1);
2114
2115         assert_eq!(nodes[0].node.list_channels().len(), 0);
2116         assert_eq!(nodes[1].node.list_channels().len(), 0);
2117
2118         // We test justice_tx build by A on B's revoked HTLC-Success tx
2119         // Create some new channels:
2120         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2121         {
2122                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2123                 node_txn.clear();
2124         }
2125
2126         // A pending HTLC which will be revoked:
2127         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2128         // Get the will-be-revoked local txn from B
2129         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();
2130         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2131         assert_eq!(revoked_local_txn[0].input.len(), 1);
2132         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2133         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2134         // Revoke the old state
2135         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2136         {
2137                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2138                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2139                 {
2140                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2141                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2142                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2143
2144                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2145                         node_txn.swap_remove(0);
2146                 }
2147                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2148
2149                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2150                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2151                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2152                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2153                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2154         }
2155         get_announce_close_broadcast_events(&nodes, 0, 1);
2156         assert_eq!(nodes[0].node.list_channels().len(), 0);
2157         assert_eq!(nodes[1].node.list_channels().len(), 0);
2158 }
2159
2160 #[test]
2161 fn revoked_output_claim() {
2162         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2163         // transaction is broadcast by its counterparty
2164         let node_cfgs = create_node_cfgs(2);
2165         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2166         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2167         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2168         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2169         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();
2170         assert_eq!(revoked_local_txn.len(), 1);
2171         // Only output is the full channel value back to nodes[0]:
2172         assert_eq!(revoked_local_txn[0].output.len(), 1);
2173         // Send a payment through, updating everyone's latest commitment txn
2174         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2175
2176         // Inform nodes[1] that nodes[0] broadcast a stale tx
2177         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2178         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2179         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2180         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2181
2182         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2183         check_spends!(node_txn[1], chan_1.3.clone());
2184
2185         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2186         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2187         get_announce_close_broadcast_events(&nodes, 0, 1);
2188 }
2189
2190 #[test]
2191 fn claim_htlc_outputs_shared_tx() {
2192         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2193         let node_cfgs = create_node_cfgs(2);
2194         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2195         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2196
2197         // Create some new channel:
2198         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2199
2200         // Rebalance the network to generate htlc in the two directions
2201         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2202         // 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
2203         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2204         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2205
2206         // Get the will-be-revoked local txn from node[0]
2207         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();
2208         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2209         assert_eq!(revoked_local_txn[0].input.len(), 1);
2210         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2211         assert_eq!(revoked_local_txn[1].input.len(), 1);
2212         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2213         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2214         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2215
2216         //Revoke the old state
2217         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2218
2219         {
2220                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2221                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2222                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2223                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2224
2225                 let events = nodes[1].node.get_and_clear_pending_events();
2226                 assert_eq!(events.len(), 1);
2227                 match events[0] {
2228                         Event::PaymentFailed { payment_hash, .. } => {
2229                                 assert_eq!(payment_hash, payment_hash_2);
2230                         },
2231                         _ => panic!("Unexpected event"),
2232                 }
2233
2234                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2235                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2236
2237                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2238                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2239
2240                 let mut witness_lens = BTreeSet::new();
2241                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2242                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2243                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2244                 assert_eq!(witness_lens.len(), 3);
2245                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2246                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2247                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2248
2249                 // Next nodes[1] broadcasts its current local tx state:
2250                 assert_eq!(node_txn[1].input.len(), 1);
2251                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2252
2253                 assert_eq!(node_txn[2].input.len(), 1);
2254                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2255                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2256                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2257                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2258                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2259         }
2260         get_announce_close_broadcast_events(&nodes, 0, 1);
2261         assert_eq!(nodes[0].node.list_channels().len(), 0);
2262         assert_eq!(nodes[1].node.list_channels().len(), 0);
2263 }
2264
2265 #[test]
2266 fn claim_htlc_outputs_single_tx() {
2267         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2268         let node_cfgs = create_node_cfgs(2);
2269         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2270         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2271
2272         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2273
2274         // Rebalance the network to generate htlc in the two directions
2275         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2276         // 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
2277         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2278         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2279         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2280
2281         // Get the will-be-revoked local txn from node[0]
2282         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();
2283
2284         //Revoke the old state
2285         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2286
2287         {
2288                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2289                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2290                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2291                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2292
2293                 let events = nodes[1].node.get_and_clear_pending_events();
2294                 assert_eq!(events.len(), 1);
2295                 match events[0] {
2296                         Event::PaymentFailed { payment_hash, .. } => {
2297                                 assert_eq!(payment_hash, payment_hash_2);
2298                         },
2299                         _ => panic!("Unexpected event"),
2300                 }
2301
2302                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2303                 assert_eq!(node_txn.len(), 26);
2304                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2305                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2306                 // ChannelMonitor: bumped justice tx * 7 (7), after one increase, bumps on HTLC aren't generated not being substantial anymore
2307                 // ChannelMonitor: local commitment + local HTLC-timeout (14)
2308
2309
2310                 assert_eq!(node_txn[3], node_txn[5]);
2311                 assert_eq!(node_txn[3], node_txn[7]);
2312                 assert_eq!(node_txn[3], node_txn[9]);
2313                 assert_eq!(node_txn[3], node_txn[14]);
2314                 assert_eq!(node_txn[3], node_txn[17]);
2315                 assert_eq!(node_txn[3], node_txn[20]);
2316                 assert_eq!(node_txn[3], node_txn[23]);
2317
2318                 assert_eq!(node_txn[4], node_txn[6]);
2319                 assert_eq!(node_txn[4], node_txn[8]);
2320                 assert_eq!(node_txn[4], node_txn[10]);
2321                 assert_eq!(node_txn[4], node_txn[15]);
2322                 assert_eq!(node_txn[4], node_txn[18]);
2323                 assert_eq!(node_txn[4], node_txn[21]);
2324                 assert_eq!(node_txn[4], node_txn[24]);
2325
2326                 assert_eq!(node_txn[0].input.len(), 1);
2327                 assert_eq!(node_txn[1].input.len(), 1);
2328                 assert_eq!(node_txn[2].input.len(), 1);
2329
2330                 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2331                         if out_point.txid == tx.txid() {
2332                                 tx.output.get(out_point.vout as usize).cloned()
2333                         } else {
2334                                 None
2335                         }
2336                 }
2337                 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2338                 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2339                 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2340
2341                 let mut witness_lens = BTreeSet::new();
2342                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2343                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2344                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2345                 assert_eq!(witness_lens.len(), 3);
2346                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2347                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2348                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2349
2350                 assert_eq!(node_txn[3].input.len(), 1);
2351                 check_spends!(node_txn[3], chan_1.3.clone());
2352
2353                 assert_eq!(node_txn[4].input.len(), 1);
2354                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2355                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2356                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2357                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2358                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2359         }
2360         get_announce_close_broadcast_events(&nodes, 0, 1);
2361         assert_eq!(nodes[0].node.list_channels().len(), 0);
2362         assert_eq!(nodes[1].node.list_channels().len(), 0);
2363 }
2364
2365 #[test]
2366 fn test_htlc_on_chain_success() {
2367         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2368         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2369         // broadcasting the right event to other nodes in payment path.
2370         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2371         // A --------------------> B ----------------------> C (preimage)
2372         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2373         // commitment transaction was broadcast.
2374         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2375         // towards B.
2376         // B should be able to claim via preimage if A then broadcasts its local tx.
2377         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2378         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2379         // PaymentSent event).
2380
2381         let node_cfgs = create_node_cfgs(3);
2382         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2383         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2384
2385         // Create some initial channels
2386         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2387         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2388
2389         // Rebalance the network a bit by relaying one payment through all the channels...
2390         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2391         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2392
2393         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2394         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2395         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2396
2397         // Broadcast legit commitment tx from C on B's chain
2398         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2399         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();
2400         assert_eq!(commitment_tx.len(), 1);
2401         check_spends!(commitment_tx[0], chan_2.3.clone());
2402         nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2403         nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2404         check_added_monitors!(nodes[2], 2);
2405         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2406         assert!(updates.update_add_htlcs.is_empty());
2407         assert!(updates.update_fail_htlcs.is_empty());
2408         assert!(updates.update_fail_malformed_htlcs.is_empty());
2409         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2410
2411         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2412         check_closed_broadcast!(nodes[2], false);
2413         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)
2414         assert_eq!(node_txn.len(), 7);
2415         assert_eq!(node_txn[0], node_txn[3]);
2416         assert_eq!(node_txn[1], node_txn[4]);
2417         assert_eq!(node_txn[0], node_txn[5]);
2418         assert_eq!(node_txn[1], node_txn[6]);
2419         assert_eq!(node_txn[2], commitment_tx[0]);
2420         check_spends!(node_txn[0], commitment_tx[0].clone());
2421         check_spends!(node_txn[1], commitment_tx[0].clone());
2422         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2423         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2424         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2425         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2426         assert_eq!(node_txn[0].lock_time, 0);
2427         assert_eq!(node_txn[1].lock_time, 0);
2428
2429         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2430         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2431         let events = nodes[1].node.get_and_clear_pending_msg_events();
2432         {
2433                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2434                 assert_eq!(added_monitors.len(), 2);
2435                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2436                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2437                 added_monitors.clear();
2438         }
2439         assert_eq!(events.len(), 2);
2440         match events[0] {
2441                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2442                 _ => panic!("Unexpected event"),
2443         }
2444         match events[1] {
2445                 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, .. } } => {
2446                         assert!(update_add_htlcs.is_empty());
2447                         assert!(update_fail_htlcs.is_empty());
2448                         assert_eq!(update_fulfill_htlcs.len(), 1);
2449                         assert!(update_fail_malformed_htlcs.is_empty());
2450                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2451                 },
2452                 _ => panic!("Unexpected event"),
2453         };
2454         macro_rules! check_tx_local_broadcast {
2455                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2456                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2457                         assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2458                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2459                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2460                         check_spends!(node_txn[0], $commitment_tx.clone());
2461                         check_spends!(node_txn[1], $commitment_tx.clone());
2462                         if $htlc_offered {
2463                                 assert_eq!(node_txn[0], node_txn[5]);
2464                                 assert_eq!(node_txn[1], node_txn[6]);
2465                         }
2466                         assert_ne!(node_txn[0].lock_time, 0);
2467                         assert_ne!(node_txn[1].lock_time, 0);
2468                         if $htlc_offered {
2469                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2470                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2471                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2472                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2473                         } else {
2474                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2475                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2476                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2477                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2478                         }
2479                         check_spends!(node_txn[2], $chan_tx.clone());
2480                         check_spends!(node_txn[3], node_txn[2].clone());
2481                         check_spends!(node_txn[4], node_txn[2].clone());
2482                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2483                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2484                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2485                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2486                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2487                         assert_ne!(node_txn[3].lock_time, 0);
2488                         assert_ne!(node_txn[4].lock_time, 0);
2489                         node_txn.clear();
2490                 } }
2491         }
2492         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2493         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2494         // timeout-claim of the output that nodes[2] just claimed via success.
2495         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2496
2497         // Broadcast legit commitment tx from A on B's chain
2498         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2499         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();
2500         check_spends!(commitment_tx[0], chan_1.3.clone());
2501         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2502         check_closed_broadcast!(nodes[1], false);
2503         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2504         assert_eq!(node_txn.len(), 4);
2505         check_spends!(node_txn[0], commitment_tx[0].clone());
2506         assert_eq!(node_txn[0].input.len(), 2);
2507         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2508         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2509         assert_eq!(node_txn[0].lock_time, 0);
2510         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2511         check_spends!(node_txn[1], chan_1.3.clone());
2512         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2513         check_spends!(node_txn[2], node_txn[1]);
2514         check_spends!(node_txn[3], node_txn[1]);
2515         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2516         // we already checked the same situation with A.
2517
2518         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2519         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2520         check_closed_broadcast!(nodes[0], false);
2521         let events = nodes[0].node.get_and_clear_pending_events();
2522         assert_eq!(events.len(), 2);
2523         let mut first_claimed = false;
2524         for event in events {
2525                 match event {
2526                         Event::PaymentSent { payment_preimage } => {
2527                                 if payment_preimage == our_payment_preimage {
2528                                         assert!(!first_claimed);
2529                                         first_claimed = true;
2530                                 } else {
2531                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2532                                 }
2533                         },
2534                         _ => panic!("Unexpected event"),
2535                 }
2536         }
2537         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2538 }
2539
2540 #[test]
2541 fn test_htlc_on_chain_timeout() {
2542         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2543         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2544         // broadcasting the right event to other nodes in payment path.
2545         // A ------------------> B ----------------------> C (timeout)
2546         //    B's commitment tx                 C's commitment tx
2547         //            \                                  \
2548         //         B's HTLC timeout tx               B's timeout tx
2549
2550         let node_cfgs = create_node_cfgs(3);
2551         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2552         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2553
2554         // Create some intial channels
2555         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2556         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2557
2558         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2559         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2560         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2561
2562         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2563         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2564
2565         // Broadcast legit commitment tx from C on B's chain
2566         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();
2567         check_spends!(commitment_tx[0], chan_2.3.clone());
2568         nodes[2].node.fail_htlc_backwards(&payment_hash);
2569         check_added_monitors!(nodes[2], 0);
2570         expect_pending_htlcs_forwardable!(nodes[2]);
2571         check_added_monitors!(nodes[2], 1);
2572
2573         let events = nodes[2].node.get_and_clear_pending_msg_events();
2574         assert_eq!(events.len(), 1);
2575         match events[0] {
2576                 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, .. } } => {
2577                         assert!(update_add_htlcs.is_empty());
2578                         assert!(!update_fail_htlcs.is_empty());
2579                         assert!(update_fulfill_htlcs.is_empty());
2580                         assert!(update_fail_malformed_htlcs.is_empty());
2581                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2582                 },
2583                 _ => panic!("Unexpected event"),
2584         };
2585         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2586         check_closed_broadcast!(nodes[2], false);
2587         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2588         assert_eq!(node_txn.len(), 1);
2589         check_spends!(node_txn[0], chan_2.3.clone());
2590         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2591
2592         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2593         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2594         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2595         let timeout_tx;
2596         {
2597                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2598                 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2599                 assert_eq!(node_txn[1], node_txn[3]);
2600                 assert_eq!(node_txn[1], node_txn[5]);
2601                 assert_eq!(node_txn[2], node_txn[4]);
2602                 assert_eq!(node_txn[2], node_txn[6]);
2603                 check_spends!(node_txn[0], commitment_tx[0].clone());
2604                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2605                 check_spends!(node_txn[1], chan_2.3.clone());
2606                 check_spends!(node_txn[2], node_txn[1].clone());
2607                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2608                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2609                 check_spends!(node_txn[3], chan_2.3.clone());
2610                 check_spends!(node_txn[4], node_txn[3].clone());
2611                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2612                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2613                 timeout_tx = node_txn[0].clone();
2614                 node_txn.clear();
2615         }
2616
2617         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2618         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2619         check_added_monitors!(nodes[1], 0);
2620         check_closed_broadcast!(nodes[1], false);
2621
2622         expect_pending_htlcs_forwardable!(nodes[1]);
2623         check_added_monitors!(nodes[1], 1);
2624         let events = nodes[1].node.get_and_clear_pending_msg_events();
2625         assert_eq!(events.len(), 1);
2626         match events[0] {
2627                 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, .. } } => {
2628                         assert!(update_add_htlcs.is_empty());
2629                         assert!(!update_fail_htlcs.is_empty());
2630                         assert!(update_fulfill_htlcs.is_empty());
2631                         assert!(update_fail_malformed_htlcs.is_empty());
2632                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2633                 },
2634                 _ => panic!("Unexpected event"),
2635         };
2636         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
2637         assert_eq!(node_txn.len(), 0);
2638
2639         // Broadcast legit commitment tx from B on A's chain
2640         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();
2641         check_spends!(commitment_tx[0], chan_1.3.clone());
2642
2643         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2644         check_closed_broadcast!(nodes[0], false);
2645         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2646         assert_eq!(node_txn.len(), 3);
2647         check_spends!(node_txn[0], commitment_tx[0].clone());
2648         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2649         check_spends!(node_txn[1], chan_1.3.clone());
2650         check_spends!(node_txn[2], node_txn[1].clone());
2651         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2652         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2653 }
2654
2655 #[test]
2656 fn test_simple_commitment_revoked_fail_backward() {
2657         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2658         // and fail backward accordingly.
2659
2660         let node_cfgs = create_node_cfgs(3);
2661         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2662         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2663
2664         // Create some initial channels
2665         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2666         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2667
2668         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2669         // Get the will-be-revoked local txn from nodes[2]
2670         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();
2671         // Revoke the old state
2672         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2673
2674         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2675
2676         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2677         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2678         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2679         check_added_monitors!(nodes[1], 0);
2680         check_closed_broadcast!(nodes[1], false);
2681
2682         expect_pending_htlcs_forwardable!(nodes[1]);
2683         check_added_monitors!(nodes[1], 1);
2684         let events = nodes[1].node.get_and_clear_pending_msg_events();
2685         assert_eq!(events.len(), 1);
2686         match events[0] {
2687                 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, .. } } => {
2688                         assert!(update_add_htlcs.is_empty());
2689                         assert_eq!(update_fail_htlcs.len(), 1);
2690                         assert!(update_fulfill_htlcs.is_empty());
2691                         assert!(update_fail_malformed_htlcs.is_empty());
2692                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2693
2694                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2695                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2696
2697                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2698                         assert_eq!(events.len(), 1);
2699                         match events[0] {
2700                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2701                                 _ => panic!("Unexpected event"),
2702                         }
2703                         let events = nodes[0].node.get_and_clear_pending_events();
2704                         assert_eq!(events.len(), 1);
2705                         match events[0] {
2706                                 Event::PaymentFailed { .. } => {},
2707                                 _ => panic!("Unexpected event"),
2708                         }
2709                 },
2710                 _ => panic!("Unexpected event"),
2711         }
2712 }
2713
2714 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2715         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2716         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2717         // commitment transaction anymore.
2718         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2719         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2720         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2721         // technically disallowed and we should probably handle it reasonably.
2722         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2723         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2724         // transactions:
2725         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2726         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2727         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2728         //   and once they revoke the previous commitment transaction (allowing us to send a new
2729         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2730         let node_cfgs = create_node_cfgs(3);
2731         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2732         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2733
2734         // Create some initial channels
2735         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2736         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2737
2738         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2739         // Get the will-be-revoked local txn from nodes[2]
2740         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();
2741         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2742         // Revoke the old state
2743         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2744
2745         let value = if use_dust {
2746                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2747                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2748                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2749         } else { 3000000 };
2750
2751         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2752         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2753         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2754
2755         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2756         expect_pending_htlcs_forwardable!(nodes[2]);
2757         check_added_monitors!(nodes[2], 1);
2758         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2759         assert!(updates.update_add_htlcs.is_empty());
2760         assert!(updates.update_fulfill_htlcs.is_empty());
2761         assert!(updates.update_fail_malformed_htlcs.is_empty());
2762         assert_eq!(updates.update_fail_htlcs.len(), 1);
2763         assert!(updates.update_fee.is_none());
2764         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2765         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2766         // Drop the last RAA from 3 -> 2
2767
2768         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2769         expect_pending_htlcs_forwardable!(nodes[2]);
2770         check_added_monitors!(nodes[2], 1);
2771         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2772         assert!(updates.update_add_htlcs.is_empty());
2773         assert!(updates.update_fulfill_htlcs.is_empty());
2774         assert!(updates.update_fail_malformed_htlcs.is_empty());
2775         assert_eq!(updates.update_fail_htlcs.len(), 1);
2776         assert!(updates.update_fee.is_none());
2777         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2778         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2779         check_added_monitors!(nodes[1], 1);
2780         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2781         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2782         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2783         check_added_monitors!(nodes[2], 1);
2784
2785         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2786         expect_pending_htlcs_forwardable!(nodes[2]);
2787         check_added_monitors!(nodes[2], 1);
2788         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2789         assert!(updates.update_add_htlcs.is_empty());
2790         assert!(updates.update_fulfill_htlcs.is_empty());
2791         assert!(updates.update_fail_malformed_htlcs.is_empty());
2792         assert_eq!(updates.update_fail_htlcs.len(), 1);
2793         assert!(updates.update_fee.is_none());
2794         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2795         // At this point first_payment_hash has dropped out of the latest two commitment
2796         // transactions that nodes[1] is tracking...
2797         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2798         check_added_monitors!(nodes[1], 1);
2799         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2800         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2801         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2802         check_added_monitors!(nodes[2], 1);
2803
2804         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2805         // on nodes[2]'s RAA.
2806         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2807         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2808         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2809         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2810         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2811         check_added_monitors!(nodes[1], 0);
2812
2813         if deliver_bs_raa {
2814                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2815                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2816                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2817                 check_added_monitors!(nodes[1], 1);
2818                 let events = nodes[1].node.get_and_clear_pending_events();
2819                 assert_eq!(events.len(), 1);
2820                 match events[0] {
2821                         Event::PendingHTLCsForwardable { .. } => { },
2822                         _ => panic!("Unexpected event"),
2823                 };
2824                 // Deliberately don't process the pending fail-back so they all fail back at once after
2825                 // block connection just like the !deliver_bs_raa case
2826         }
2827
2828         let mut failed_htlcs = HashSet::new();
2829         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2830
2831         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2832         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2833         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2834
2835         let events = nodes[1].node.get_and_clear_pending_events();
2836         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2837         match events[0] {
2838                 Event::PaymentFailed { ref payment_hash, .. } => {
2839                         assert_eq!(*payment_hash, fourth_payment_hash);
2840                 },
2841                 _ => panic!("Unexpected event"),
2842         }
2843         if !deliver_bs_raa {
2844                 match events[1] {
2845                         Event::PendingHTLCsForwardable { .. } => { },
2846                         _ => panic!("Unexpected event"),
2847                 };
2848         }
2849         nodes[1].node.process_pending_htlc_forwards();
2850         check_added_monitors!(nodes[1], 1);
2851
2852         let events = nodes[1].node.get_and_clear_pending_msg_events();
2853         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2854         match events[if deliver_bs_raa { 1 } else { 0 }] {
2855                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2856                 _ => panic!("Unexpected event"),
2857         }
2858         if deliver_bs_raa {
2859                 match events[0] {
2860                         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, .. } } => {
2861                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2862                                 assert_eq!(update_add_htlcs.len(), 1);
2863                                 assert!(update_fulfill_htlcs.is_empty());
2864                                 assert!(update_fail_htlcs.is_empty());
2865                                 assert!(update_fail_malformed_htlcs.is_empty());
2866                         },
2867                         _ => panic!("Unexpected event"),
2868                 }
2869         }
2870         match events[if deliver_bs_raa { 2 } else { 1 }] {
2871                 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, .. } } => {
2872                         assert!(update_add_htlcs.is_empty());
2873                         assert_eq!(update_fail_htlcs.len(), 3);
2874                         assert!(update_fulfill_htlcs.is_empty());
2875                         assert!(update_fail_malformed_htlcs.is_empty());
2876                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2877
2878                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2879                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2880                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2881
2882                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2883
2884                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2885                         // If we delivered B's RAA we got an unknown preimage error, not something
2886                         // that we should update our routing table for.
2887                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2888                         for event in events {
2889                                 match event {
2890                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2891                                         _ => panic!("Unexpected event"),
2892                                 }
2893                         }
2894                         let events = nodes[0].node.get_and_clear_pending_events();
2895                         assert_eq!(events.len(), 3);
2896                         match events[0] {
2897                                 Event::PaymentFailed { ref payment_hash, .. } => {
2898                                         assert!(failed_htlcs.insert(payment_hash.0));
2899                                 },
2900                                 _ => panic!("Unexpected event"),
2901                         }
2902                         match events[1] {
2903                                 Event::PaymentFailed { ref payment_hash, .. } => {
2904                                         assert!(failed_htlcs.insert(payment_hash.0));
2905                                 },
2906                                 _ => panic!("Unexpected event"),
2907                         }
2908                         match events[2] {
2909                                 Event::PaymentFailed { ref payment_hash, .. } => {
2910                                         assert!(failed_htlcs.insert(payment_hash.0));
2911                                 },
2912                                 _ => panic!("Unexpected event"),
2913                         }
2914                 },
2915                 _ => panic!("Unexpected event"),
2916         }
2917
2918         assert!(failed_htlcs.contains(&first_payment_hash.0));
2919         assert!(failed_htlcs.contains(&second_payment_hash.0));
2920         assert!(failed_htlcs.contains(&third_payment_hash.0));
2921 }
2922
2923 #[test]
2924 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2925         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2926         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2927         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2928         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2929 }
2930
2931 #[test]
2932 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2933         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2934         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2935         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2936         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2937 }
2938
2939 #[test]
2940 fn test_htlc_ignore_latest_remote_commitment() {
2941         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2942         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2943         let node_cfgs = create_node_cfgs(2);
2944         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2945         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2946         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2947
2948         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2949         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2950         check_closed_broadcast!(nodes[0], false);
2951
2952         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2953         assert_eq!(node_txn.len(), 2);
2954
2955         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2956         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2957         check_closed_broadcast!(nodes[1], false);
2958
2959         // Duplicate the block_connected call since this may happen due to other listeners
2960         // registering new transactions
2961         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2962 }
2963
2964 #[test]
2965 fn test_force_close_fail_back() {
2966         // Check which HTLCs are failed-backwards on channel force-closure
2967         let node_cfgs = create_node_cfgs(3);
2968         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2969         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2970         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2971         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2972
2973         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2974
2975         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2976
2977         let mut payment_event = {
2978                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2979                 check_added_monitors!(nodes[0], 1);
2980
2981                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2982                 assert_eq!(events.len(), 1);
2983                 SendEvent::from_event(events.remove(0))
2984         };
2985
2986         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2987         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2988
2989         expect_pending_htlcs_forwardable!(nodes[1]);
2990
2991         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2992         assert_eq!(events_2.len(), 1);
2993         payment_event = SendEvent::from_event(events_2.remove(0));
2994         assert_eq!(payment_event.msgs.len(), 1);
2995
2996         check_added_monitors!(nodes[1], 1);
2997         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2998         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2999         check_added_monitors!(nodes[2], 1);
3000         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3001
3002         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3003         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3004         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3005
3006         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3007         check_closed_broadcast!(nodes[2], false);
3008         let tx = {
3009                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3010                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3011                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3012                 // back to nodes[1] upon timeout otherwise.
3013                 assert_eq!(node_txn.len(), 1);
3014                 node_txn.remove(0)
3015         };
3016
3017         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3018         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3019
3020         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3021         check_closed_broadcast!(nodes[1], false);
3022
3023         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3024         {
3025                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3026                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3027                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3028         }
3029         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3030         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3031         assert_eq!(node_txn.len(), 1);
3032         assert_eq!(node_txn[0].input.len(), 1);
3033         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3034         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3035         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3036
3037         check_spends!(node_txn[0], tx);
3038 }
3039
3040 #[test]
3041 fn test_unconf_chan() {
3042         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3043         let node_cfgs = create_node_cfgs(2);
3044         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3045         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3046         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3047
3048         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3049         assert_eq!(channel_state.by_id.len(), 1);
3050         assert_eq!(channel_state.short_to_id.len(), 1);
3051         mem::drop(channel_state);
3052
3053         let mut headers = Vec::new();
3054         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3055         headers.push(header.clone());
3056         for _i in 2..100 {
3057                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3058                 headers.push(header.clone());
3059         }
3060         let mut height = 99;
3061         while !headers.is_empty() {
3062                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3063                 height -= 1;
3064         }
3065         check_closed_broadcast!(nodes[0], false);
3066         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3067         assert_eq!(channel_state.by_id.len(), 0);
3068         assert_eq!(channel_state.short_to_id.len(), 0);
3069 }
3070
3071 #[test]
3072 fn test_simple_peer_disconnect() {
3073         // Test that we can reconnect when there are no lost messages
3074         let node_cfgs = create_node_cfgs(3);
3075         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3076         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3077         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3078         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3079
3080         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3081         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3082         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3083
3084         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3085         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3086         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3087         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3088
3089         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3090         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3091         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3092
3093         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3094         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3095         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3096         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3097
3098         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3099         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3100
3101         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3102         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3103
3104         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3105         {
3106                 let events = nodes[0].node.get_and_clear_pending_events();
3107                 assert_eq!(events.len(), 2);
3108                 match events[0] {
3109                         Event::PaymentSent { payment_preimage } => {
3110                                 assert_eq!(payment_preimage, payment_preimage_3);
3111                         },
3112                         _ => panic!("Unexpected event"),
3113                 }
3114                 match events[1] {
3115                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3116                                 assert_eq!(payment_hash, payment_hash_5);
3117                                 assert!(rejected_by_dest);
3118                         },
3119                         _ => panic!("Unexpected event"),
3120                 }
3121         }
3122
3123         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3124         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3125 }
3126
3127 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3128         // Test that we can reconnect when in-flight HTLC updates get dropped
3129         let node_cfgs = create_node_cfgs(2);
3130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3131         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3132         if messages_delivered == 0 {
3133                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3134                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3135         } else {
3136                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3137         }
3138
3139         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();
3140         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3141
3142         let payment_event = {
3143                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3144                 check_added_monitors!(nodes[0], 1);
3145
3146                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3147                 assert_eq!(events.len(), 1);
3148                 SendEvent::from_event(events.remove(0))
3149         };
3150         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3151
3152         if messages_delivered < 2 {
3153                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3154         } else {
3155                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3156                 if messages_delivered >= 3 {
3157                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3158                         check_added_monitors!(nodes[1], 1);
3159                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3160
3161                         if messages_delivered >= 4 {
3162                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3163                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3164                                 check_added_monitors!(nodes[0], 1);
3165
3166                                 if messages_delivered >= 5 {
3167                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3168                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3169                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3170                                         check_added_monitors!(nodes[0], 1);
3171
3172                                         if messages_delivered >= 6 {
3173                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3174                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3175                                                 check_added_monitors!(nodes[1], 1);
3176                                         }
3177                                 }
3178                         }
3179                 }
3180         }
3181
3182         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3183         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3184         if messages_delivered < 3 {
3185                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3186                 // received on either side, both sides will need to resend them.
3187                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3188         } else if messages_delivered == 3 {
3189                 // nodes[0] still wants its RAA + commitment_signed
3190                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3191         } else if messages_delivered == 4 {
3192                 // nodes[0] still wants its commitment_signed
3193                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3194         } else if messages_delivered == 5 {
3195                 // nodes[1] still wants its final RAA
3196                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3197         } else if messages_delivered == 6 {
3198                 // Everything was delivered...
3199                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3200         }
3201
3202         let events_1 = nodes[1].node.get_and_clear_pending_events();
3203         assert_eq!(events_1.len(), 1);
3204         match events_1[0] {
3205                 Event::PendingHTLCsForwardable { .. } => { },
3206                 _ => panic!("Unexpected event"),
3207         };
3208
3209         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3210         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3211         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3212
3213         nodes[1].node.process_pending_htlc_forwards();
3214
3215         let events_2 = nodes[1].node.get_and_clear_pending_events();
3216         assert_eq!(events_2.len(), 1);
3217         match events_2[0] {
3218                 Event::PaymentReceived { ref payment_hash, amt } => {
3219                         assert_eq!(payment_hash_1, *payment_hash);
3220                         assert_eq!(amt, 1000000);
3221                 },
3222                 _ => panic!("Unexpected event"),
3223         }
3224
3225         nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3226         check_added_monitors!(nodes[1], 1);
3227
3228         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3229         assert_eq!(events_3.len(), 1);
3230         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3231                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3232                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3233                         assert!(updates.update_add_htlcs.is_empty());
3234                         assert!(updates.update_fail_htlcs.is_empty());
3235                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3236                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3237                         assert!(updates.update_fee.is_none());
3238                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3239                 },
3240                 _ => panic!("Unexpected event"),
3241         };
3242
3243         if messages_delivered >= 1 {
3244                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3245
3246                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3247                 assert_eq!(events_4.len(), 1);
3248                 match events_4[0] {
3249                         Event::PaymentSent { ref payment_preimage } => {
3250                                 assert_eq!(payment_preimage_1, *payment_preimage);
3251                         },
3252                         _ => panic!("Unexpected event"),
3253                 }
3254
3255                 if messages_delivered >= 2 {
3256                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3257                         check_added_monitors!(nodes[0], 1);
3258                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3259
3260                         if messages_delivered >= 3 {
3261                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3262                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3263                                 check_added_monitors!(nodes[1], 1);
3264
3265                                 if messages_delivered >= 4 {
3266                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3267                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3268                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3269                                         check_added_monitors!(nodes[1], 1);
3270
3271                                         if messages_delivered >= 5 {
3272                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3273                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3274                                                 check_added_monitors!(nodes[0], 1);
3275                                         }
3276                                 }
3277                         }
3278                 }
3279         }
3280
3281         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3282         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3283         if messages_delivered < 2 {
3284                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3285                 //TODO: Deduplicate PaymentSent events, then enable this if:
3286                 //if messages_delivered < 1 {
3287                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3288                         assert_eq!(events_4.len(), 1);
3289                         match events_4[0] {
3290                                 Event::PaymentSent { ref payment_preimage } => {
3291                                         assert_eq!(payment_preimage_1, *payment_preimage);
3292                                 },
3293                                 _ => panic!("Unexpected event"),
3294                         }
3295                 //}
3296         } else if messages_delivered == 2 {
3297                 // nodes[0] still wants its RAA + commitment_signed
3298                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3299         } else if messages_delivered == 3 {
3300                 // nodes[0] still wants its commitment_signed
3301                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3302         } else if messages_delivered == 4 {
3303                 // nodes[1] still wants its final RAA
3304                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3305         } else if messages_delivered == 5 {
3306                 // Everything was delivered...
3307                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3308         }
3309
3310         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3311         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3312         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3313
3314         // Channel should still work fine...
3315         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3316         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3317 }
3318
3319 #[test]
3320 fn test_drop_messages_peer_disconnect_a() {
3321         do_test_drop_messages_peer_disconnect(0);
3322         do_test_drop_messages_peer_disconnect(1);
3323         do_test_drop_messages_peer_disconnect(2);
3324         do_test_drop_messages_peer_disconnect(3);
3325 }
3326
3327 #[test]
3328 fn test_drop_messages_peer_disconnect_b() {
3329         do_test_drop_messages_peer_disconnect(4);
3330         do_test_drop_messages_peer_disconnect(5);
3331         do_test_drop_messages_peer_disconnect(6);
3332 }
3333
3334 #[test]
3335 fn test_funding_peer_disconnect() {
3336         // Test that we can lock in our funding tx while disconnected
3337         let node_cfgs = create_node_cfgs(2);
3338         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3339         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3340         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3341
3342         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3343         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3344
3345         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3346         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3347         assert_eq!(events_1.len(), 1);
3348         match events_1[0] {
3349                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3350                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3351                 },
3352                 _ => panic!("Unexpected event"),
3353         }
3354
3355         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3356
3357         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3358         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3359
3360         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3361         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3362         assert_eq!(events_2.len(), 2);
3363         let funding_locked = match events_2[0] {
3364                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3365                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3366                         msg.clone()
3367                 },
3368                 _ => panic!("Unexpected event"),
3369         };
3370         let bs_announcement_sigs = match events_2[1] {
3371                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3372                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3373                         msg.clone()
3374                 },
3375                 _ => panic!("Unexpected event"),
3376         };
3377
3378         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3379
3380         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3381         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3382         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3383         assert_eq!(events_3.len(), 2);
3384         let as_announcement_sigs = match events_3[0] {
3385                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3386                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3387                         msg.clone()
3388                 },
3389                 _ => panic!("Unexpected event"),
3390         };
3391         let (as_announcement, as_update) = match events_3[1] {
3392                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3393                         (msg.clone(), update_msg.clone())
3394                 },
3395                 _ => panic!("Unexpected event"),
3396         };
3397
3398         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3399         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3400         assert_eq!(events_4.len(), 1);
3401         let (_, bs_update) = match events_4[0] {
3402                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3403                         (msg.clone(), update_msg.clone())
3404                 },
3405                 _ => panic!("Unexpected event"),
3406         };
3407
3408         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3409         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3410         nodes[0].router.handle_channel_update(&as_update).unwrap();
3411
3412         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3413         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3414         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3415 }
3416
3417 #[test]
3418 fn test_drop_messages_peer_disconnect_dual_htlc() {
3419         // Test that we can handle reconnecting when both sides of a channel have pending
3420         // commitment_updates when we disconnect.
3421         let node_cfgs = create_node_cfgs(2);
3422         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3423         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3424         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3425
3426         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3427
3428         // Now try to send a second payment which will fail to send
3429         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3430         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3431
3432         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3433         check_added_monitors!(nodes[0], 1);
3434
3435         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3436         assert_eq!(events_1.len(), 1);
3437         match events_1[0] {
3438                 MessageSendEvent::UpdateHTLCs { .. } => {},
3439                 _ => panic!("Unexpected event"),
3440         }
3441
3442         assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3443         check_added_monitors!(nodes[1], 1);
3444
3445         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3446         assert_eq!(events_2.len(), 1);
3447         match events_2[0] {
3448                 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 } } => {
3449                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3450                         assert!(update_add_htlcs.is_empty());
3451                         assert_eq!(update_fulfill_htlcs.len(), 1);
3452                         assert!(update_fail_htlcs.is_empty());
3453                         assert!(update_fail_malformed_htlcs.is_empty());
3454                         assert!(update_fee.is_none());
3455
3456                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3457                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3458                         assert_eq!(events_3.len(), 1);
3459                         match events_3[0] {
3460                                 Event::PaymentSent { ref payment_preimage } => {
3461                                         assert_eq!(*payment_preimage, payment_preimage_1);
3462                                 },
3463                                 _ => panic!("Unexpected event"),
3464                         }
3465
3466                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3467                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3468                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3469                         check_added_monitors!(nodes[0], 1);
3470                 },
3471                 _ => panic!("Unexpected event"),
3472         }
3473
3474         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3475         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3476
3477         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3478         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3479         assert_eq!(reestablish_1.len(), 1);
3480         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3481         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3482         assert_eq!(reestablish_2.len(), 1);
3483
3484         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3485         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3486         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3487         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3488
3489         assert!(as_resp.0.is_none());
3490         assert!(bs_resp.0.is_none());
3491
3492         assert!(bs_resp.1.is_none());
3493         assert!(bs_resp.2.is_none());
3494
3495         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3496
3497         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3498         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3499         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3500         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3501         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3502         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3503         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3504         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3505         // No commitment_signed so get_event_msg's assert(len == 1) passes
3506         check_added_monitors!(nodes[1], 1);
3507
3508         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3509         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3510         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3511         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3512         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3513         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3514         assert!(bs_second_commitment_signed.update_fee.is_none());
3515         check_added_monitors!(nodes[1], 1);
3516
3517         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3518         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3519         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3520         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3521         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3522         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3523         assert!(as_commitment_signed.update_fee.is_none());
3524         check_added_monitors!(nodes[0], 1);
3525
3526         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3527         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3528         // No commitment_signed so get_event_msg's assert(len == 1) passes
3529         check_added_monitors!(nodes[0], 1);
3530
3531         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3532         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3533         // No commitment_signed so get_event_msg's assert(len == 1) passes
3534         check_added_monitors!(nodes[1], 1);
3535
3536         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3537         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3538         check_added_monitors!(nodes[1], 1);
3539
3540         expect_pending_htlcs_forwardable!(nodes[1]);
3541
3542         let events_5 = nodes[1].node.get_and_clear_pending_events();
3543         assert_eq!(events_5.len(), 1);
3544         match events_5[0] {
3545                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3546                         assert_eq!(payment_hash_2, *payment_hash);
3547                 },
3548                 _ => panic!("Unexpected event"),
3549         }
3550
3551         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3552         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3553         check_added_monitors!(nodes[0], 1);
3554
3555         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3556 }
3557
3558 #[test]
3559 fn test_invalid_channel_announcement() {
3560         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3561         let secp_ctx = Secp256k1::new();
3562         let node_cfgs = create_node_cfgs(2);
3563         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3564         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3565
3566         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3567
3568         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3569         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3570         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3571         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3572
3573         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3574
3575         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3576         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3577
3578         let as_network_key = nodes[0].node.get_our_node_id();
3579         let bs_network_key = nodes[1].node.get_our_node_id();
3580
3581         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3582
3583         let mut chan_announcement;
3584
3585         macro_rules! dummy_unsigned_msg {
3586                 () => {
3587                         msgs::UnsignedChannelAnnouncement {
3588                                 features: ChannelFeatures::supported(),
3589                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3590                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3591                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3592                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3593                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3594                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3595                                 excess_data: Vec::new(),
3596                         };
3597                 }
3598         }
3599
3600         macro_rules! sign_msg {
3601                 ($unsigned_msg: expr) => {
3602                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3603                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3604                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3605                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3606                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3607                         chan_announcement = msgs::ChannelAnnouncement {
3608                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3609                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3610                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3611                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3612                                 contents: $unsigned_msg
3613                         }
3614                 }
3615         }
3616
3617         let unsigned_msg = dummy_unsigned_msg!();
3618         sign_msg!(unsigned_msg);
3619         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3620         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 } );
3621
3622         // Configured with Network::Testnet
3623         let mut unsigned_msg = dummy_unsigned_msg!();
3624         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3625         sign_msg!(unsigned_msg);
3626         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3627
3628         let mut unsigned_msg = dummy_unsigned_msg!();
3629         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3630         sign_msg!(unsigned_msg);
3631         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3632 }
3633
3634 #[test]
3635 fn test_no_txn_manager_serialize_deserialize() {
3636         let node_cfgs = create_node_cfgs(2);
3637         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3638         let new_chan_monitor: test_utils::TestChannelMonitor;
3639         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3640         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3641
3642         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3643
3644         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3645
3646         let nodes_0_serialized = nodes[0].node.encode();
3647         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3648         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3649
3650         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 }));
3651         nodes[0].chan_monitor = &new_chan_monitor;
3652         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3653         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3654         assert!(chan_0_monitor_read.is_empty());
3655
3656         let mut nodes_0_read = &nodes_0_serialized[..];
3657         let config = UserConfig::default();
3658         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3659         let (_, nodes_0_deserialized_tmp) = {
3660                 let mut channel_monitors = HashMap::new();
3661                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3662                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3663                         default_config: config,
3664                         keys_manager,
3665                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3666                         monitor: nodes[0].chan_monitor,
3667                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3668                         logger: Arc::new(test_utils::TestLogger::new()),
3669                         channel_monitors: &mut channel_monitors,
3670                 }).unwrap()
3671         };
3672         nodes_0_deserialized = nodes_0_deserialized_tmp;
3673         assert!(nodes_0_read.is_empty());
3674
3675         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3676         nodes[0].node = &nodes_0_deserialized;
3677         nodes[0].block_notifier.register_listener(nodes[0].node);
3678         assert_eq!(nodes[0].node.list_channels().len(), 1);
3679         check_added_monitors!(nodes[0], 1);
3680
3681         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3682         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3683         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3684         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3685
3686         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3687         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3688         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3689         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3690
3691         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3692         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3693         for node in nodes.iter() {
3694                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3695                 node.router.handle_channel_update(&as_update).unwrap();
3696                 node.router.handle_channel_update(&bs_update).unwrap();
3697         }
3698
3699         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3700 }
3701
3702 #[test]
3703 fn test_simple_manager_serialize_deserialize() {
3704         let node_cfgs = create_node_cfgs(2);
3705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3706         let new_chan_monitor: test_utils::TestChannelMonitor;
3707         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3708         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3709         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3710
3711         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3712         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3713
3714         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3715
3716         let nodes_0_serialized = nodes[0].node.encode();
3717         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3718         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3719
3720         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 }));
3721         nodes[0].chan_monitor = &new_chan_monitor;
3722         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3723         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3724         assert!(chan_0_monitor_read.is_empty());
3725
3726         let mut nodes_0_read = &nodes_0_serialized[..];
3727         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3728         let (_, nodes_0_deserialized_tmp) = {
3729                 let mut channel_monitors = HashMap::new();
3730                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3731                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3732                         default_config: UserConfig::default(),
3733                         keys_manager,
3734                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3735                         monitor: nodes[0].chan_monitor,
3736                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3737                         logger: Arc::new(test_utils::TestLogger::new()),
3738                         channel_monitors: &mut channel_monitors,
3739                 }).unwrap()
3740         };
3741         nodes_0_deserialized = nodes_0_deserialized_tmp;
3742         assert!(nodes_0_read.is_empty());
3743
3744         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3745         nodes[0].node = &nodes_0_deserialized;
3746         check_added_monitors!(nodes[0], 1);
3747
3748         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3749
3750         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3751         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3752 }
3753
3754 #[test]
3755 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3756         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3757         let node_cfgs = create_node_cfgs(4);
3758         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3759         let new_chan_monitor: test_utils::TestChannelMonitor;
3760         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3761         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3762         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3763         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3764         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3765
3766         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3767
3768         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3769         let nodes_0_serialized = nodes[0].node.encode();
3770
3771         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3772         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3773         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3774         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3775
3776         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3777         // nodes[3])
3778         let mut node_0_monitors_serialized = Vec::new();
3779         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3780                 let mut writer = test_utils::TestVecWriter(Vec::new());
3781                 monitor.1.write_for_disk(&mut writer).unwrap();
3782                 node_0_monitors_serialized.push(writer.0);
3783         }
3784
3785         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 }));
3786         nodes[0].chan_monitor = &new_chan_monitor;
3787         let mut node_0_monitors = Vec::new();
3788         for serialized in node_0_monitors_serialized.iter() {
3789                 let mut read = &serialized[..];
3790                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3791                 assert!(read.is_empty());
3792                 node_0_monitors.push(monitor);
3793         }
3794
3795         let mut nodes_0_read = &nodes_0_serialized[..];
3796         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3797         let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3798                 default_config: UserConfig::default(),
3799                 keys_manager,
3800                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3801                 monitor: nodes[0].chan_monitor,
3802                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3803                 logger: Arc::new(test_utils::TestLogger::new()),
3804                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3805         }).unwrap();
3806         nodes_0_deserialized = nodes_0_deserialized_tmp;
3807         assert!(nodes_0_read.is_empty());
3808
3809         { // Channel close should result in a commitment tx and an HTLC tx
3810                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3811                 assert_eq!(txn.len(), 2);
3812                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3813                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3814         }
3815
3816         for monitor in node_0_monitors.drain(..) {
3817                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3818                 check_added_monitors!(nodes[0], 1);
3819         }
3820         nodes[0].node = &nodes_0_deserialized;
3821
3822         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3823         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3824         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3825         //... and we can even still claim the payment!
3826         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3827
3828         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3829         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3830         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3831         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3832         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3833         assert_eq!(msg_events.len(), 1);
3834         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3835                 match action {
3836                         &ErrorAction::SendErrorMessage { ref msg } => {
3837                                 assert_eq!(msg.channel_id, channel_id);
3838                         },
3839                         _ => panic!("Unexpected event!"),
3840                 }
3841         }
3842 }
3843
3844 macro_rules! check_spendable_outputs {
3845         ($node: expr, $der_idx: expr) => {
3846                 {
3847                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3848                         let mut txn = Vec::new();
3849                         for event in events {
3850                                 match event {
3851                                         Event::SpendableOutputs { ref outputs } => {
3852                                                 for outp in outputs {
3853                                                         match *outp {
3854                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3855                                                                         let input = TxIn {
3856                                                                                 previous_output: outpoint.clone(),
3857                                                                                 script_sig: Script::new(),
3858                                                                                 sequence: 0,
3859                                                                                 witness: Vec::new(),
3860                                                                         };
3861                                                                         let outp = TxOut {
3862                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3863                                                                                 value: output.value,
3864                                                                         };
3865                                                                         let mut spend_tx = Transaction {
3866                                                                                 version: 2,
3867                                                                                 lock_time: 0,
3868                                                                                 input: vec![input],
3869                                                                                 output: vec![outp],
3870                                                                         };
3871                                                                         let secp_ctx = Secp256k1::new();
3872                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3873                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3874                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3875                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3876                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3877                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3878                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3879                                                                         txn.push(spend_tx);
3880                                                                 },
3881                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3882                                                                         let input = TxIn {
3883                                                                                 previous_output: outpoint.clone(),
3884                                                                                 script_sig: Script::new(),
3885                                                                                 sequence: *to_self_delay as u32,
3886                                                                                 witness: Vec::new(),
3887                                                                         };
3888                                                                         let outp = TxOut {
3889                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3890                                                                                 value: output.value,
3891                                                                         };
3892                                                                         let mut spend_tx = Transaction {
3893                                                                                 version: 2,
3894                                                                                 lock_time: 0,
3895                                                                                 input: vec![input],
3896                                                                                 output: vec![outp],
3897                                                                         };
3898                                                                         let secp_ctx = Secp256k1::new();
3899                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3900                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3901                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3902                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3903                                                                         spend_tx.input[0].witness.push(vec!(0));
3904                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3905                                                                         txn.push(spend_tx);
3906                                                                 },
3907                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3908                                                                         let secp_ctx = Secp256k1::new();
3909                                                                         let input = TxIn {
3910                                                                                 previous_output: outpoint.clone(),
3911                                                                                 script_sig: Script::new(),
3912                                                                                 sequence: 0,
3913                                                                                 witness: Vec::new(),
3914                                                                         };
3915                                                                         let outp = TxOut {
3916                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3917                                                                                 value: output.value,
3918                                                                         };
3919                                                                         let mut spend_tx = Transaction {
3920                                                                                 version: 2,
3921                                                                                 lock_time: 0,
3922                                                                                 input: vec![input],
3923                                                                                 output: vec![outp.clone()],
3924                                                                         };
3925                                                                         let secret = {
3926                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3927                                                                                         Ok(master_key) => {
3928                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3929                                                                                                         Ok(key) => key,
3930                                                                                                         Err(_) => panic!("Your RNG is busted"),
3931                                                                                                 }
3932                                                                                         }
3933                                                                                         Err(_) => panic!("Your rng is busted"),
3934                                                                                 }
3935                                                                         };
3936                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3937                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3938                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3939                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3940                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3941                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3942                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3943                                                                         txn.push(spend_tx);
3944                                                                 },
3945                                                         }
3946                                                 }
3947                                         },
3948                                         _ => panic!("Unexpected event"),
3949                                 };
3950                         }
3951                         txn
3952                 }
3953         }
3954 }
3955
3956 #[test]
3957 fn test_claim_sizeable_push_msat() {
3958         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3959         let node_cfgs = create_node_cfgs(2);
3960         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3961         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3962
3963         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3964         nodes[1].node.force_close_channel(&chan.2);
3965         check_closed_broadcast!(nodes[1], false);
3966         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3967         assert_eq!(node_txn.len(), 1);
3968         check_spends!(node_txn[0], chan.3.clone());
3969         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
3970
3971         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3972         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3973         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3974         assert_eq!(spend_txn.len(), 1);
3975         check_spends!(spend_txn[0], node_txn[0].clone());
3976 }
3977
3978 #[test]
3979 fn test_claim_on_remote_sizeable_push_msat() {
3980         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3981         // to_remote output is encumbered by a P2WPKH
3982         let node_cfgs = create_node_cfgs(2);
3983         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3984         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3985
3986         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3987         nodes[0].node.force_close_channel(&chan.2);
3988         check_closed_broadcast!(nodes[0], false);
3989
3990         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3991         assert_eq!(node_txn.len(), 1);
3992         check_spends!(node_txn[0], chan.3.clone());
3993         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
3994
3995         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3996         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3997         check_closed_broadcast!(nodes[1], false);
3998         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3999         assert_eq!(spend_txn.len(), 2);
4000         assert_eq!(spend_txn[0], spend_txn[1]);
4001         check_spends!(spend_txn[0], node_txn[0].clone());
4002 }
4003
4004 #[test]
4005 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4006         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4007         // to_remote output is encumbered by a P2WPKH
4008
4009         let node_cfgs = create_node_cfgs(2);
4010         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4011         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4012
4013         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4014         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4015         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();
4016         assert_eq!(revoked_local_txn[0].input.len(), 1);
4017         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4018
4019         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4020         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4021         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4022         check_closed_broadcast!(nodes[1], false);
4023
4024         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4025         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4026         assert_eq!(spend_txn.len(), 4);
4027         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
4028         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
4029         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
4030         check_spends!(spend_txn[1], node_txn[0].clone());
4031 }
4032
4033 #[test]
4034 fn test_static_spendable_outputs_preimage_tx() {
4035         let node_cfgs = create_node_cfgs(2);
4036         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4037         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4038
4039         // Create some initial channels
4040         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4041
4042         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4043
4044         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();
4045         assert_eq!(commitment_tx[0].input.len(), 1);
4046         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4047
4048         // Settle A's commitment tx on B's chain
4049         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4050         assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
4051         check_added_monitors!(nodes[1], 1);
4052         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4053         let events = nodes[1].node.get_and_clear_pending_msg_events();
4054         match events[0] {
4055                 MessageSendEvent::UpdateHTLCs { .. } => {},
4056                 _ => panic!("Unexpected event"),
4057         }
4058         match events[1] {
4059                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4060                 _ => panic!("Unexepected event"),
4061         }
4062
4063         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4064         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4065         assert_eq!(node_txn.len(), 3);
4066         check_spends!(node_txn[0], commitment_tx[0].clone());
4067         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4068 eprintln!("{:?}", node_txn[1]);
4069         check_spends!(node_txn[1], chan_1.3.clone());
4070         check_spends!(node_txn[2], node_txn[1]);
4071
4072         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
4073         assert_eq!(spend_txn.len(), 2);
4074         assert_eq!(spend_txn[0], spend_txn[1]);
4075         check_spends!(spend_txn[0], node_txn[0].clone());
4076 }
4077
4078 #[test]
4079 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4080         let node_cfgs = create_node_cfgs(2);
4081         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4082         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4083
4084         // Create some initial channels
4085         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4086
4087         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4088         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();
4089         assert_eq!(revoked_local_txn[0].input.len(), 1);
4090         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4091
4092         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4093
4094         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4095         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4096         check_closed_broadcast!(nodes[1], false);
4097
4098         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4099         assert_eq!(node_txn.len(), 2);
4100         assert_eq!(node_txn[0].input.len(), 2);
4101         check_spends!(node_txn[0], revoked_local_txn[0].clone());
4102
4103         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4104         assert_eq!(spend_txn.len(), 2);
4105         assert_eq!(spend_txn[0], spend_txn[1]);
4106         check_spends!(spend_txn[0], node_txn[0].clone());
4107 }
4108
4109 #[test]
4110 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4111         let node_cfgs = create_node_cfgs(2);
4112         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4113         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4114
4115         // Create some initial channels
4116         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4117
4118         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4119         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();
4120         assert_eq!(revoked_local_txn[0].input.len(), 1);
4121         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4122
4123         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4124
4125         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4126         // A will generate HTLC-Timeout from revoked commitment tx
4127         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4128         check_closed_broadcast!(nodes[0], false);
4129
4130         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4131         assert_eq!(revoked_htlc_txn.len(), 3);
4132         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4133         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4134         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4135         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4136         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
4137
4138         // B will generate justice tx from A's revoked commitment/HTLC tx
4139         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4140         check_closed_broadcast!(nodes[1], false);
4141
4142         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4143         assert_eq!(node_txn.len(), 4 ); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4144         assert_eq!(node_txn[2].input.len(), 1);
4145         check_spends!(node_txn[2], revoked_htlc_txn[0].clone());
4146
4147         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4148         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4149         assert_eq!(spend_txn.len(), 3);
4150         assert_eq!(spend_txn[0], spend_txn[1]);
4151         check_spends!(spend_txn[0], node_txn[0].clone());
4152         check_spends!(spend_txn[2], node_txn[2].clone());
4153 }
4154
4155 #[test]
4156 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4157         let node_cfgs = create_node_cfgs(2);
4158         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4159         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4160
4161         // Create some initial channels
4162         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4163
4164         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4165         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();
4166         assert_eq!(revoked_local_txn[0].input.len(), 1);
4167         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4168
4169         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4170
4171         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4172         // B will generate HTLC-Success from revoked commitment tx
4173         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4174         check_closed_broadcast!(nodes[1], false);
4175         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4176
4177         assert_eq!(revoked_htlc_txn.len(), 3);
4178         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4179         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4180         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4181         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4182
4183         // A will generate justice tx from B's revoked commitment/HTLC tx
4184         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4185         check_closed_broadcast!(nodes[0], false);
4186
4187         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4188         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4189         assert_eq!(node_txn[2].input.len(), 1);
4190         check_spends!(node_txn[2], revoked_htlc_txn[0].clone());
4191
4192         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4193         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4194         assert_eq!(spend_txn.len(), 5);
4195         assert_eq!(spend_txn[0], spend_txn[2]);
4196         assert_eq!(spend_txn[1], spend_txn[3]);
4197         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4198         check_spends!(spend_txn[1], node_txn[0].clone()); // spending justice tx output from revoked local tx htlc received output
4199         check_spends!(spend_txn[4], node_txn[2].clone()); // spending justice tx output on htlc success tx
4200 }
4201
4202 #[test]
4203 fn test_onchain_to_onchain_claim() {
4204         // Test that in case of channel closure, we detect the state of output thanks to
4205         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4206         // First, have C claim an HTLC against its own latest commitment transaction.
4207         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4208         // channel.
4209         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4210         // gets broadcast.
4211
4212         let node_cfgs = create_node_cfgs(3);
4213         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4214         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4215
4216         // Create some initial channels
4217         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4218         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4219
4220         // Rebalance the network a bit by relaying one payment through all the channels ...
4221         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4222         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4223
4224         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4225         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4226         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();
4227         check_spends!(commitment_tx[0], chan_2.3.clone());
4228         nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4229         check_added_monitors!(nodes[2], 1);
4230         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4231         assert!(updates.update_add_htlcs.is_empty());
4232         assert!(updates.update_fail_htlcs.is_empty());
4233         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4234         assert!(updates.update_fail_malformed_htlcs.is_empty());
4235
4236         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4237         check_closed_broadcast!(nodes[2], false);
4238
4239         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4240         assert_eq!(c_txn.len(), 4);
4241         assert_eq!(c_txn[0], c_txn[2]);
4242         assert_eq!(c_txn[0], c_txn[3]);
4243         assert_eq!(commitment_tx[0], c_txn[1]);
4244         check_spends!(c_txn[1], chan_2.3.clone());
4245         check_spends!(c_txn[2], c_txn[1].clone());
4246         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4247         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4248         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4249         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4250
4251         // 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
4252         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4253         {
4254                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4255                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4256                 assert_eq!(b_txn.len(), 3);
4257                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4258                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4259                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4260                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4261                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4262                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4263                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4264                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4265                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4266                 b_txn.clear();
4267         }
4268         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4269         check_added_monitors!(nodes[1], 1);
4270         match msg_events[0] {
4271                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4272                 _ => panic!("Unexpected event"),
4273         }
4274         match msg_events[1] {
4275                 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, .. } } => {
4276                         assert!(update_add_htlcs.is_empty());
4277                         assert!(update_fail_htlcs.is_empty());
4278                         assert_eq!(update_fulfill_htlcs.len(), 1);
4279                         assert!(update_fail_malformed_htlcs.is_empty());
4280                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4281                 },
4282                 _ => panic!("Unexpected event"),
4283         };
4284         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4285         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();
4286         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4287         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4288         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4289         assert_eq!(b_txn.len(), 3);
4290         check_spends!(b_txn[1], chan_1.3);
4291         check_spends!(b_txn[2], b_txn[1].clone());
4292         check_spends!(b_txn[0], commitment_tx[0].clone());
4293         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4294         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4295         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4296
4297         check_closed_broadcast!(nodes[1], false);
4298 }
4299
4300 #[test]
4301 fn test_duplicate_payment_hash_one_failure_one_success() {
4302         // Topology : A --> B --> C
4303         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4304         let node_cfgs = create_node_cfgs(3);
4305         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4306         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4307
4308         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4309         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4310
4311         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4312         *nodes[0].network_payment_count.borrow_mut() -= 1;
4313         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4314
4315         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();
4316         assert_eq!(commitment_txn[0].input.len(), 1);
4317         check_spends!(commitment_txn[0], chan_2.3.clone());
4318
4319         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4320         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4321         check_closed_broadcast!(nodes[1], false);
4322
4323         let htlc_timeout_tx;
4324         { // Extract one of the two HTLC-Timeout transaction
4325                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4326                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4327                 assert_eq!(node_txn.len(), 5);
4328                 check_spends!(node_txn[0], commitment_txn[0].clone());
4329                 assert_eq!(node_txn[0].input.len(), 1);
4330                 check_spends!(node_txn[1], commitment_txn[0].clone());
4331                 assert_eq!(node_txn[1].input.len(), 1);
4332                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4333                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4334                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4335                 check_spends!(node_txn[2], chan_2.3.clone());
4336                 check_spends!(node_txn[3], node_txn[2].clone());
4337                 check_spends!(node_txn[4], node_txn[2].clone());
4338                 htlc_timeout_tx = node_txn[1].clone();
4339         }
4340
4341         nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4342         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4343         check_added_monitors!(nodes[2], 2);
4344         let events = nodes[2].node.get_and_clear_pending_msg_events();
4345         match events[0] {
4346                 MessageSendEvent::UpdateHTLCs { .. } => {},
4347                 _ => panic!("Unexpected event"),
4348         }
4349         match events[1] {
4350                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4351                 _ => panic!("Unexepected event"),
4352         }
4353         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4354         assert_eq!(htlc_success_txn.len(), 7);
4355         check_spends!(htlc_success_txn[2], chan_2.3.clone());
4356         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4357         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4358         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4359         assert_eq!(htlc_success_txn[0].input.len(), 1);
4360         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4361         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4362         assert_eq!(htlc_success_txn[1].input.len(), 1);
4363         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4364         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4365         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4366         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4367
4368         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4369         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4370         expect_pending_htlcs_forwardable!(nodes[1]);
4371         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4372         assert!(htlc_updates.update_add_htlcs.is_empty());
4373         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4374         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4375         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4376         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4377         check_added_monitors!(nodes[1], 1);
4378
4379         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4380         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4381         {
4382                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4383                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4384                 assert_eq!(events.len(), 1);
4385                 match events[0] {
4386                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4387                         },
4388                         _ => { panic!("Unexpected event"); }
4389                 }
4390         }
4391         let events = nodes[0].node.get_and_clear_pending_events();
4392         match events[0] {
4393                 Event::PaymentFailed { ref payment_hash, .. } => {
4394                         assert_eq!(*payment_hash, duplicate_payment_hash);
4395                 }
4396                 _ => panic!("Unexpected event"),
4397         }
4398
4399         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4400         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4401         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4402         assert!(updates.update_add_htlcs.is_empty());
4403         assert!(updates.update_fail_htlcs.is_empty());
4404         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4405         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4406         assert!(updates.update_fail_malformed_htlcs.is_empty());
4407         check_added_monitors!(nodes[1], 1);
4408
4409         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4410         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4411
4412         let events = nodes[0].node.get_and_clear_pending_events();
4413         match events[0] {
4414                 Event::PaymentSent { ref payment_preimage } => {
4415                         assert_eq!(*payment_preimage, our_payment_preimage);
4416                 }
4417                 _ => panic!("Unexpected event"),
4418         }
4419 }
4420
4421 #[test]
4422 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4423         let node_cfgs = create_node_cfgs(2);
4424         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4425         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4426
4427         // Create some initial channels
4428         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4429
4430         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4431         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();
4432         assert_eq!(local_txn[0].input.len(), 1);
4433         check_spends!(local_txn[0], chan_1.3.clone());
4434
4435         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4436         nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4437         check_added_monitors!(nodes[1], 1);
4438         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4439         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4440         let events = nodes[1].node.get_and_clear_pending_msg_events();
4441         match events[0] {
4442                 MessageSendEvent::UpdateHTLCs { .. } => {},
4443                 _ => panic!("Unexpected event"),
4444         }
4445         match events[1] {
4446                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4447                 _ => panic!("Unexepected event"),
4448         }
4449         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4450         assert_eq!(node_txn[0].input.len(), 1);
4451         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4452         check_spends!(node_txn[0], local_txn[0].clone());
4453
4454         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4455         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4456         assert_eq!(spend_txn.len(), 2);
4457         check_spends!(spend_txn[0], node_txn[0].clone());
4458         check_spends!(spend_txn[1], node_txn[2].clone());
4459 }
4460
4461 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4462         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4463         // unrevoked commitment transaction.
4464         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4465         // a remote RAA before they could be failed backwards (and combinations thereof).
4466         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4467         // use the same payment hashes.
4468         // Thus, we use a six-node network:
4469         //
4470         // A \         / E
4471         //    - C - D -
4472         // B /         \ F
4473         // And test where C fails back to A/B when D announces its latest commitment transaction
4474         let node_cfgs = create_node_cfgs(6);
4475         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4476         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4477
4478         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4479         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4480         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4481         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4482         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4483
4484         // Rebalance and check output sanity...
4485         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4486         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4487         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);
4488
4489         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4490         // 0th HTLC:
4491         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
4492         // 1st HTLC:
4493         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
4494         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();
4495         // 2nd HTLC:
4496         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
4497         // 3rd HTLC:
4498         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
4499         // 4th HTLC:
4500         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4501         // 5th HTLC:
4502         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4503         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4504         // 6th HTLC:
4505         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4506         // 7th HTLC:
4507         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4508
4509         // 8th HTLC:
4510         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4511         // 9th HTLC:
4512         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();
4513         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
4514
4515         // 10th HTLC:
4516         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
4517         // 11th HTLC:
4518         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4519         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4520
4521         // Double-check that six of the new HTLC were added
4522         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4523         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4524         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);
4525         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);
4526
4527         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4528         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4529         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4530         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4531         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4532         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4533         check_added_monitors!(nodes[4], 0);
4534         expect_pending_htlcs_forwardable!(nodes[4]);
4535         check_added_monitors!(nodes[4], 1);
4536
4537         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4538         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4539         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4540         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4541         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4542         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4543
4544         // Fail 3rd below-dust and 7th above-dust HTLCs
4545         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4546         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4547         check_added_monitors!(nodes[5], 0);
4548         expect_pending_htlcs_forwardable!(nodes[5]);
4549         check_added_monitors!(nodes[5], 1);
4550
4551         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4552         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4553         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4554         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4555
4556         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();
4557
4558         expect_pending_htlcs_forwardable!(nodes[3]);
4559         check_added_monitors!(nodes[3], 1);
4560         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4561         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4562         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4563         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4564         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4565         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4566         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4567         if deliver_last_raa {
4568                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4569         } else {
4570                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4571         }
4572
4573         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4574         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4575         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4576         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4577         //
4578         // We now broadcast the latest commitment transaction, which *should* result in failures for
4579         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4580         // the non-broadcast above-dust HTLCs.
4581         //
4582         // Alternatively, we may broadcast the previous commitment transaction, which should only
4583         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4584         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();
4585
4586         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4587         if announce_latest {
4588                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4589         } else {
4590                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4591         }
4592         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4593         check_closed_broadcast!(nodes[2], false);
4594         expect_pending_htlcs_forwardable!(nodes[2]);
4595         check_added_monitors!(nodes[2], 2);
4596
4597         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4598         assert_eq!(cs_msgs.len(), 2);
4599         let mut a_done = false;
4600         for msg in cs_msgs {
4601                 match msg {
4602                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4603                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4604                                 // should be failed-backwards here.
4605                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4606                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4607                                         for htlc in &updates.update_fail_htlcs {
4608                                                 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 });
4609                                         }
4610                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4611                                         assert!(!a_done);
4612                                         a_done = true;
4613                                         &nodes[0]
4614                                 } else {
4615                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4616                                         for htlc in &updates.update_fail_htlcs {
4617                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4618                                         }
4619                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4620                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4621                                         &nodes[1]
4622                                 };
4623                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4624                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4625                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4626                                 if announce_latest {
4627                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4628                                         if *node_id == nodes[0].node.get_our_node_id() {
4629                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4630                                         }
4631                                 }
4632                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4633                         },
4634                         _ => panic!("Unexpected event"),
4635                 }
4636         }
4637
4638         let as_events = nodes[0].node.get_and_clear_pending_events();
4639         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4640         let mut as_failds = HashSet::new();
4641         for event in as_events.iter() {
4642                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4643                         assert!(as_failds.insert(*payment_hash));
4644                         if *payment_hash != payment_hash_2 {
4645                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4646                         } else {
4647                                 assert!(!rejected_by_dest);
4648                         }
4649                 } else { panic!("Unexpected event"); }
4650         }
4651         assert!(as_failds.contains(&payment_hash_1));
4652         assert!(as_failds.contains(&payment_hash_2));
4653         if announce_latest {
4654                 assert!(as_failds.contains(&payment_hash_3));
4655                 assert!(as_failds.contains(&payment_hash_5));
4656         }
4657         assert!(as_failds.contains(&payment_hash_6));
4658
4659         let bs_events = nodes[1].node.get_and_clear_pending_events();
4660         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4661         let mut bs_failds = HashSet::new();
4662         for event in bs_events.iter() {
4663                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4664                         assert!(bs_failds.insert(*payment_hash));
4665                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4666                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4667                         } else {
4668                                 assert!(!rejected_by_dest);
4669                         }
4670                 } else { panic!("Unexpected event"); }
4671         }
4672         assert!(bs_failds.contains(&payment_hash_1));
4673         assert!(bs_failds.contains(&payment_hash_2));
4674         if announce_latest {
4675                 assert!(bs_failds.contains(&payment_hash_4));
4676         }
4677         assert!(bs_failds.contains(&payment_hash_5));
4678
4679         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4680         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4681         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4682         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4683         // PaymentFailureNetworkUpdates.
4684         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4685         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4686         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4687         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4688         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4689                 match event {
4690                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4691                         _ => panic!("Unexpected event"),
4692                 }
4693         }
4694 }
4695
4696 #[test]
4697 fn test_fail_backwards_latest_remote_announce_a() {
4698         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4699 }
4700
4701 #[test]
4702 fn test_fail_backwards_latest_remote_announce_b() {
4703         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4704 }
4705
4706 #[test]
4707 fn test_fail_backwards_previous_remote_announce() {
4708         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4709         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4710         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4711 }
4712
4713 #[test]
4714 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4715         let node_cfgs = create_node_cfgs(2);
4716         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4717         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4718
4719         // Create some initial channels
4720         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4721
4722         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4723         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();
4724         assert_eq!(local_txn[0].input.len(), 1);
4725         check_spends!(local_txn[0], chan_1.3.clone());
4726
4727         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4728         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4729         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4730         check_closed_broadcast!(nodes[0], false);
4731
4732         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4733         assert_eq!(node_txn[0].input.len(), 1);
4734         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4735         check_spends!(node_txn[0], local_txn[0].clone());
4736
4737         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4738         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4739         assert_eq!(spend_txn.len(), 8);
4740         assert_eq!(spend_txn[0], spend_txn[2]);
4741         assert_eq!(spend_txn[0], spend_txn[4]);
4742         assert_eq!(spend_txn[0], spend_txn[6]);
4743         assert_eq!(spend_txn[1], spend_txn[3]);
4744         assert_eq!(spend_txn[1], spend_txn[5]);
4745         assert_eq!(spend_txn[1], spend_txn[7]);
4746         check_spends!(spend_txn[0], local_txn[0].clone());
4747         check_spends!(spend_txn[1], node_txn[0].clone());
4748 }
4749
4750 #[test]
4751 fn test_static_output_closing_tx() {
4752         let node_cfgs = create_node_cfgs(2);
4753         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4754         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4755
4756         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4757
4758         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4759         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4760
4761         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4762         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4763         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4764         assert_eq!(spend_txn.len(), 1);
4765         check_spends!(spend_txn[0], closing_tx.clone());
4766
4767         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4768         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4769         assert_eq!(spend_txn.len(), 1);
4770         check_spends!(spend_txn[0], closing_tx);
4771 }
4772
4773 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4774         let node_cfgs = create_node_cfgs(2);
4775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4776         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4777         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4778
4779         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4780
4781         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4782         // present in B's local commitment transaction, but none of A's commitment transactions.
4783         assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4784         check_added_monitors!(nodes[1], 1);
4785
4786         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4787         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4788         let events = nodes[0].node.get_and_clear_pending_events();
4789         assert_eq!(events.len(), 1);
4790         match events[0] {
4791                 Event::PaymentSent { payment_preimage } => {
4792                         assert_eq!(payment_preimage, our_payment_preimage);
4793                 },
4794                 _ => panic!("Unexpected event"),
4795         }
4796
4797         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4798         check_added_monitors!(nodes[0], 1);
4799         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4800         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4801         check_added_monitors!(nodes[1], 1);
4802
4803         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4804         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4805                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4806                 header.prev_blockhash = header.bitcoin_hash();
4807         }
4808         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4809         check_closed_broadcast!(nodes[1], false);
4810 }
4811
4812 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4813         let node_cfgs = create_node_cfgs(2);
4814         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4815         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4816         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4817
4818         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();
4819         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4820         nodes[0].node.send_payment(route, payment_hash).unwrap();
4821         check_added_monitors!(nodes[0], 1);
4822
4823         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4824
4825         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4826         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4827         // to "time out" the HTLC.
4828
4829         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4830
4831         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4832                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4833                 header.prev_blockhash = header.bitcoin_hash();
4834         }
4835         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4836         check_closed_broadcast!(nodes[0], false);
4837 }
4838
4839 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4840         let node_cfgs = create_node_cfgs(3);
4841         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4842         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4843         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4844
4845         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4846         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4847         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4848         // actually revoked.
4849         let htlc_value = if use_dust { 50000 } else { 3000000 };
4850         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4851         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4852         expect_pending_htlcs_forwardable!(nodes[1]);
4853         check_added_monitors!(nodes[1], 1);
4854
4855         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4856         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4857         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4858         check_added_monitors!(nodes[0], 1);
4859         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4860         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4861         check_added_monitors!(nodes[1], 1);
4862         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4863         check_added_monitors!(nodes[1], 1);
4864         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4865
4866         if check_revoke_no_close {
4867                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4868                 check_added_monitors!(nodes[0], 1);
4869         }
4870
4871         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4872         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4873                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4874                 header.prev_blockhash = header.bitcoin_hash();
4875         }
4876         if !check_revoke_no_close {
4877                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4878                 check_closed_broadcast!(nodes[0], false);
4879         } else {
4880                 let events = nodes[0].node.get_and_clear_pending_events();
4881                 assert_eq!(events.len(), 1);
4882                 match events[0] {
4883                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4884                                 assert_eq!(payment_hash, our_payment_hash);
4885                                 assert!(rejected_by_dest);
4886                         },
4887                         _ => panic!("Unexpected event"),
4888                 }
4889         }
4890 }
4891
4892 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4893 // There are only a few cases to test here:
4894 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4895 //    broadcastable commitment transactions result in channel closure,
4896 //  * its included in an unrevoked-but-previous remote commitment transaction,
4897 //  * its included in the latest remote or local commitment transactions.
4898 // We test each of the three possible commitment transactions individually and use both dust and
4899 // non-dust HTLCs.
4900 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4901 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4902 // tested for at least one of the cases in other tests.
4903 #[test]
4904 fn htlc_claim_single_commitment_only_a() {
4905         do_htlc_claim_local_commitment_only(true);
4906         do_htlc_claim_local_commitment_only(false);
4907
4908         do_htlc_claim_current_remote_commitment_only(true);
4909         do_htlc_claim_current_remote_commitment_only(false);
4910 }
4911
4912 #[test]
4913 fn htlc_claim_single_commitment_only_b() {
4914         do_htlc_claim_previous_remote_commitment_only(true, false);
4915         do_htlc_claim_previous_remote_commitment_only(false, false);
4916         do_htlc_claim_previous_remote_commitment_only(true, true);
4917         do_htlc_claim_previous_remote_commitment_only(false, true);
4918 }
4919
4920 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>)
4921         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4922                                 F2: FnMut(),
4923 {
4924         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);
4925 }
4926
4927 // test_case
4928 // 0: node1 fails backward
4929 // 1: final node fails backward
4930 // 2: payment completed but the user rejects the payment
4931 // 3: final node fails backward (but tamper onion payloads from node0)
4932 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4933 // 200: trigger error in the final node and tamper returning fail_htlc
4934 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>)
4935         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4936                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4937                                 F3: FnMut(),
4938 {
4939
4940         // reset block height
4941         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4942         for ix in 0..nodes.len() {
4943                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4944         }
4945
4946         macro_rules! expect_event {
4947                 ($node: expr, $event_type: path) => {{
4948                         let events = $node.node.get_and_clear_pending_events();
4949                         assert_eq!(events.len(), 1);
4950                         match events[0] {
4951                                 $event_type { .. } => {},
4952                                 _ => panic!("Unexpected event"),
4953                         }
4954                 }}
4955         }
4956
4957         macro_rules! expect_htlc_forward {
4958                 ($node: expr) => {{
4959                         expect_event!($node, Event::PendingHTLCsForwardable);
4960                         $node.node.process_pending_htlc_forwards();
4961                 }}
4962         }
4963
4964         // 0 ~~> 2 send payment
4965         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4966         check_added_monitors!(nodes[0], 1);
4967         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4968         // temper update_add (0 => 1)
4969         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4970         if test_case == 0 || test_case == 3 || test_case == 100 {
4971                 callback_msg(&mut update_add_0);
4972                 callback_node();
4973         }
4974         // 0 => 1 update_add & CS
4975         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4976         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4977
4978         let update_1_0 = match test_case {
4979                 0|100 => { // intermediate node failure; fail backward to 0
4980                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4981                         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));
4982                         update_1_0
4983                 },
4984                 1|2|3|200 => { // final node failure; forwarding to 2
4985                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4986                         // forwarding on 1
4987                         if test_case != 200 {
4988                                 callback_node();
4989                         }
4990                         expect_htlc_forward!(&nodes[1]);
4991
4992                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4993                         check_added_monitors!(&nodes[1], 1);
4994                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4995                         // tamper update_add (1 => 2)
4996                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4997                         if test_case != 3 && test_case != 200 {
4998                                 callback_msg(&mut update_add_1);
4999                         }
5000
5001                         // 1 => 2
5002                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5003                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5004
5005                         if test_case == 2 || test_case == 200 {
5006                                 expect_htlc_forward!(&nodes[2]);
5007                                 expect_event!(&nodes[2], Event::PaymentReceived);
5008                                 callback_node();
5009                                 expect_pending_htlcs_forwardable!(nodes[2]);
5010                         }
5011
5012                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5013                         if test_case == 2 || test_case == 200 {
5014                                 check_added_monitors!(&nodes[2], 1);
5015                         }
5016                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5017
5018                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5019                         if test_case == 200 {
5020                                 callback_fail(&mut fail_msg);
5021                         }
5022
5023                         // 2 => 1
5024                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5025                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5026
5027                         // backward fail on 1
5028                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5029                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5030                         update_1_0
5031                 },
5032                 _ => unreachable!(),
5033         };
5034
5035         // 1 => 0 commitment_signed_dance
5036         if update_1_0.update_fail_htlcs.len() > 0 {
5037                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5038                 if test_case == 100 {
5039                         callback_fail(&mut fail_msg);
5040                 }
5041                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5042         } else {
5043                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5044         };
5045
5046         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5047
5048         let events = nodes[0].node.get_and_clear_pending_events();
5049         assert_eq!(events.len(), 1);
5050         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5051                 assert_eq!(*rejected_by_dest, !expected_retryable);
5052                 assert_eq!(*error_code, expected_error_code);
5053         } else {
5054                 panic!("Uexpected event");
5055         }
5056
5057         let events = nodes[0].node.get_and_clear_pending_msg_events();
5058         if expected_channel_update.is_some() {
5059                 assert_eq!(events.len(), 1);
5060                 match events[0] {
5061                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5062                                 match update {
5063                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5064                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5065                                                         panic!("channel_update not found!");
5066                                                 }
5067                                         },
5068                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5069                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5070                                                         assert!(*short_channel_id == *expected_short_channel_id);
5071                                                         assert!(*is_permanent == *expected_is_permanent);
5072                                                 } else {
5073                                                         panic!("Unexpected message event");
5074                                                 }
5075                                         },
5076                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5077                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5078                                                         assert!(*node_id == *expected_node_id);
5079                                                         assert!(*is_permanent == *expected_is_permanent);
5080                                                 } else {
5081                                                         panic!("Unexpected message event");
5082                                                 }
5083                                         },
5084                                 }
5085                         },
5086                         _ => panic!("Unexpected message event"),
5087                 }
5088         } else {
5089                 assert_eq!(events.len(), 0);
5090         }
5091 }
5092
5093 impl msgs::ChannelUpdate {
5094         fn dummy() -> msgs::ChannelUpdate {
5095                 use secp256k1::ffi::Signature as FFISignature;
5096                 use secp256k1::Signature;
5097                 msgs::ChannelUpdate {
5098                         signature: Signature::from(FFISignature::new()),
5099                         contents: msgs::UnsignedChannelUpdate {
5100                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5101                                 short_channel_id: 0,
5102                                 timestamp: 0,
5103                                 flags: 0,
5104                                 cltv_expiry_delta: 0,
5105                                 htlc_minimum_msat: 0,
5106                                 fee_base_msat: 0,
5107                                 fee_proportional_millionths: 0,
5108                                 excess_data: vec![],
5109                         }
5110                 }
5111         }
5112 }
5113
5114 struct BogusOnionHopData {
5115         data: Vec<u8>
5116 }
5117 impl BogusOnionHopData {
5118         fn new(orig: msgs::OnionHopData) -> Self {
5119                 Self { data: orig.encode() }
5120         }
5121 }
5122 impl Writeable for BogusOnionHopData {
5123         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5124                 writer.write_all(&self.data[..])
5125         }
5126 }
5127
5128 #[test]
5129 fn test_onion_failure() {
5130         use ln::msgs::ChannelUpdate;
5131         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5132         use secp256k1;
5133
5134         const BADONION: u16 = 0x8000;
5135         const PERM: u16 = 0x4000;
5136         const NODE: u16 = 0x2000;
5137         const UPDATE: u16 = 0x1000;
5138
5139         let node_cfgs = create_node_cfgs(3);
5140         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5141         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5142         for node in nodes.iter() {
5143                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5144         }
5145         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())];
5146         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5147         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5148         // positve case
5149         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5150
5151         // intermediate node failure
5152         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5153                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5154                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5155                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5156                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5157                 let mut new_payloads = Vec::new();
5158                 for payload in onion_payloads.drain(..) {
5159                         new_payloads.push(BogusOnionHopData::new(payload));
5160                 }
5161                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5162                 // describing a length-1 TLV payload, which is obviously bogus.
5163                 new_payloads[0].data[0] = 1;
5164                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5165         }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
5166
5167         // final node failure
5168         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5169                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5170                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5171                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5172                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5173                 let mut new_payloads = Vec::new();
5174                 for payload in onion_payloads.drain(..) {
5175                         new_payloads.push(BogusOnionHopData::new(payload));
5176                 }
5177                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5178                 // length-1 TLV payload, which is obviously bogus.
5179                 new_payloads[1].data[0] = 1;
5180                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5181         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5182
5183         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5184         // receiving simulated fail messages
5185         // intermediate node failure
5186         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5187                 // trigger error
5188                 msg.amount_msat -= 1;
5189         }, |msg| {
5190                 // and tamper returning error message
5191                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5192                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5193                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5194         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5195
5196         // final node failure
5197         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5198                 // and tamper returning error message
5199                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5200                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5201                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5202         }, ||{
5203                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5204         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5205
5206         // intermediate node failure
5207         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5208                 msg.amount_msat -= 1;
5209         }, |msg| {
5210                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5211                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5212                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5213         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5214
5215         // final node failure
5216         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5217                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5218                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5219                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5220         }, ||{
5221                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5222         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5223
5224         // intermediate node failure
5225         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5226                 msg.amount_msat -= 1;
5227         }, |msg| {
5228                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5229                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5230                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5231         }, ||{
5232                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5233         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5234
5235         // final node failure
5236         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5237                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5238                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5239                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5240         }, ||{
5241                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5242         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5243
5244         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5245                 Some(BADONION|PERM|4), None);
5246
5247         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5248                 Some(BADONION|PERM|5), None);
5249
5250         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5251                 Some(BADONION|PERM|6), None);
5252
5253         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5254                 msg.amount_msat -= 1;
5255         }, |msg| {
5256                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5257                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5258                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5259         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5260
5261         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5262                 msg.amount_msat -= 1;
5263         }, |msg| {
5264                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5265                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5266                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5267                 // short_channel_id from the processing node
5268         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5269
5270         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5271                 msg.amount_msat -= 1;
5272         }, |msg| {
5273                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5274                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5275                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5276                 // short_channel_id from the processing node
5277         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5278
5279         let mut bogus_route = route.clone();
5280         bogus_route.hops[1].short_channel_id -= 1;
5281         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5282           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5283
5284         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5285         let mut bogus_route = route.clone();
5286         let route_len = bogus_route.hops.len();
5287         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5288         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5289
5290         //TODO: with new config API, we will be able to generate both valid and
5291         //invalid channel_update cases.
5292         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5293                 msg.amount_msat -= 1;
5294         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5295
5296         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5297                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5298                 msg.cltv_expiry -= 1;
5299         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5300
5301         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5302                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5303                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5304
5305                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5306         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5307
5308         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5309                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5310         }, false, Some(PERM|15), None);
5311
5312         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5313                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5314                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5315
5316                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5317         }, || {}, true, Some(17), None);
5318
5319         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5320                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5321                         for f in pending_forwards.iter_mut() {
5322                                 match f {
5323                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5324                                                 forward_info.outgoing_cltv_value += 1,
5325                                         _ => {},
5326                                 }
5327                         }
5328                 }
5329         }, true, Some(18), None);
5330
5331         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5332                 // violate amt_to_forward > msg.amount_msat
5333                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5334                         for f in pending_forwards.iter_mut() {
5335                                 match f {
5336                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5337                                                 forward_info.amt_to_forward -= 1,
5338                                         _ => {},
5339                                 }
5340                         }
5341                 }
5342         }, true, Some(19), None);
5343
5344         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5345                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5346                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5347                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5348         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5349         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5350
5351         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5352                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5353                 let mut route = route.clone();
5354                 let height = 1;
5355                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5356                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5357                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5358                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5359                 msg.cltv_expiry = htlc_cltv;
5360                 msg.onion_routing_packet = onion_packet;
5361         }, ||{}, true, Some(21), None);
5362 }
5363
5364 #[test]
5365 #[should_panic]
5366 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5367         let node_cfgs = create_node_cfgs(2);
5368         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5369         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5370         //Force duplicate channel ids
5371         for node in nodes.iter() {
5372                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5373         }
5374
5375         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5376         let channel_value_satoshis=10000;
5377         let push_msat=10001;
5378         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5379         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5380         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5381
5382         //Create a second channel with a channel_id collision
5383         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5384 }
5385
5386 #[test]
5387 fn bolt2_open_channel_sending_node_checks_part2() {
5388         let node_cfgs = create_node_cfgs(2);
5389         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5390         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5391
5392         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5393         let channel_value_satoshis=2^24;
5394         let push_msat=10001;
5395         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5396
5397         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5398         let channel_value_satoshis=10000;
5399         // Test when push_msat is equal to 1000 * funding_satoshis.
5400         let push_msat=1000*channel_value_satoshis+1;
5401         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5402
5403         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5404         let channel_value_satoshis=10000;
5405         let push_msat=10001;
5406         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
5407         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5408         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5409
5410         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5411         // 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
5412         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5413
5414         // 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.
5415         assert!(BREAKDOWN_TIMEOUT>0);
5416         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5417
5418         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5419         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5420         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5421
5422         // 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.
5423         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5424         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5425         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5426         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5427         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5428 }
5429
5430 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5431 // 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.
5432 //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.
5433
5434 #[test]
5435 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5436         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5437         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5438         let node_cfgs = create_node_cfgs(2);
5439         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5440         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5441         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5442         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5443         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5444
5445         route.hops[0].fee_msat = 0;
5446
5447         let err = nodes[0].node.send_payment(route, our_payment_hash);
5448
5449         if let Err(APIError::ChannelUnavailable{err}) = err {
5450                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5451         } else {
5452                 assert!(false);
5453         }
5454         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5455         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5456 }
5457
5458 #[test]
5459 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5460         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5461         //It is enforced when constructing a route.
5462         let node_cfgs = create_node_cfgs(2);
5463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5464         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5465         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5466         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5467         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5468
5469         let err = nodes[0].node.send_payment(route, our_payment_hash);
5470
5471         if let Err(APIError::RouteError{err}) = err {
5472                 assert_eq!(err, "Channel CLTV overflowed?!");
5473         } else {
5474                 assert!(false);
5475         }
5476 }
5477
5478 #[test]
5479 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5480         //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.
5481         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5482         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5483         let node_cfgs = create_node_cfgs(2);
5484         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5485         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5486         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5487         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5488
5489         for i in 0..max_accepted_htlcs {
5490                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5491                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5492                 let payment_event = {
5493                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5494                         check_added_monitors!(nodes[0], 1);
5495
5496                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5497                         assert_eq!(events.len(), 1);
5498                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5499                                 assert_eq!(htlcs[0].htlc_id, i);
5500                         } else {
5501                                 assert!(false);
5502                         }
5503                         SendEvent::from_event(events.remove(0))
5504                 };
5505                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5506                 check_added_monitors!(nodes[1], 0);
5507                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5508
5509                 expect_pending_htlcs_forwardable!(nodes[1]);
5510                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5511         }
5512         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5513         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5514         let err = nodes[0].node.send_payment(route, our_payment_hash);
5515
5516         if let Err(APIError::ChannelUnavailable{err}) = err {
5517                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5518         } else {
5519                 assert!(false);
5520         }
5521         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5522         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5523 }
5524
5525 #[test]
5526 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5527         //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.
5528         let node_cfgs = create_node_cfgs(2);
5529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5530         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5531         let channel_value = 100000;
5532         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5533         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5534
5535         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5536
5537         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5538         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5539         let err = nodes[0].node.send_payment(route, our_payment_hash);
5540
5541         if let Err(APIError::ChannelUnavailable{err}) = err {
5542                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5543         } else {
5544                 assert!(false);
5545         }
5546         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5547         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);
5548
5549         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5550 }
5551
5552 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5553 #[test]
5554 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5555         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5556         let node_cfgs = create_node_cfgs(2);
5557         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5558         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5559         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5560         let htlc_minimum_msat: u64;
5561         {
5562                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5563                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5564                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5565         }
5566         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5567         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5568         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5569         check_added_monitors!(nodes[0], 1);
5570         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5571         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5572         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5573         assert!(nodes[1].node.list_channels().is_empty());
5574         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5575         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5576 }
5577
5578 #[test]
5579 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5580         //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
5581         let node_cfgs = create_node_cfgs(2);
5582         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5583         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5584         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5585
5586         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5587
5588         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5589         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5590         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5591         check_added_monitors!(nodes[0], 1);
5592         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5593
5594         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5595         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5596
5597         assert!(nodes[1].node.list_channels().is_empty());
5598         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5599         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5600 }
5601
5602 #[test]
5603 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5604         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5605         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5606         let node_cfgs = create_node_cfgs(2);
5607         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5608         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5609         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5610         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5611         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5612
5613         let session_priv = SecretKey::from_slice(&{
5614                 let mut session_key = [0; 32];
5615                 let mut rng = thread_rng();
5616                 rng.fill_bytes(&mut session_key);
5617                 session_key
5618         }).expect("RNG is bad!");
5619
5620         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5621         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5622         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5623         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5624
5625         let mut msg = msgs::UpdateAddHTLC {
5626                 channel_id: chan.2,
5627                 htlc_id: 0,
5628                 amount_msat: 1000,
5629                 payment_hash: our_payment_hash,
5630                 cltv_expiry: htlc_cltv,
5631                 onion_routing_packet: onion_packet.clone(),
5632         };
5633
5634         for i in 0..super::channel::OUR_MAX_HTLCS {
5635                 msg.htlc_id = i as u64;
5636                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5637         }
5638         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5639         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5640
5641         assert!(nodes[1].node.list_channels().is_empty());
5642         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5643         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5644 }
5645
5646 #[test]
5647 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5648         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5649         let node_cfgs = create_node_cfgs(2);
5650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5651         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5652         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5653         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5654         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5655         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5656         check_added_monitors!(nodes[0], 1);
5657         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5658         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5659         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5660
5661         assert!(nodes[1].node.list_channels().is_empty());
5662         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5663         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5664 }
5665
5666 #[test]
5667 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5668         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5669         let node_cfgs = create_node_cfgs(2);
5670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5672         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5673         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5674         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5675         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5676         check_added_monitors!(nodes[0], 1);
5677         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5678         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5679         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5680
5681         assert!(nodes[1].node.list_channels().is_empty());
5682         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5683         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5684 }
5685
5686 #[test]
5687 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5688         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5689         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5690         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5691         let node_cfgs = create_node_cfgs(2);
5692         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5693         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5694         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5695         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5696         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5697         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5698         check_added_monitors!(nodes[0], 1);
5699         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5700         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5701
5702         //Disconnect and Reconnect
5703         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5704         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5705         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5706         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5707         assert_eq!(reestablish_1.len(), 1);
5708         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5709         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5710         assert_eq!(reestablish_2.len(), 1);
5711         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5712         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5713         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5714         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5715
5716         //Resend HTLC
5717         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5718         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5719         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5720         check_added_monitors!(nodes[1], 1);
5721         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5722
5723         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5724
5725         assert!(nodes[1].node.list_channels().is_empty());
5726         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5727         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5728 }
5729
5730 #[test]
5731 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5732         //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.
5733
5734         let node_cfgs = create_node_cfgs(2);
5735         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5736         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5737         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5738
5739         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5740         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5741         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5742         check_added_monitors!(nodes[0], 1);
5743         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5744         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5745
5746         let update_msg = msgs::UpdateFulfillHTLC{
5747                 channel_id: chan.2,
5748                 htlc_id: 0,
5749                 payment_preimage: our_payment_preimage,
5750         };
5751
5752         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5753
5754         assert!(nodes[0].node.list_channels().is_empty());
5755         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5756         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5757 }
5758
5759 #[test]
5760 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5761         //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.
5762
5763         let node_cfgs = create_node_cfgs(2);
5764         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5765         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5766         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5767
5768         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5769         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5770         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5771         check_added_monitors!(nodes[0], 1);
5772         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5773         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5774
5775         let update_msg = msgs::UpdateFailHTLC{
5776                 channel_id: chan.2,
5777                 htlc_id: 0,
5778                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5779         };
5780
5781         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5782
5783         assert!(nodes[0].node.list_channels().is_empty());
5784         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5785         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5786 }
5787
5788 #[test]
5789 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5790         //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.
5791
5792         let node_cfgs = create_node_cfgs(2);
5793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5794         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5795         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5796
5797         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5798         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5799         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5800         check_added_monitors!(nodes[0], 1);
5801         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5802         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5803
5804         let update_msg = msgs::UpdateFailMalformedHTLC{
5805                 channel_id: chan.2,
5806                 htlc_id: 0,
5807                 sha256_of_onion: [1; 32],
5808                 failure_code: 0x8000,
5809         };
5810
5811         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5812
5813         assert!(nodes[0].node.list_channels().is_empty());
5814         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5815         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5816 }
5817
5818 #[test]
5819 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5820         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5821
5822         let node_cfgs = create_node_cfgs(2);
5823         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5824         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5825         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5826
5827         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5828
5829         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5830         check_added_monitors!(nodes[1], 1);
5831
5832         let events = nodes[1].node.get_and_clear_pending_msg_events();
5833         assert_eq!(events.len(), 1);
5834         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5835                 match events[0] {
5836                         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, .. } } => {
5837                                 assert!(update_add_htlcs.is_empty());
5838                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5839                                 assert!(update_fail_htlcs.is_empty());
5840                                 assert!(update_fail_malformed_htlcs.is_empty());
5841                                 assert!(update_fee.is_none());
5842                                 update_fulfill_htlcs[0].clone()
5843                         },
5844                         _ => panic!("Unexpected event"),
5845                 }
5846         };
5847
5848         update_fulfill_msg.htlc_id = 1;
5849
5850         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5851
5852         assert!(nodes[0].node.list_channels().is_empty());
5853         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5854         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5855 }
5856
5857 #[test]
5858 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5859         //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.
5860
5861         let node_cfgs = create_node_cfgs(2);
5862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5863         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5864         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5865
5866         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5867
5868         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5869         check_added_monitors!(nodes[1], 1);
5870
5871         let events = nodes[1].node.get_and_clear_pending_msg_events();
5872         assert_eq!(events.len(), 1);
5873         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5874                 match events[0] {
5875                         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, .. } } => {
5876                                 assert!(update_add_htlcs.is_empty());
5877                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5878                                 assert!(update_fail_htlcs.is_empty());
5879                                 assert!(update_fail_malformed_htlcs.is_empty());
5880                                 assert!(update_fee.is_none());
5881                                 update_fulfill_htlcs[0].clone()
5882                         },
5883                         _ => panic!("Unexpected event"),
5884                 }
5885         };
5886
5887         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5888
5889         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5890
5891         assert!(nodes[0].node.list_channels().is_empty());
5892         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5893         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5894 }
5895
5896
5897 #[test]
5898 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5899         //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.
5900
5901         let node_cfgs = create_node_cfgs(2);
5902         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5903         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5904         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5905         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5906         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5907         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5908         check_added_monitors!(nodes[0], 1);
5909
5910         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5911         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5912
5913         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5914         check_added_monitors!(nodes[1], 0);
5915         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5916
5917         let events = nodes[1].node.get_and_clear_pending_msg_events();
5918
5919         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5920                 match events[0] {
5921                         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, .. } } => {
5922                                 assert!(update_add_htlcs.is_empty());
5923                                 assert!(update_fulfill_htlcs.is_empty());
5924                                 assert!(update_fail_htlcs.is_empty());
5925                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5926                                 assert!(update_fee.is_none());
5927                                 update_fail_malformed_htlcs[0].clone()
5928                         },
5929                         _ => panic!("Unexpected event"),
5930                 }
5931         };
5932         update_msg.failure_code &= !0x8000;
5933         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5934
5935         assert!(nodes[0].node.list_channels().is_empty());
5936         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5937         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5938 }
5939
5940 #[test]
5941 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5942         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5943         //    * 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.
5944
5945         let node_cfgs = create_node_cfgs(3);
5946         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5947         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5948         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5949         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5950
5951         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5952         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5953
5954         //First hop
5955         let mut payment_event = {
5956                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5957                 check_added_monitors!(nodes[0], 1);
5958                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5959                 assert_eq!(events.len(), 1);
5960                 SendEvent::from_event(events.remove(0))
5961         };
5962         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5963         check_added_monitors!(nodes[1], 0);
5964         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5965         expect_pending_htlcs_forwardable!(nodes[1]);
5966         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5967         assert_eq!(events_2.len(), 1);
5968         check_added_monitors!(nodes[1], 1);
5969         payment_event = SendEvent::from_event(events_2.remove(0));
5970         assert_eq!(payment_event.msgs.len(), 1);
5971
5972         //Second Hop
5973         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5974         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5975         check_added_monitors!(nodes[2], 0);
5976         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5977
5978         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5979         assert_eq!(events_3.len(), 1);
5980         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5981                 match events_3[0] {
5982                         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 } } => {
5983                                 assert!(update_add_htlcs.is_empty());
5984                                 assert!(update_fulfill_htlcs.is_empty());
5985                                 assert!(update_fail_htlcs.is_empty());
5986                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5987                                 assert!(update_fee.is_none());
5988                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5989                         },
5990                         _ => panic!("Unexpected event"),
5991                 }
5992         };
5993
5994         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5995
5996         check_added_monitors!(nodes[1], 0);
5997         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5998         expect_pending_htlcs_forwardable!(nodes[1]);
5999         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6000         assert_eq!(events_4.len(), 1);
6001
6002         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6003         match events_4[0] {
6004                 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, .. } } => {
6005                         assert!(update_add_htlcs.is_empty());
6006                         assert!(update_fulfill_htlcs.is_empty());
6007                         assert_eq!(update_fail_htlcs.len(), 1);
6008                         assert!(update_fail_malformed_htlcs.is_empty());
6009                         assert!(update_fee.is_none());
6010                 },
6011                 _ => panic!("Unexpected event"),
6012         };
6013
6014         check_added_monitors!(nodes[1], 1);
6015 }
6016
6017 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6018         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6019         // 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
6020         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6021
6022         let node_cfgs = create_node_cfgs(2);
6023         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6024         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6025         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6026
6027         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6028
6029         // We route 2 dust-HTLCs between A and B
6030         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6031         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6032         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6033
6034         // Cache one local commitment tx as previous
6035         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();
6036
6037         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6038         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6039         check_added_monitors!(nodes[1], 0);
6040         expect_pending_htlcs_forwardable!(nodes[1]);
6041         check_added_monitors!(nodes[1], 1);
6042
6043         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6044         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6045         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6046         check_added_monitors!(nodes[0], 1);
6047
6048         // Cache one local commitment tx as lastest
6049         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();
6050
6051         let events = nodes[0].node.get_and_clear_pending_msg_events();
6052         match events[0] {
6053                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6054                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6055                 },
6056                 _ => panic!("Unexpected event"),
6057         }
6058         match events[1] {
6059                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6060                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6061                 },
6062                 _ => panic!("Unexpected event"),
6063         }
6064
6065         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6066         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6067         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6068
6069         if announce_latest {
6070                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6071         } else {
6072                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6073         }
6074
6075         let events = nodes[0].node.get_and_clear_pending_msg_events();
6076         assert_eq!(events.len(), 1);
6077         match events[0] {
6078                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6079                 _ => panic!("Unexpected event"),
6080         }
6081
6082         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6083         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6084         let events = nodes[0].node.get_and_clear_pending_events();
6085         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6086         assert_eq!(events.len(), 2);
6087         let mut first_failed = false;
6088         for event in events {
6089                 match event {
6090                         Event::PaymentFailed { payment_hash, .. } => {
6091                                 if payment_hash == payment_hash_1 {
6092                                         assert!(!first_failed);
6093                                         first_failed = true;
6094                                 } else {
6095                                         assert_eq!(payment_hash, payment_hash_2);
6096                                 }
6097                         }
6098                         _ => panic!("Unexpected event"),
6099                 }
6100         }
6101 }
6102
6103 #[test]
6104 fn test_failure_delay_dust_htlc_local_commitment() {
6105         do_test_failure_delay_dust_htlc_local_commitment(true);
6106         do_test_failure_delay_dust_htlc_local_commitment(false);
6107 }
6108
6109 #[test]
6110 fn test_no_failure_dust_htlc_local_commitment() {
6111         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6112         // prone to error, we test here that a dummy transaction don't fail them.
6113
6114         let node_cfgs = create_node_cfgs(2);
6115         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6116         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6117         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6118
6119         // Rebalance a bit
6120         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6121
6122         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6123         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6124
6125         // We route 2 dust-HTLCs between A and B
6126         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6127         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6128
6129         // Build a dummy invalid transaction trying to spend a commitment tx
6130         let input = TxIn {
6131                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6132                 script_sig: Script::new(),
6133                 sequence: 0,
6134                 witness: Vec::new(),
6135         };
6136
6137         let outp = TxOut {
6138                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6139                 value: 10000,
6140         };
6141
6142         let dummy_tx = Transaction {
6143                 version: 2,
6144                 lock_time: 0,
6145                 input: vec![input],
6146                 output: vec![outp]
6147         };
6148
6149         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6150         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6151         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6152         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6153         // We broadcast a few more block to check everything is all right
6154         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6155         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6156         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6157
6158         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6159         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6160 }
6161
6162 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6163         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6164         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6165         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6166         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6167         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6168         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6169
6170         let node_cfgs = create_node_cfgs(3);
6171         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6172         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6173         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6174
6175         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6176
6177         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6178         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6179
6180         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();
6181         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();
6182
6183         // We revoked bs_commitment_tx
6184         if revoked {
6185                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6186                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6187         }
6188
6189         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6190         let mut timeout_tx = Vec::new();
6191         if local {
6192                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6193                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6194                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6195                 assert_eq!(events.len(), 1);
6196                 match events[0] {
6197                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6198                         _ => panic!("Unexpected event"),
6199                 }
6200                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6201                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6202                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6203                 let events = nodes[0].node.get_and_clear_pending_events();
6204                 assert_eq!(events.len(), 1);
6205                 match events[0] {
6206                         Event::PaymentFailed { payment_hash, .. } => {
6207                                 assert_eq!(payment_hash, dust_hash);
6208                         },
6209                         _ => panic!("Unexpected event"),
6210                 }
6211                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6212                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6213                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6214                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6215                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6216                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6217                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6218                 let events = nodes[0].node.get_and_clear_pending_events();
6219                 assert_eq!(events.len(), 1);
6220                 match events[0] {
6221                         Event::PaymentFailed { payment_hash, .. } => {
6222                                 assert_eq!(payment_hash, non_dust_hash);
6223                         },
6224                         _ => panic!("Unexpected event"),
6225                 }
6226         } else {
6227                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6228                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6229                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6230                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6231                 assert_eq!(events.len(), 1);
6232                 match events[0] {
6233                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6234                         _ => panic!("Unexpected event"),
6235                 }
6236                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6237                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6238                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6239                 if !revoked {
6240                         let events = nodes[0].node.get_and_clear_pending_events();
6241                         assert_eq!(events.len(), 1);
6242                         match events[0] {
6243                                 Event::PaymentFailed { payment_hash, .. } => {
6244                                         assert_eq!(payment_hash, dust_hash);
6245                                 },
6246                                 _ => panic!("Unexpected event"),
6247                         }
6248                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6249                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6250                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6251                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6252                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6253                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6254                         let events = nodes[0].node.get_and_clear_pending_events();
6255                         assert_eq!(events.len(), 1);
6256                         match events[0] {
6257                                 Event::PaymentFailed { payment_hash, .. } => {
6258                                         assert_eq!(payment_hash, non_dust_hash);
6259                                 },
6260                                 _ => panic!("Unexpected event"),
6261                         }
6262                 } else {
6263                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6264                         // commitment tx
6265                         let events = nodes[0].node.get_and_clear_pending_events();
6266                         assert_eq!(events.len(), 2);
6267                         let first;
6268                         match events[0] {
6269                                 Event::PaymentFailed { payment_hash, .. } => {
6270                                         if payment_hash == dust_hash { first = true; }
6271                                         else { first = false; }
6272                                 },
6273                                 _ => panic!("Unexpected event"),
6274                         }
6275                         match events[1] {
6276                                 Event::PaymentFailed { payment_hash, .. } => {
6277                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6278                                         else { assert_eq!(payment_hash, dust_hash); }
6279                                 },
6280                                 _ => panic!("Unexpected event"),
6281                         }
6282                 }
6283         }
6284 }
6285
6286 #[test]
6287 fn test_sweep_outbound_htlc_failure_update() {
6288         do_test_sweep_outbound_htlc_failure_update(false, true);
6289         do_test_sweep_outbound_htlc_failure_update(false, false);
6290         do_test_sweep_outbound_htlc_failure_update(true, false);
6291 }
6292
6293 #[test]
6294 fn test_upfront_shutdown_script() {
6295         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6296         // enforce it at shutdown message
6297
6298         let mut config = UserConfig::default();
6299         config.channel_options.announced_channel = true;
6300         config.peer_channel_config_limits.force_announced_channel_preference = false;
6301         config.channel_options.commit_upfront_shutdown_pubkey = false;
6302         let user_cfgs = [None, Some(config), None];
6303         let node_cfgs = create_node_cfgs(3);
6304         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6305         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6306
6307         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6308         let flags = InitFeatures::supported();
6309         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6310         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6311         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6312         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6313         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6314         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6315         let events = nodes[2].node.get_and_clear_pending_msg_events();
6316         assert_eq!(events.len(), 2);
6317         match events[0] {
6318                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6319                 _ => panic!("Unexpected event"),
6320         }
6321         if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6322                 match action {
6323                         &ErrorAction::SendErrorMessage { ref msg } => {
6324                                 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6325                         },
6326                         _ => { assert!(false); }
6327                 }
6328         } else { assert!(false); }
6329
6330         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6331         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6332         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6333         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6334         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6335         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6336         let events = nodes[2].node.get_and_clear_pending_msg_events();
6337         assert_eq!(events.len(), 1);
6338         match events[0] {
6339                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6340                 _ => panic!("Unexpected event"),
6341         }
6342
6343         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6344         let mut flags_no = InitFeatures::supported();
6345         flags_no.unset_upfront_shutdown_script();
6346         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6347         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6348         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6349         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6350         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6351         let events = nodes[1].node.get_and_clear_pending_msg_events();
6352         assert_eq!(events.len(), 1);
6353         match events[0] {
6354                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6355                 _ => panic!("Unexpected event"),
6356         }
6357
6358         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6359         // channel smoothly, opt-out is from channel initiator here
6360         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6361         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6362         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6363         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6364         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6365         let events = nodes[0].node.get_and_clear_pending_msg_events();
6366         assert_eq!(events.len(), 1);
6367         match events[0] {
6368                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6369                 _ => panic!("Unexpected event"),
6370         }
6371
6372         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6373         //// channel smoothly
6374         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6375         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6376         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6377         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6378         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6379         let events = nodes[0].node.get_and_clear_pending_msg_events();
6380         assert_eq!(events.len(), 2);
6381         match events[0] {
6382                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6383                 _ => panic!("Unexpected event"),
6384         }
6385         match events[1] {
6386                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6387                 _ => panic!("Unexpected event"),
6388         }
6389 }
6390
6391 #[test]
6392 fn test_user_configurable_csv_delay() {
6393         // We test our channel constructors yield errors when we pass them absurd csv delay
6394
6395         let mut low_our_to_self_config = UserConfig::default();
6396         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6397         let mut high_their_to_self_config = UserConfig::default();
6398         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6399         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6400         let node_cfgs = create_node_cfgs(2);
6401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6402         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6403
6404         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6405         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())));
6406         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) {
6407                 match error {
6408                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6409                         _ => panic!("Unexpected event"),
6410                 }
6411         } else { assert!(false) }
6412
6413         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6414         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6415         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6416         open_channel.to_self_delay = 200;
6417         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) {
6418                 match error {
6419                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6420                         _ => panic!("Unexpected event"),
6421                 }
6422         } else { assert!(false); }
6423
6424         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6425         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6426         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()));
6427         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6428         accept_channel.to_self_delay = 200;
6429         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6430         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6431                 match action {
6432                         &ErrorAction::SendErrorMessage { ref msg } => {
6433                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6434                         },
6435                         _ => { assert!(false); }
6436                 }
6437         } else { assert!(false); }
6438
6439         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6440         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6441         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6442         open_channel.to_self_delay = 200;
6443         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) {
6444                 match error {
6445                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6446                         _ => panic!("Unexpected event"),
6447                 }
6448         } else { assert!(false); }
6449 }
6450
6451 #[test]
6452 fn test_data_loss_protect() {
6453         // We want to be sure that :
6454         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6455         // * we close channel in case of detecting other being fallen behind
6456         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6457         let monitor;
6458         let node_state_0;
6459         let node_cfgs = create_node_cfgs(2);
6460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6461         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6462
6463         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6464
6465         // Cache node A state before any channel update
6466         let previous_node_state = nodes[0].node.encode();
6467         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6468         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6469
6470         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6471         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6472
6473         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6474         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6475
6476         // Restore node A from previous state
6477         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6478         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6479         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6480         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())});
6481         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6482         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone());
6483         node_state_0 = {
6484                 let mut channel_monitors = HashMap::new();
6485                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6486                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6487                         keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6488                         fee_estimator: feeest.clone(),
6489                         monitor: &monitor,
6490                         logger: Arc::clone(&logger),
6491                         tx_broadcaster,
6492                         default_config: UserConfig::default(),
6493                         channel_monitors: &mut channel_monitors,
6494                 }).unwrap().1
6495         };
6496         nodes[0].node = &node_state_0;
6497         assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6498         nodes[0].chan_monitor = &monitor;
6499         nodes[0].chain_monitor = chain_monitor;
6500
6501         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6502         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6503         nodes[0].block_notifier.register_listener(nodes[0].node);
6504
6505         check_added_monitors!(nodes[0], 1);
6506
6507         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6508         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6509
6510         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6511
6512         // Check we update monitor following learning of per_commitment_point from B
6513         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6514         check_added_monitors!(nodes[0], 1);
6515
6516         {
6517                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6518                 assert_eq!(node_txn.len(), 0);
6519         }
6520
6521         let mut reestablish_1 = Vec::with_capacity(1);
6522         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6523                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6524                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6525                         reestablish_1.push(msg.clone());
6526                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6527                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6528                         match action {
6529                                 &ErrorAction::SendErrorMessage { ref msg } => {
6530                                         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");
6531                                 },
6532                                 _ => panic!("Unexpected event!"),
6533                         }
6534                 } else {
6535                         panic!("Unexpected event")
6536                 }
6537         }
6538
6539         // Check we close channel detecting A is fallen-behind
6540         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6541         let events = nodes[1].node.get_and_clear_pending_msg_events();
6542         assert_eq!(events.len(), 2);
6543         match events[0] {
6544                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6545                 _ => panic!("Unexpected event"),
6546         }
6547         match events [1] {
6548                 MessageSendEvent::HandleError { ref action, .. } => {
6549                         match action {
6550                                 &ErrorAction::SendErrorMessage { ref msg } => {
6551                                         assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6552                                 _ => panic!("Unexpected event!"),
6553                         }
6554                 },
6555                 _ => panic!("Unexpected event"),
6556         }
6557
6558         // Check A is able to claim to_remote output
6559         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6560         assert_eq!(node_txn.len(), 1);
6561         check_spends!(node_txn[0], chan.3.clone());
6562         assert_eq!(node_txn[0].output.len(), 2);
6563         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6564         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6565         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6566         assert_eq!(spend_txn.len(), 1);
6567         check_spends!(spend_txn[0], node_txn[0].clone());
6568 }
6569
6570 #[test]
6571 fn test_check_htlc_underpaying() {
6572         // Send payment through A -> B but A is maliciously
6573         // sending a probe payment (i.e less than expected value0
6574         // to B, B should refuse payment.
6575
6576         let node_cfgs = create_node_cfgs(2);
6577         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6578         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6579
6580         // Create some initial channels
6581         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6582
6583         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6584
6585         // Node 3 is expecting payment of 100_000 but receive 10_000,
6586         // fail htlc like we didn't know the preimage.
6587         nodes[1].node.claim_funds(payment_preimage, 100_000);
6588         nodes[1].node.process_pending_htlc_forwards();
6589
6590         let events = nodes[1].node.get_and_clear_pending_msg_events();
6591         assert_eq!(events.len(), 1);
6592         let (update_fail_htlc, commitment_signed) = match events[0] {
6593                 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 } } => {
6594                         assert!(update_add_htlcs.is_empty());
6595                         assert!(update_fulfill_htlcs.is_empty());
6596                         assert_eq!(update_fail_htlcs.len(), 1);
6597                         assert!(update_fail_malformed_htlcs.is_empty());
6598                         assert!(update_fee.is_none());
6599                         (update_fail_htlcs[0].clone(), commitment_signed)
6600                 },
6601                 _ => panic!("Unexpected event"),
6602         };
6603         check_added_monitors!(nodes[1], 1);
6604
6605         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6606         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6607
6608         let events = nodes[0].node.get_and_clear_pending_events();
6609         assert_eq!(events.len(), 1);
6610         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6611                 assert_eq!(*rejected_by_dest, true);
6612                 assert_eq!(error_code.unwrap(), 0x4000|15);
6613         } else {
6614                 panic!("Unexpected event");
6615         }
6616         nodes[1].node.get_and_clear_pending_events();
6617 }
6618
6619 #[test]
6620 fn test_announce_disable_channels() {
6621         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6622         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6623
6624         let node_cfgs = create_node_cfgs(2);
6625         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6626         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6627
6628         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6629         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6630         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6631
6632         // Disconnect peers
6633         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6634         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6635
6636         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6637         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6638         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6639         assert_eq!(msg_events.len(), 3);
6640         for e in msg_events {
6641                 match e {
6642                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6643                                 let short_id = msg.contents.short_channel_id;
6644                                 // Check generated channel_update match list in PendingChannelUpdate
6645                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6646                                         panic!("Generated ChannelUpdate for wrong chan!");
6647                                 }
6648                         },
6649                         _ => panic!("Unexpected event"),
6650                 }
6651         }
6652         // Reconnect peers
6653         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6654         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6655         assert_eq!(reestablish_1.len(), 3);
6656         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6657         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6658         assert_eq!(reestablish_2.len(), 3);
6659
6660         // Reestablish chan_1
6661         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6662         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6663         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6664         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6665         // Reestablish chan_2
6666         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6667         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6668         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6669         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6670         // Reestablish chan_3
6671         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6672         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6673         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6674         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6675
6676         nodes[0].node.timer_chan_freshness_every_min();
6677         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6678 }
6679
6680 #[test]
6681 fn test_bump_penalty_txn_on_revoked_commitment() {
6682         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6683         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6684
6685         let node_cfgs = create_node_cfgs(2);
6686         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6687         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6688
6689         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6690         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6691         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6692         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6693
6694         let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6695         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6696         assert_eq!(revoked_txn[0].output.len(), 4);
6697         assert_eq!(revoked_txn[0].input.len(), 1);
6698         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6699         let revoked_txid = revoked_txn[0].txid();
6700
6701         let mut penalty_sum = 0;
6702         for outp in revoked_txn[0].output.iter() {
6703                 if outp.script_pubkey.is_v0_p2wsh() {
6704                         penalty_sum += outp.value;
6705                 }
6706         }
6707
6708         // Connect blocks to change height_timer range to see if we use right soonest_timelock
6709         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6710
6711         // Actually revoke tx by claiming a HTLC
6712         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6713         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6714         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6715
6716         // One or more justice tx should have been broadcast, check it
6717         let penalty_1;
6718         let feerate_1;
6719         {
6720                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6721                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6722                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6723                 assert_eq!(node_txn[0].output.len(), 1);
6724                 check_spends!(node_txn[0], revoked_txn[0].clone());
6725                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6726                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6727                 penalty_1 = node_txn[0].txid();
6728                 node_txn.clear();
6729         };
6730
6731         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6732         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
6733         let mut penalty_2 = penalty_1;
6734         let mut feerate_2 = 0;
6735         {
6736                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6737                 assert_eq!(node_txn.len(), 1);
6738                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6739                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6740                         assert_eq!(node_txn[0].output.len(), 1);
6741                         check_spends!(node_txn[0], revoked_txn[0].clone());
6742                         penalty_2 = node_txn[0].txid();
6743                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6744                         assert_ne!(penalty_2, penalty_1);
6745                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
6746                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6747                         // Verify 25% bump heuristic
6748                         assert!(feerate_2 * 100 >= feerate_1 * 125);
6749                         node_txn.clear();
6750                 }
6751         }
6752         assert_ne!(feerate_2, 0);
6753
6754         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6755         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6756         let penalty_3;
6757         let mut feerate_3 = 0;
6758         {
6759                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6760                 assert_eq!(node_txn.len(), 1);
6761                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6762                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6763                         assert_eq!(node_txn[0].output.len(), 1);
6764                         check_spends!(node_txn[0], revoked_txn[0].clone());
6765                         penalty_3 = node_txn[0].txid();
6766                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6767                         assert_ne!(penalty_3, penalty_2);
6768                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
6769                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6770                         // Verify 25% bump heuristic
6771                         assert!(feerate_3 * 100 >= feerate_2 * 125);
6772                         node_txn.clear();
6773                 }
6774         }
6775         assert_ne!(feerate_3, 0);
6776
6777         nodes[1].node.get_and_clear_pending_events();
6778         nodes[1].node.get_and_clear_pending_msg_events();
6779 }
6780
6781 #[test]
6782 fn test_bump_penalty_txn_on_revoked_htlcs() {
6783         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6784         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6785
6786         let node_cfgs = create_node_cfgs(2);
6787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6788         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6789
6790         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6791         // Lock HTLC in both directions
6792         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6793         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6794
6795         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();
6796         assert_eq!(revoked_local_txn[0].input.len(), 1);
6797         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6798
6799         // Revoke local commitment tx
6800         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6801
6802         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6803         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6804         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6805         check_closed_broadcast!(nodes[1], false);
6806
6807         let mut received = ::std::usize::MAX;
6808         let mut offered = ::std::usize::MAX;
6809         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6810         assert_eq!(revoked_htlc_txn.len(), 6);
6811         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6812                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6813                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6814                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6815                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6816                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6817                 received = 0;
6818                 offered = 1;
6819         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6820                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6821                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6822                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6823                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6824                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6825                 received = 1;
6826                 offered = 0;
6827         }
6828
6829         // Broadcast set of revoked txn on A
6830         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  true, header.bitcoin_hash());
6831         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6832         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);
6833         let first;
6834         let second;
6835         let feerate_1;
6836         let feerate_2;
6837         {
6838                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6839                 assert_eq!(node_txn.len(), 6); // 3 penalty txn on revoked commitment tx + A commitment tx + 2 penalty tnx on revoked HTLC txn
6840                 // Verify claim tx are spending revoked HTLC txn
6841                 assert_eq!(node_txn[4].input.len(), 1);
6842                 assert_eq!(node_txn[4].output.len(), 1);
6843                 check_spends!(node_txn[4], revoked_htlc_txn[0].clone());
6844                 first = node_txn[4].txid();
6845                 assert_eq!(node_txn[5].input.len(), 1);
6846                 assert_eq!(node_txn[5].output.len(), 1);
6847                 check_spends!(node_txn[5], revoked_htlc_txn[1].clone());
6848                 second = node_txn[5].txid();
6849                 // Store both feerates for later comparison
6850                 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[4].output[0].value;
6851                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
6852                 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[5].output[0].value;
6853                 feerate_2 = fee_2 * 1000 / node_txn[5].get_weight() as u64;
6854                 node_txn.clear();
6855         }
6856
6857         // Connect three more block to see if bumped penalty are issued for HTLC txn
6858         let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6859         let penalty_local_tx;
6860         {
6861                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6862                 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
6863
6864                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6865                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6866
6867                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6868
6869                 penalty_local_tx = node_txn[2].clone();
6870                 node_txn.clear();
6871         };
6872         // Few more blocks to broadcast and confirm penalty_local_tx
6873         let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6874         nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6875         let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6876         {
6877                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6878                 assert_eq!(node_txn.len(), 1);
6879                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6880                 node_txn.clear();
6881         }
6882         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6883         let node_txn = {
6884                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6885                 assert_eq!(node_txn.len(), 2);
6886
6887                 let mut penalty_offered = ::std::usize::MAX;
6888                 let mut penalty_received = ::std::usize::MAX;
6889
6890                 {
6891                         for (i, tx) in node_txn.iter().enumerate() {
6892                                 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6893                                         penalty_offered = i;
6894                                 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6895                                         penalty_received = i;
6896                                 }
6897                         }
6898                 }
6899
6900                 assert_eq!(node_txn[penalty_received].input.len(), 1);
6901                 assert_eq!(node_txn[penalty_received].output.len(), 1);
6902                 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6903                 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6904                 // Verify bumped tx is different and 25% bump heuristic
6905                 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6906                 assert_ne!(first, node_txn[penalty_offered].txid());
6907                 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6908                 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6909                 assert!(new_feerate * 100 > feerate_1 * 125);
6910
6911                 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6912                 assert_ne!(second, node_txn[penalty_received].txid());
6913                 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6914                 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6915                 assert!(new_feerate * 100 > feerate_2 * 125);
6916                 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
6917                 node_txn.clear();
6918                 txn
6919         };
6920         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6921         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6922         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
6923         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
6924         {
6925                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6926                 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
6927                 node_txn.clear();
6928         }
6929         check_closed_broadcast!(nodes[0], false);
6930 }
6931
6932 #[test]
6933 fn test_bump_penalty_txn_on_remote_commitment() {
6934         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6935         // we're able to claim outputs on remote commitment transaction before timelocks expiration
6936
6937         // Create 2 HTLCs
6938         // Provide preimage for one
6939         // Check aggregation
6940
6941         let node_cfgs = create_node_cfgs(2);
6942         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6943         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6944
6945         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6946         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6947         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6948
6949         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6950         let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6951         assert_eq!(remote_txn[0].output.len(), 4);
6952         assert_eq!(remote_txn[0].input.len(), 1);
6953         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6954
6955         // Claim a HTLC without revocation (provide B monitor with preimage)
6956         nodes[1].node.claim_funds(payment_preimage, 3_000_000);
6957         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6958         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6959         check_added_monitors!(nodes[1], 1);
6960
6961         // One or more claim tx should have been broadcast, check it
6962         let timeout;
6963         let preimage;
6964         let feerate_timeout;
6965         let feerate_preimage;
6966         {
6967                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6968                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
6969                 assert_eq!(node_txn[0].input.len(), 1);
6970                 assert_eq!(node_txn[1].input.len(), 1);
6971                 check_spends!(node_txn[0], remote_txn[0].clone());
6972                 check_spends!(node_txn[1], remote_txn[0].clone());
6973                 check_spends!(node_txn[2], chan.3);
6974                 check_spends!(node_txn[3], node_txn[2]);
6975                 check_spends!(node_txn[4], node_txn[2]);
6976                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6977                         timeout = node_txn[0].txid();
6978                         let index = node_txn[0].input[0].previous_output.vout;
6979                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6980                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6981
6982                         preimage = node_txn[1].txid();
6983                         let index = node_txn[1].input[0].previous_output.vout;
6984                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6985                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6986                 } else {
6987                         timeout = node_txn[1].txid();
6988                         let index = node_txn[1].input[0].previous_output.vout;
6989                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6990                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6991
6992                         preimage = node_txn[0].txid();
6993                         let index = node_txn[0].input[0].previous_output.vout;
6994                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6995                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6996                 }
6997                 node_txn.clear();
6998         };
6999         assert_ne!(feerate_timeout, 0);
7000         assert_ne!(feerate_preimage, 0);
7001
7002         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7003         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7004         {
7005                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7006                 assert_eq!(node_txn.len(), 2);
7007                 assert_eq!(node_txn[0].input.len(), 1);
7008                 assert_eq!(node_txn[1].input.len(), 1);
7009                 check_spends!(node_txn[0], remote_txn[0].clone());
7010                 check_spends!(node_txn[1], remote_txn[0].clone());
7011                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7012                         let index = node_txn[0].input[0].previous_output.vout;
7013                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7014                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7015                         assert!(new_feerate * 100 > feerate_timeout * 125);
7016                         assert_ne!(timeout, node_txn[0].txid());
7017
7018                         let index = node_txn[1].input[0].previous_output.vout;
7019                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7020                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7021                         assert!(new_feerate * 100 > feerate_preimage * 125);
7022                         assert_ne!(preimage, node_txn[1].txid());
7023                 } else {
7024                         let index = node_txn[1].input[0].previous_output.vout;
7025                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7026                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7027                         assert!(new_feerate * 100 > feerate_timeout * 125);
7028                         assert_ne!(timeout, node_txn[1].txid());
7029
7030                         let index = node_txn[0].input[0].previous_output.vout;
7031                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7032                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7033                         assert!(new_feerate * 100 > feerate_preimage * 125);
7034                         assert_ne!(preimage, node_txn[0].txid());
7035                 }
7036                 node_txn.clear();
7037         }
7038
7039         nodes[1].node.get_and_clear_pending_events();
7040         nodes[1].node.get_and_clear_pending_msg_events();
7041 }
7042
7043 #[test]
7044 fn test_set_outpoints_partial_claiming() {
7045         // - remote party claim tx, new bump tx
7046         // - disconnect remote claiming tx, new bump
7047         // - disconnect tx, see no tx anymore
7048         let node_cfgs = create_node_cfgs(2);
7049         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7050         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7051
7052         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7053         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7054         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7055
7056         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7057         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7058         assert_eq!(remote_txn.len(), 3);
7059         assert_eq!(remote_txn[0].output.len(), 4);
7060         assert_eq!(remote_txn[0].input.len(), 1);
7061         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7062         check_spends!(remote_txn[1], remote_txn[0].clone());
7063         check_spends!(remote_txn[2], remote_txn[0].clone());
7064
7065         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7066         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7067         // Provide node A with both preimage
7068         nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
7069         nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
7070         check_added_monitors!(nodes[0], 2);
7071         nodes[0].node.get_and_clear_pending_events();
7072         nodes[0].node.get_and_clear_pending_msg_events();
7073
7074         // Connect blocks on node A commitment transaction
7075         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7076         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7077         // Verify node A broadcast tx claiming both HTLCs
7078         {
7079                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7080                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7081                 assert_eq!(node_txn.len(), 4);
7082                 check_spends!(node_txn[0], remote_txn[0].clone());
7083                 check_spends!(node_txn[1], chan.3.clone());
7084                 check_spends!(node_txn[2], node_txn[1]);
7085                 check_spends!(node_txn[3], node_txn[1]);
7086                 assert_eq!(node_txn[0].input.len(), 2);
7087                 node_txn.clear();
7088         }
7089         nodes[0].node.get_and_clear_pending_msg_events();
7090
7091         // Connect blocks on node B
7092         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7093         // Verify node B broadcast 2 HTLC-timeout txn
7094         let partial_claim_tx = {
7095                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7096                 assert_eq!(node_txn.len(), 3);
7097                 check_spends!(node_txn[1], node_txn[0].clone());
7098                 check_spends!(node_txn[2], node_txn[0].clone());
7099                 assert_eq!(node_txn[1].input.len(), 1);
7100                 assert_eq!(node_txn[2].input.len(), 1);
7101                 node_txn[1].clone()
7102         };
7103         nodes[1].node.get_and_clear_pending_msg_events();
7104
7105         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7106         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7107         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7108         {
7109                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7110                 assert_eq!(node_txn.len(), 1);
7111                 check_spends!(node_txn[0], remote_txn[0].clone());
7112                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7113                 node_txn.clear();
7114         }
7115         nodes[0].node.get_and_clear_pending_msg_events();
7116
7117         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7118         nodes[0].block_notifier.block_disconnected(&header, 102);
7119         {
7120                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7121                 assert_eq!(node_txn.len(), 1);
7122                 check_spends!(node_txn[0], remote_txn[0].clone());
7123                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7124                 node_txn.clear();
7125         }
7126
7127         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7128         nodes[0].block_notifier.block_disconnected(&header, 101);
7129         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7130         {
7131                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7132                 assert_eq!(node_txn.len(), 0);
7133                 node_txn.clear();
7134         }
7135 }
7136
7137 #[test]
7138 fn test_counterparty_raa_skip_no_crash() {
7139         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7140         // commitment transaction, we would have happily carried on and provided them the next
7141         // commitment transaction based on one RAA forward. This would probably eventually have led to
7142         // channel closure, but it would not have resulted in funds loss. Still, our
7143         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7144         // check simply that the channel is closed in response to such an RAA, but don't check whether
7145         // we decide to punish our counterparty for revoking their funds (as we don't currently
7146         // implement that).
7147         let node_cfgs = create_node_cfgs(2);
7148         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7149         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7150         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7151
7152         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7153         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7154         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7155                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7156         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7157
7158         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7159                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7160         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7161 }
7162
7163 #[test]
7164 fn test_bump_txn_sanitize_tracking_maps() {
7165         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7166         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7167
7168         let node_cfgs = create_node_cfgs(2);
7169         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7170         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7171
7172         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7173         // Lock HTLC in both directions
7174         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7175         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7176
7177         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();
7178         assert_eq!(revoked_local_txn[0].input.len(), 1);
7179         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7180
7181         // Revoke local commitment tx
7182         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7183
7184         // Broadcast set of revoked txn on A
7185         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7186         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7187         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7188         check_closed_broadcast!(nodes[0], false);
7189         let penalty_txn = {
7190                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7191                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7192                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7193                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7194                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7195                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7196                 node_txn.clear();
7197                 penalty_txn
7198         };
7199         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7200         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7201         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7202         {
7203                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7204                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7205                         assert!(monitor.pending_claim_requests.is_empty());
7206                         assert!(monitor.claimable_outpoints.is_empty());
7207                 }
7208         }
7209 }