_ 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;
   8 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  12 use ln::channelmonitor;
  13 use ln::channel::{Channel, ChannelError};
  14 use ln::{chan_utils, onion_utils};
  15 use routing::router::{Route, RouteHop, get_route};
  16 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  17 use ln::msgs;
  18 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  19 use util::enforcing_trait_impls::EnforcingChannelKeys;
  20 use util::{byte_utils, test_utils};
  21 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  22 use util::errors::APIError;
  23 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
  24 use util::config::UserConfig;
  25
  26 use bitcoin::util::hash::BitcoinHash;
  27 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  28 use bitcoin::hash_types::{Txid, BlockHash};
  29 use bitcoin::util::bip143;
  30 use bitcoin::util::address::Address;
  31 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  32 use bitcoin::blockdata::block::{Block, BlockHeader};
  33 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  34 use bitcoin::blockdata::script::{Builder, Script};
  35 use bitcoin::blockdata::opcodes;
  36 use bitcoin::blockdata::constants::genesis_block;
  37 use bitcoin::network::constants::Network;
  38
  39 use bitcoin::hashes::sha256::Hash as Sha256;
  40 use bitcoin::hashes::Hash;
  41
  42 use bitcoin::secp256k1::{Secp256k1, Message};
  43 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  44
  45 use std::collections::{BTreeSet, HashMap, HashSet};
  46 use std::default::Default;
  47 use std::sync::{Arc, Mutex};
  48 use std::sync::atomic::Ordering;
  49 use std::{mem, io};
  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 chanmon_cfgs = create_chanmon_cfgs(2);
  57         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  58         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  59         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  60
  61         // Instantiate channel parameters where we push the maximum msats given our
  62         // funding satoshis
  63         let channel_value_sat = 31337; // same as funding satoshis
  64         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
  65         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  66
  67         // Have node0 initiate a channel to node1 with aforementioned parameters
  68         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  69
  70         // Extract the channel open message from node0 to node1
  71         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  72
  73         // Test helper that asserts we get the correct error string given a mutator
  74         // that supposedly makes the channel open message insane
  75         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  76                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  77                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  78                 assert_eq!(msg_events.len(), 1);
  79                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  80                         match action {
  81                                 &ErrorAction::SendErrorMessage { .. } => {
  82                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  83                                 },
  84                                 _ => panic!("unexpected event!"),
  85                         }
  86                 } else { assert!(false); }
  87         };
  88
  89         use ln::channel::MAX_FUNDING_SATOSHIS;
  90         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  91
  92         // Test all mutations that would make the channel open message insane
  93         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  94
  95         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  96
  97         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  98
  99         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 100
 101         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 102
 103         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 });
 104
 105         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 });
 106
 107         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 108
 109         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 110 }
 111
 112 #[test]
 113 fn test_async_inbound_update_fee() {
 114         let chanmon_cfgs = create_chanmon_cfgs(2);
 115         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 116         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 117         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 118         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 119         let logger = test_utils::TestLogger::new();
 120         let channel_id = chan.2;
 121
 122         // balancing
 123         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 124
 125         // A                                        B
 126         // update_fee                            ->
 127         // send (1) commitment_signed            -.
 128         //                                       <- update_add_htlc/commitment_signed
 129         // send (2) RAA (awaiting remote revoke) -.
 130         // (1) commitment_signed is delivered    ->
 131         //                                       .- send (3) RAA (awaiting remote revoke)
 132         // (2) RAA is delivered                  ->
 133         //                                       .- send (4) commitment_signed
 134         //                                       <- (3) RAA is delivered
 135         // send (5) commitment_signed            -.
 136         //                                       <- (4) commitment_signed is delivered
 137         // send (6) RAA                          -.
 138         // (5) commitment_signed is delivered    ->
 139         //                                       <- RAA
 140         // (6) RAA is delivered                  ->
 141
 142         // First nodes[0] generates an update_fee
 143         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 144         check_added_monitors!(nodes[0], 1);
 145
 146         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 147         assert_eq!(events_0.len(), 1);
 148         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 149                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 150                         (update_fee.as_ref(), commitment_signed)
 151                 },
 152                 _ => panic!("Unexpected event"),
 153         };
 154
 155         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 156
 157         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 158         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 159         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 160         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 161         check_added_monitors!(nodes[1], 1);
 162
 163         let payment_event = {
 164                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 165                 assert_eq!(events_1.len(), 1);
 166                 SendEvent::from_event(events_1.remove(0))
 167         };
 168         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 169         assert_eq!(payment_event.msgs.len(), 1);
 170
 171         // ...now when the messages get delivered everyone should be happy
 172         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 173         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 174         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 175         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 176         check_added_monitors!(nodes[0], 1);
 177
 178         // deliver(1), generate (3):
 179         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 180         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 181         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 182         check_added_monitors!(nodes[1], 1);
 183
 184         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 185         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 186         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 187         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 188         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 189         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 190         assert!(bs_update.update_fee.is_none()); // (4)
 191         check_added_monitors!(nodes[1], 1);
 192
 193         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 194         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 195         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 196         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 197         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 198         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 199         assert!(as_update.update_fee.is_none()); // (5)
 200         check_added_monitors!(nodes[0], 1);
 201
 202         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 203         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 204         // only (6) so get_event_msg's assert(len == 1) passes
 205         check_added_monitors!(nodes[0], 1);
 206
 207         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 208         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 209         check_added_monitors!(nodes[1], 1);
 210
 211         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 212         check_added_monitors!(nodes[0], 1);
 213
 214         let events_2 = nodes[0].node.get_and_clear_pending_events();
 215         assert_eq!(events_2.len(), 1);
 216         match events_2[0] {
 217                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 218                 _ => panic!("Unexpected event"),
 219         }
 220
 221         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 222         check_added_monitors!(nodes[1], 1);
 223 }
 224
 225 #[test]
 226 fn test_update_fee_unordered_raa() {
 227         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 228         // crash in an earlier version of the update_fee patch)
 229         let chanmon_cfgs = create_chanmon_cfgs(2);
 230         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 231         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 232         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 233         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 234         let channel_id = chan.2;
 235         let logger = test_utils::TestLogger::new();
 236
 237         // balancing
 238         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 239
 240         // First nodes[0] generates an update_fee
 241         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 242         check_added_monitors!(nodes[0], 1);
 243
 244         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 245         assert_eq!(events_0.len(), 1);
 246         let update_msg = match events_0[0] { // (1)
 247                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 248                         update_fee.as_ref()
 249                 },
 250                 _ => panic!("Unexpected event"),
 251         };
 252
 253         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 254
 255         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 256         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 257         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 258         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 259         check_added_monitors!(nodes[1], 1);
 260
 261         let payment_event = {
 262                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 263                 assert_eq!(events_1.len(), 1);
 264                 SendEvent::from_event(events_1.remove(0))
 265         };
 266         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 267         assert_eq!(payment_event.msgs.len(), 1);
 268
 269         // ...now when the messages get delivered everyone should be happy
 270         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 271         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 272         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 273         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 274         check_added_monitors!(nodes[0], 1);
 275
 276         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 277         check_added_monitors!(nodes[1], 1);
 278
 279         // We can't continue, sadly, because our (1) now has a bogus signature
 280 }
 281
 282 #[test]
 283 fn test_multi_flight_update_fee() {
 284         let chanmon_cfgs = create_chanmon_cfgs(2);
 285         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 286         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 287         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 288         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 289         let channel_id = chan.2;
 290
 291         // A                                        B
 292         // update_fee/commitment_signed          ->
 293         //                                       .- send (1) RAA and (2) commitment_signed
 294         // update_fee (never committed)          ->
 295         // (3) update_fee                        ->
 296         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 297         // don't track which updates correspond to which revoke_and_ack responses so we're in
 298         // AwaitingRAA mode and will not generate the update_fee yet.
 299         //                                       <- (1) RAA delivered
 300         // (3) is generated and send (4) CS      -.
 301         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 302         // know the per_commitment_point to use for it.
 303         //                                       <- (2) commitment_signed delivered
 304         // revoke_and_ack                        ->
 305         //                                          B should send no response here
 306         // (4) commitment_signed delivered       ->
 307         //                                       <- RAA/commitment_signed delivered
 308         // revoke_and_ack                        ->
 309
 310         // First nodes[0] generates an update_fee
 311         let initial_feerate = get_feerate!(nodes[0], channel_id);
 312         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 313         check_added_monitors!(nodes[0], 1);
 314
 315         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 316         assert_eq!(events_0.len(), 1);
 317         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 318                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 319                         (update_fee.as_ref().unwrap(), commitment_signed)
 320                 },
 321                 _ => panic!("Unexpected event"),
 322         };
 323
 324         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 325         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 326         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 327         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 328         check_added_monitors!(nodes[1], 1);
 329
 330         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 331         // transaction:
 332         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 333         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 334         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 335
 336         // Create the (3) update_fee message that nodes[0] will generate before it does...
 337         let mut update_msg_2 = msgs::UpdateFee {
 338                 channel_id: update_msg_1.channel_id.clone(),
 339                 feerate_per_kw: (initial_feerate + 30) as u32,
 340         };
 341
 342         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 343
 344         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 345         // Deliver (3)
 346         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 347
 348         // Deliver (1), generating (3) and (4)
 349         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 350         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 351         check_added_monitors!(nodes[0], 1);
 352         assert!(as_second_update.update_add_htlcs.is_empty());
 353         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 354         assert!(as_second_update.update_fail_htlcs.is_empty());
 355         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 356         // Check that the update_fee newly generated matches what we delivered:
 357         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 358         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 359
 360         // Deliver (2) commitment_signed
 361         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 362         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 363         check_added_monitors!(nodes[0], 1);
 364         // No commitment_signed so get_event_msg's assert(len == 1) passes
 365
 366         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 367         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 368         check_added_monitors!(nodes[1], 1);
 369
 370         // Delever (4)
 371         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 372         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 373         check_added_monitors!(nodes[1], 1);
 374
 375         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 376         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 377         check_added_monitors!(nodes[0], 1);
 378
 379         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 380         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 381         // No commitment_signed so get_event_msg's assert(len == 1) passes
 382         check_added_monitors!(nodes[0], 1);
 383
 384         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 385         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 386         check_added_monitors!(nodes[1], 1);
 387 }
 388
 389 #[test]
 390 fn test_1_conf_open() {
 391         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 392         // tests that we properly send one in that case.
 393         let mut alice_config = UserConfig::default();
 394         alice_config.own_channel_config.minimum_depth = 1;
 395         alice_config.channel_options.announced_channel = true;
 396         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 397         let mut bob_config = UserConfig::default();
 398         bob_config.own_channel_config.minimum_depth = 1;
 399         bob_config.channel_options.announced_channel = true;
 400         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 401         let chanmon_cfgs = create_chanmon_cfgs(2);
 402         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 403         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 404         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 405
 406         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 407         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 408         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 409
 410         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 411         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 412         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()));
 413
 414         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 415         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 416         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 417
 418         for node in nodes {
 419                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 420                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 421                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 422         }
 423 }
 424
 425 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 426         // Previously, we had issues deserializing channels when we hadn't connected the first block
 427         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 428         // serialization round-trips and simply do steps towards opening a channel and then drop the
 429         // Node objects.
 430
 431         let chanmon_cfgs = create_chanmon_cfgs(2);
 432         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 433         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 434         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 435
 436         if steps & 0b1000_0000 != 0{
 437                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 438                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 439                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 440         }
 441
 442         if steps & 0x0f == 0 { return; }
 443         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 444         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 445
 446         if steps & 0x0f == 1 { return; }
 447         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 448         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 449
 450         if steps & 0x0f == 2 { return; }
 451         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 452
 453         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 454
 455         if steps & 0x0f == 3 { return; }
 456         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 457         check_added_monitors!(nodes[0], 0);
 458         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 4 { return; }
 461         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 462         {
 463                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 464                 assert_eq!(added_monitors.len(), 1);
 465                 assert_eq!(added_monitors[0].0, funding_output);
 466                 added_monitors.clear();
 467         }
 468         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 469
 470         if steps & 0x0f == 5 { return; }
 471         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 472         {
 473                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 474                 assert_eq!(added_monitors.len(), 1);
 475                 assert_eq!(added_monitors[0].0, funding_output);
 476                 added_monitors.clear();
 477         }
 478
 479         let events_4 = nodes[0].node.get_and_clear_pending_events();
 480         assert_eq!(events_4.len(), 1);
 481         match events_4[0] {
 482                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 483                         assert_eq!(user_channel_id, 42);
 484                         assert_eq!(*funding_txo, funding_output);
 485                 },
 486                 _ => panic!("Unexpected event"),
 487         };
 488
 489         if steps & 0x0f == 6 { return; }
 490         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 491
 492         if steps & 0x0f == 7 { return; }
 493         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 494         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 495 }
 496
 497 #[test]
 498 fn test_sanity_on_in_flight_opens() {
 499         do_test_sanity_on_in_flight_opens(0);
 500         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 501         do_test_sanity_on_in_flight_opens(1);
 502         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 503         do_test_sanity_on_in_flight_opens(2);
 504         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 505         do_test_sanity_on_in_flight_opens(3);
 506         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 507         do_test_sanity_on_in_flight_opens(4);
 508         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(5);
 510         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(6);
 512         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(7);
 514         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(8);
 516         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 517 }
 518
 519 #[test]
 520 fn test_update_fee_vanilla() {
 521         let chanmon_cfgs = create_chanmon_cfgs(2);
 522         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 523         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 524         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 525         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 526         let channel_id = chan.2;
 527
 528         let feerate = get_feerate!(nodes[0], channel_id);
 529         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 530         check_added_monitors!(nodes[0], 1);
 531
 532         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 533         assert_eq!(events_0.len(), 1);
 534         let (update_msg, commitment_signed) = match events_0[0] {
 535                         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 } } => {
 536                         (update_fee.as_ref(), commitment_signed)
 537                 },
 538                 _ => panic!("Unexpected event"),
 539         };
 540         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 541
 542         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 543         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 544         check_added_monitors!(nodes[1], 1);
 545
 546         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 547         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 548         check_added_monitors!(nodes[0], 1);
 549
 550         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 551         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 552         // No commitment_signed so get_event_msg's assert(len == 1) passes
 553         check_added_monitors!(nodes[0], 1);
 554
 555         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 556         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 557         check_added_monitors!(nodes[1], 1);
 558 }
 559
 560 #[test]
 561 fn test_update_fee_that_funder_cannot_afford() {
 562         let chanmon_cfgs = create_chanmon_cfgs(2);
 563         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 564         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 565         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 566         let channel_value = 1888;
 567         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 568         let channel_id = chan.2;
 569
 570         let feerate = 260;
 571         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 572         check_added_monitors!(nodes[0], 1);
 573         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 574
 575         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 576
 577         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 578
 579         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 580         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 581         {
 582                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 583
 584                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 585                 let num_htlcs = commitment_tx.output.len() - 2;
 586                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 587                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 588                 actual_fee = channel_value - actual_fee;
 589                 assert_eq!(total_fee, actual_fee);
 590         }
 591
 592         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 593         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 594         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 595         check_added_monitors!(nodes[0], 1);
 596
 597         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 598
 599         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 600
 601         //While producing the commitment_signed response after handling a received update_fee request the
 602         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 603         //Should produce and error.
 604         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 605         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 606         check_added_monitors!(nodes[1], 1);
 607         check_closed_broadcast!(nodes[1], true);
 608 }
 609
 610 #[test]
 611 fn test_update_fee_with_fundee_update_add_htlc() {
 612         let chanmon_cfgs = create_chanmon_cfgs(2);
 613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 615         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 616         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 617         let channel_id = chan.2;
 618         let logger = test_utils::TestLogger::new();
 619
 620         // balancing
 621         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 622
 623         let feerate = get_feerate!(nodes[0], channel_id);
 624         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 625         check_added_monitors!(nodes[0], 1);
 626
 627         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 628         assert_eq!(events_0.len(), 1);
 629         let (update_msg, commitment_signed) = match events_0[0] {
 630                         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 } } => {
 631                         (update_fee.as_ref(), commitment_signed)
 632                 },
 633                 _ => panic!("Unexpected event"),
 634         };
 635         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 636         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 637         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 638         check_added_monitors!(nodes[1], 1);
 639
 640         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 641         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 642         let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 643
 644         // nothing happens since node[1] is in AwaitingRemoteRevoke
 645         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 646         {
 647                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 648                 assert_eq!(added_monitors.len(), 0);
 649                 added_monitors.clear();
 650         }
 651         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 652         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 653         // node[1] has nothing to do
 654
 655         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 656         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 657         check_added_monitors!(nodes[0], 1);
 658
 659         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 660         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 661         // No commitment_signed so get_event_msg's assert(len == 1) passes
 662         check_added_monitors!(nodes[0], 1);
 663         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 664         check_added_monitors!(nodes[1], 1);
 665         // AwaitingRemoteRevoke ends here
 666
 667         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 668         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 669         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 670         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 671         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 672         assert_eq!(commitment_update.update_fee.is_none(), true);
 673
 674         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 675         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 676         check_added_monitors!(nodes[0], 1);
 677         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 678
 679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 680         check_added_monitors!(nodes[1], 1);
 681         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 682
 683         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 684         check_added_monitors!(nodes[1], 1);
 685         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 686         // No commitment_signed so get_event_msg's assert(len == 1) passes
 687
 688         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 689         check_added_monitors!(nodes[0], 1);
 690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 691
 692         expect_pending_htlcs_forwardable!(nodes[0]);
 693
 694         let events = nodes[0].node.get_and_clear_pending_events();
 695         assert_eq!(events.len(), 1);
 696         match events[0] {
 697                 Event::PaymentReceived { .. } => { },
 698                 _ => panic!("Unexpected event"),
 699         };
 700
 701         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 702
 703         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 704         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 705         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 706 }
 707
 708 #[test]
 709 fn test_update_fee() {
 710         let chanmon_cfgs = create_chanmon_cfgs(2);
 711         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 712         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 713         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 714         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 715         let channel_id = chan.2;
 716
 717         // A                                        B
 718         // (1) update_fee/commitment_signed      ->
 719         //                                       <- (2) revoke_and_ack
 720         //                                       .- send (3) commitment_signed
 721         // (4) update_fee/commitment_signed      ->
 722         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 723         //                                       <- (3) commitment_signed delivered
 724         // send (6) revoke_and_ack               -.
 725         //                                       <- (5) deliver revoke_and_ack
 726         // (6) deliver revoke_and_ack            ->
 727         //                                       .- send (7) commitment_signed in response to (4)
 728         //                                       <- (7) deliver commitment_signed
 729         // revoke_and_ack                        ->
 730
 731         // Create and deliver (1)...
 732         let feerate = get_feerate!(nodes[0], channel_id);
 733         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 734         check_added_monitors!(nodes[0], 1);
 735
 736         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 737         assert_eq!(events_0.len(), 1);
 738         let (update_msg, commitment_signed) = match events_0[0] {
 739                         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 } } => {
 740                         (update_fee.as_ref(), commitment_signed)
 741                 },
 742                 _ => panic!("Unexpected event"),
 743         };
 744         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 745
 746         // Generate (2) and (3):
 747         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 748         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 749         check_added_monitors!(nodes[1], 1);
 750
 751         // Deliver (2):
 752         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 753         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 754         check_added_monitors!(nodes[0], 1);
 755
 756         // Create and deliver (4)...
 757         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 758         check_added_monitors!(nodes[0], 1);
 759         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 760         assert_eq!(events_0.len(), 1);
 761         let (update_msg, commitment_signed) = match events_0[0] {
 762                         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 } } => {
 763                         (update_fee.as_ref(), commitment_signed)
 764                 },
 765                 _ => panic!("Unexpected event"),
 766         };
 767
 768         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 769         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 770         check_added_monitors!(nodes[1], 1);
 771         // ... creating (5)
 772         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 773         // No commitment_signed so get_event_msg's assert(len == 1) passes
 774
 775         // Handle (3), creating (6):
 776         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 777         check_added_monitors!(nodes[0], 1);
 778         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 779         // No commitment_signed so get_event_msg's assert(len == 1) passes
 780
 781         // Deliver (5):
 782         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 783         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 784         check_added_monitors!(nodes[0], 1);
 785
 786         // Deliver (6), creating (7):
 787         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 788         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 789         assert!(commitment_update.update_add_htlcs.is_empty());
 790         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 791         assert!(commitment_update.update_fail_htlcs.is_empty());
 792         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 793         assert!(commitment_update.update_fee.is_none());
 794         check_added_monitors!(nodes[1], 1);
 795
 796         // Deliver (7)
 797         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 798         check_added_monitors!(nodes[0], 1);
 799         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 800         // No commitment_signed so get_event_msg's assert(len == 1) passes
 801
 802         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 803         check_added_monitors!(nodes[1], 1);
 804         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 805
 806         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 807         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 808         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 809 }
 810
 811 #[test]
 812 fn pre_funding_lock_shutdown_test() {
 813         // Test sending a shutdown prior to funding_locked after funding generation
 814         let chanmon_cfgs = create_chanmon_cfgs(2);
 815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 817         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 818         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 819         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 820         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 821         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 822
 823         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 824         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 825         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 826         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 827         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 828
 829         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 830         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 831         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 832         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 833         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 834         assert!(node_0_none.is_none());
 835
 836         assert!(nodes[0].node.list_channels().is_empty());
 837         assert!(nodes[1].node.list_channels().is_empty());
 838 }
 839
 840 #[test]
 841 fn updates_shutdown_wait() {
 842         // Test sending a shutdown with outstanding updates pending
 843         let chanmon_cfgs = create_chanmon_cfgs(3);
 844         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 845         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 846         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 847         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 848         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 849         let logger = test_utils::TestLogger::new();
 850
 851         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 852
 853         nodes[0].node.close_channel(&chan_1.2).unwrap();
 854         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 855         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 856         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 857         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 858
 859         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 860         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 861
 862         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 863
 864         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 865         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 866         let route_1 = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler0, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 867         let route_2 = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler1, &nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 868         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 869         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 870
 871         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 872         check_added_monitors!(nodes[2], 1);
 873         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 874         assert!(updates.update_add_htlcs.is_empty());
 875         assert!(updates.update_fail_htlcs.is_empty());
 876         assert!(updates.update_fail_malformed_htlcs.is_empty());
 877         assert!(updates.update_fee.is_none());
 878         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 879         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 880         check_added_monitors!(nodes[1], 1);
 881         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 882         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 883
 884         assert!(updates_2.update_add_htlcs.is_empty());
 885         assert!(updates_2.update_fail_htlcs.is_empty());
 886         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 887         assert!(updates_2.update_fee.is_none());
 888         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 889         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 890         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 891
 892         let events = nodes[0].node.get_and_clear_pending_events();
 893         assert_eq!(events.len(), 1);
 894         match events[0] {
 895                 Event::PaymentSent { ref payment_preimage } => {
 896                         assert_eq!(our_payment_preimage, *payment_preimage);
 897                 },
 898                 _ => panic!("Unexpected event"),
 899         }
 900
 901         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 902         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 903         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 904         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 905         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 906         assert!(node_0_none.is_none());
 907
 908         assert!(nodes[0].node.list_channels().is_empty());
 909
 910         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 911         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 912         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 913         assert!(nodes[1].node.list_channels().is_empty());
 914         assert!(nodes[2].node.list_channels().is_empty());
 915 }
 916
 917 #[test]
 918 fn htlc_fail_async_shutdown() {
 919         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 920         let chanmon_cfgs = create_chanmon_cfgs(3);
 921         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 922         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 923         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 924         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 925         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 926         let logger = test_utils::TestLogger::new();
 927
 928         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 929         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 930         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 931         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 932         check_added_monitors!(nodes[0], 1);
 933         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 934         assert_eq!(updates.update_add_htlcs.len(), 1);
 935         assert!(updates.update_fulfill_htlcs.is_empty());
 936         assert!(updates.update_fail_htlcs.is_empty());
 937         assert!(updates.update_fail_malformed_htlcs.is_empty());
 938         assert!(updates.update_fee.is_none());
 939
 940         nodes[1].node.close_channel(&chan_1.2).unwrap();
 941         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 942         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 943         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 944
 945         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 946         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 947         check_added_monitors!(nodes[1], 1);
 948         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 949         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 950
 951         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 952         assert!(updates_2.update_add_htlcs.is_empty());
 953         assert!(updates_2.update_fulfill_htlcs.is_empty());
 954         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 955         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 956         assert!(updates_2.update_fee.is_none());
 957
 958         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 959         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 960
 961         expect_payment_failed!(nodes[0], our_payment_hash, false);
 962
 963         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 964         assert_eq!(msg_events.len(), 2);
 965         let node_0_closing_signed = match msg_events[0] {
 966                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 967                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 968                         (*msg).clone()
 969                 },
 970                 _ => panic!("Unexpected event"),
 971         };
 972         match msg_events[1] {
 973                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 974                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 975                 },
 976                 _ => panic!("Unexpected event"),
 977         }
 978
 979         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 980         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 981         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 982         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 983         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 984         assert!(node_0_none.is_none());
 985
 986         assert!(nodes[0].node.list_channels().is_empty());
 987
 988         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 989         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 990         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 991         assert!(nodes[1].node.list_channels().is_empty());
 992         assert!(nodes[2].node.list_channels().is_empty());
 993 }
 994
 995 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 996         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 997         // messages delivered prior to disconnect
 998         let chanmon_cfgs = create_chanmon_cfgs(3);
 999         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1000         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1001         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1002         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1003         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1004
1005         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1006
1007         nodes[1].node.close_channel(&chan_1.2).unwrap();
1008         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1009         if recv_count > 0 {
1010                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1011                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1012                 if recv_count > 1 {
1013                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1014                 }
1015         }
1016
1017         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1018         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1019
1020         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1021         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1022         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1023         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1024
1025         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1026         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1027         assert!(node_1_shutdown == node_1_2nd_shutdown);
1028
1029         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1030         let node_0_2nd_shutdown = if recv_count > 0 {
1031                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1032                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1033                 node_0_2nd_shutdown
1034         } else {
1035                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1036                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1037                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1038         };
1039         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1040
1041         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1043
1044         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1045         check_added_monitors!(nodes[2], 1);
1046         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1047         assert!(updates.update_add_htlcs.is_empty());
1048         assert!(updates.update_fail_htlcs.is_empty());
1049         assert!(updates.update_fail_malformed_htlcs.is_empty());
1050         assert!(updates.update_fee.is_none());
1051         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1052         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1053         check_added_monitors!(nodes[1], 1);
1054         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1055         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1056
1057         assert!(updates_2.update_add_htlcs.is_empty());
1058         assert!(updates_2.update_fail_htlcs.is_empty());
1059         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1060         assert!(updates_2.update_fee.is_none());
1061         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1062         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1063         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1064
1065         let events = nodes[0].node.get_and_clear_pending_events();
1066         assert_eq!(events.len(), 1);
1067         match events[0] {
1068                 Event::PaymentSent { ref payment_preimage } => {
1069                         assert_eq!(our_payment_preimage, *payment_preimage);
1070                 },
1071                 _ => panic!("Unexpected event"),
1072         }
1073
1074         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1075         if recv_count > 0 {
1076                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1077                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1078                 assert!(node_1_closing_signed.is_some());
1079         }
1080
1081         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1082         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1083
1084         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1085         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1086         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1087         if recv_count == 0 {
1088                 // If all closing_signeds weren't delivered we can just resume where we left off...
1089                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1090
1091                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1092                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1093                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1094
1095                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1096                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1097                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1098
1099                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1100                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1101
1102                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1103                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1104                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1105
1106                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1107                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1108                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1109                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1110                 assert!(node_0_none.is_none());
1111         } else {
1112                 // If one node, however, received + responded with an identical closing_signed we end
1113                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1114                 // There isn't really anything better we can do simply, but in the future we might
1115                 // explore storing a set of recently-closed channels that got disconnected during
1116                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1117                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1118                 // transaction.
1119                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1120
1121                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1122                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1123                 assert_eq!(msg_events.len(), 1);
1124                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1125                         match action {
1126                                 &ErrorAction::SendErrorMessage { ref msg } => {
1127                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1128                                         assert_eq!(msg.channel_id, chan_1.2);
1129                                 },
1130                                 _ => panic!("Unexpected event!"),
1131                         }
1132                 } else { panic!("Needed SendErrorMessage close"); }
1133
1134                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1135                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1136                 // closing_signed so we do it ourselves
1137                 check_closed_broadcast!(nodes[0], false);
1138                 check_added_monitors!(nodes[0], 1);
1139         }
1140
1141         assert!(nodes[0].node.list_channels().is_empty());
1142
1143         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1144         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1145         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1146         assert!(nodes[1].node.list_channels().is_empty());
1147         assert!(nodes[2].node.list_channels().is_empty());
1148 }
1149
1150 #[test]
1151 fn test_shutdown_rebroadcast() {
1152         do_test_shutdown_rebroadcast(0);
1153         do_test_shutdown_rebroadcast(1);
1154         do_test_shutdown_rebroadcast(2);
1155 }
1156
1157 #[test]
1158 fn fake_network_test() {
1159         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1160         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1161         let chanmon_cfgs = create_chanmon_cfgs(4);
1162         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1163         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1164         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1165
1166         // Create some initial channels
1167         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1168         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1169         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1170
1171         // Rebalance the network a bit by relaying one payment through all the channels...
1172         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1173         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1174         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1175         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1176
1177         // Send some more payments
1178         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1179         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1180         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1181
1182         // Test failure packets
1183         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1184         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1185
1186         // Add a new channel that skips 3
1187         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1188
1189         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1190         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1191         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1192         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1193         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1194         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1195         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1196
1197         // Do some rebalance loop payments, simultaneously
1198         let mut hops = Vec::with_capacity(3);
1199         hops.push(RouteHop {
1200                 pubkey: nodes[2].node.get_our_node_id(),
1201                 node_features: NodeFeatures::empty(),
1202                 short_channel_id: chan_2.0.contents.short_channel_id,
1203                 channel_features: ChannelFeatures::empty(),
1204                 fee_msat: 0,
1205                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1206         });
1207         hops.push(RouteHop {
1208                 pubkey: nodes[3].node.get_our_node_id(),
1209                 node_features: NodeFeatures::empty(),
1210                 short_channel_id: chan_3.0.contents.short_channel_id,
1211                 channel_features: ChannelFeatures::empty(),
1212                 fee_msat: 0,
1213                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1214         });
1215         hops.push(RouteHop {
1216                 pubkey: nodes[1].node.get_our_node_id(),
1217                 node_features: NodeFeatures::empty(),
1218                 short_channel_id: chan_4.0.contents.short_channel_id,
1219                 channel_features: ChannelFeatures::empty(),
1220                 fee_msat: 1000000,
1221                 cltv_expiry_delta: TEST_FINAL_CLTV,
1222         });
1223         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;
1224         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;
1225         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1226
1227         let mut hops = Vec::with_capacity(3);
1228         hops.push(RouteHop {
1229                 pubkey: nodes[3].node.get_our_node_id(),
1230                 node_features: NodeFeatures::empty(),
1231                 short_channel_id: chan_4.0.contents.short_channel_id,
1232                 channel_features: ChannelFeatures::empty(),
1233                 fee_msat: 0,
1234                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1235         });
1236         hops.push(RouteHop {
1237                 pubkey: nodes[2].node.get_our_node_id(),
1238                 node_features: NodeFeatures::empty(),
1239                 short_channel_id: chan_3.0.contents.short_channel_id,
1240                 channel_features: ChannelFeatures::empty(),
1241                 fee_msat: 0,
1242                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1243         });
1244         hops.push(RouteHop {
1245                 pubkey: nodes[1].node.get_our_node_id(),
1246                 node_features: NodeFeatures::empty(),
1247                 short_channel_id: chan_2.0.contents.short_channel_id,
1248                 channel_features: ChannelFeatures::empty(),
1249                 fee_msat: 1000000,
1250                 cltv_expiry_delta: TEST_FINAL_CLTV,
1251         });
1252         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;
1253         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;
1254         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1255
1256         // Claim the rebalances...
1257         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1258         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1259
1260         // Add a duplicate new channel from 2 to 4
1261         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1262
1263         // Send some payments across both channels
1264         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1265         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1266         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1267
1268
1269         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1270         let events = nodes[0].node.get_and_clear_pending_msg_events();
1271         assert_eq!(events.len(), 0);
1272         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);
1273
1274         //TODO: Test that routes work again here as we've been notified that the channel is full
1275
1276         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1277         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1278         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1279
1280         // Close down the channels...
1281         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1282         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1283         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1284         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1285         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1286 }
1287
1288 #[test]
1289 fn holding_cell_htlc_counting() {
1290         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1291         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1292         // commitment dance rounds.
1293         let chanmon_cfgs = create_chanmon_cfgs(3);
1294         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1295         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1296         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1297         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1298         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1299         let logger = test_utils::TestLogger::new();
1300
1301         let mut payments = Vec::new();
1302         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1303                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1304                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1305                 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1306                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1307                 payments.push((payment_preimage, payment_hash));
1308         }
1309         check_added_monitors!(nodes[1], 1);
1310
1311         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1312         assert_eq!(events.len(), 1);
1313         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1314         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1315
1316         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1317         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1318         // another HTLC.
1319         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1320         {
1321                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1322                 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1323                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { err },
1324                         assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1325                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1326                 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1327         }
1328
1329         // This should also be true if we try to forward a payment.
1330         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1331         {
1332                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1333                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1334                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1335                 check_added_monitors!(nodes[0], 1);
1336         }
1337
1338         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1339         assert_eq!(events.len(), 1);
1340         let payment_event = SendEvent::from_event(events.pop().unwrap());
1341         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1342
1343         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1344         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1345         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1346         // fails), the second will process the resulting failure and fail the HTLC backward.
1347         expect_pending_htlcs_forwardable!(nodes[1]);
1348         expect_pending_htlcs_forwardable!(nodes[1]);
1349         check_added_monitors!(nodes[1], 1);
1350
1351         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1352         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1353         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1354
1355         let events = nodes[0].node.get_and_clear_pending_msg_events();
1356         assert_eq!(events.len(), 1);
1357         match events[0] {
1358                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1359                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1360                 },
1361                 _ => panic!("Unexpected event"),
1362         }
1363
1364         expect_payment_failed!(nodes[0], payment_hash_2, false);
1365
1366         // Now forward all the pending HTLCs and claim them back
1367         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1368         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1369         check_added_monitors!(nodes[2], 1);
1370
1371         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1372         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1373         check_added_monitors!(nodes[1], 1);
1374         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1375
1376         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1377         check_added_monitors!(nodes[1], 1);
1378         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1379
1380         for ref update in as_updates.update_add_htlcs.iter() {
1381                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1382         }
1383         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1384         check_added_monitors!(nodes[2], 1);
1385         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1386         check_added_monitors!(nodes[2], 1);
1387         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1388
1389         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1390         check_added_monitors!(nodes[1], 1);
1391         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1392         check_added_monitors!(nodes[1], 1);
1393         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1394
1395         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1396         check_added_monitors!(nodes[2], 1);
1397
1398         expect_pending_htlcs_forwardable!(nodes[2]);
1399
1400         let events = nodes[2].node.get_and_clear_pending_events();
1401         assert_eq!(events.len(), payments.len());
1402         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1403                 match event {
1404                         &Event::PaymentReceived { ref payment_hash, .. } => {
1405                                 assert_eq!(*payment_hash, *hash);
1406                         },
1407                         _ => panic!("Unexpected event"),
1408                 };
1409         }
1410
1411         for (preimage, _) in payments.drain(..) {
1412                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1413         }
1414
1415         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1416 }
1417
1418 #[test]
1419 fn duplicate_htlc_test() {
1420         // Test that we accept duplicate payment_hash HTLCs across the network and that
1421         // claiming/failing them are all separate and don't affect each other
1422         let chanmon_cfgs = create_chanmon_cfgs(6);
1423         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1424         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1425         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1426
1427         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1428         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1429         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1430         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1431         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1432         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1433
1434         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1435
1436         *nodes[0].network_payment_count.borrow_mut() -= 1;
1437         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1438
1439         *nodes[0].network_payment_count.borrow_mut() -= 1;
1440         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1441
1442         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1443         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1444         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1445 }
1446
1447 #[test]
1448 fn test_duplicate_htlc_different_direction_onchain() {
1449         // Test that ChannelMonitor doesn't generate 2 preimage txn
1450         // when we have 2 HTLCs with same preimage that go across a node
1451         // in opposite directions.
1452         let chanmon_cfgs = create_chanmon_cfgs(2);
1453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1456
1457         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1458         let logger = test_utils::TestLogger::new();
1459
1460         // balancing
1461         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1462
1463         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1464
1465         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1466         let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1467         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1468
1469         // Provide preimage to node 0 by claiming payment
1470         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1471         check_added_monitors!(nodes[0], 1);
1472
1473         // Broadcast node 1 commitment txn
1474         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1475
1476         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1477         let mut has_both_htlcs = 0; // check htlcs match ones committed
1478         for outp in remote_txn[0].output.iter() {
1479                 if outp.value == 800_000 / 1000 {
1480                         has_both_htlcs += 1;
1481                 } else if outp.value == 900_000 / 1000 {
1482                         has_both_htlcs += 1;
1483                 }
1484         }
1485         assert_eq!(has_both_htlcs, 2);
1486
1487         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1488         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1489         check_added_monitors!(nodes[0], 1);
1490
1491         // Check we only broadcast 1 timeout tx
1492         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1493         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()) };
1494         assert_eq!(claim_txn.len(), 5);
1495         check_spends!(claim_txn[2], chan_1.3);
1496         check_spends!(claim_txn[3], claim_txn[2]);
1497         assert_eq!(htlc_pair.0.input.len(), 1);
1498         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1499         check_spends!(htlc_pair.0, remote_txn[0]);
1500         assert_eq!(htlc_pair.1.input.len(), 1);
1501         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1502         check_spends!(htlc_pair.1, remote_txn[0]);
1503
1504         let events = nodes[0].node.get_and_clear_pending_msg_events();
1505         assert_eq!(events.len(), 2);
1506         for e in events {
1507                 match e {
1508                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1509                         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, .. } } => {
1510                                 assert!(update_add_htlcs.is_empty());
1511                                 assert!(update_fail_htlcs.is_empty());
1512                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1513                                 assert!(update_fail_malformed_htlcs.is_empty());
1514                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1515                         },
1516                         _ => panic!("Unexpected event"),
1517                 }
1518         }
1519 }
1520
1521 #[test]
1522 fn test_basic_channel_reserve() {
1523         let chanmon_cfgs = create_chanmon_cfgs(2);
1524         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1525         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1526         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1527         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1528         let logger = test_utils::TestLogger::new();
1529
1530         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1531         let channel_reserve = chan_stat.channel_reserve_msat;
1532
1533         // The 2* and +1 are for the fee spike reserve.
1534         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1535         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1536         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1537         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1538         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1539         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1540         match err {
1541                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1542                         match fails[0] {
1543                                 APIError::ChannelUnavailable{err} =>
1544                                         assert_eq!(err, "Cannot send value that would put us under local channel reserve value"),
1545                                 _ => panic!("Unexpected error variant"),
1546                         }
1547                 },
1548                 _ => panic!("Unexpected error variant"),
1549         }
1550         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1551         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1552
1553         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1554 }
1555
1556 #[test]
1557 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1558         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1559         // Set the fee rate for the channel very high, to the point where the fundee
1560         // sending any amount would result in a channel reserve violation. In this test
1561         // we check that we would be prevented from sending an HTLC in this situation.
1562         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1563         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1566         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1567         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1568         let logger = test_utils::TestLogger::new();
1569
1570         macro_rules! get_route_and_payment_hash {
1571                 ($recv_value: expr) => {{
1572                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1573                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1574                         let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1575                         (route, payment_hash, payment_preimage)
1576                 }}
1577         };
1578
1579         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1580         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1581                 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1582         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1583         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1584 }
1585
1586 #[test]
1587 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1588         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1589         // Set the fee rate for the channel very high, to the point where the funder
1590         // receiving 1 update_add_htlc would result in them closing the channel due
1591         // to channel reserve violation. This close could also happen if the fee went
1592         // up a more realistic amount, but many HTLCs were outstanding at the time of
1593         // the update_add_htlc.
1594         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1595         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1596         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1597         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1598         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1599         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1600         let logger = test_utils::TestLogger::new();
1601
1602         macro_rules! get_route_and_payment_hash {
1603                 ($recv_value: expr) => {{
1604                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1605                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1606                         let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1607                         (route, payment_hash, payment_preimage)
1608                 }}
1609         };
1610
1611         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1612         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1613         let secp_ctx = Secp256k1::new();
1614         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1615         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1616         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1617         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1618         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1619         let msg = msgs::UpdateAddHTLC {
1620                 channel_id: chan.2,
1621                 htlc_id: 1,
1622                 amount_msat: htlc_msat + 1,
1623                 payment_hash: payment_hash,
1624                 cltv_expiry: htlc_cltv,
1625                 onion_routing_packet: onion_packet,
1626         };
1627
1628         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1629         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1630         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1631         assert_eq!(nodes[0].node.list_channels().len(), 0);
1632         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1633         assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1634         check_added_monitors!(nodes[0], 1);
1635 }
1636
1637 #[test]
1638 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1639         let chanmon_cfgs = create_chanmon_cfgs(3);
1640         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1641         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1642         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1643         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1644         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1645         let logger = test_utils::TestLogger::new();
1646
1647         macro_rules! get_route_and_payment_hash {
1648                 ($recv_value: expr) => {{
1649                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1650                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1651                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1652                         (route, payment_hash, payment_preimage)
1653                 }}
1654         };
1655
1656         let feemsat = 239;
1657         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1658         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1659         let feerate = get_feerate!(nodes[0], chan.2);
1660
1661         // Add a 2* and +1 for the fee spike reserve.
1662         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1663         let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1664         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1665
1666         // Add a pending HTLC.
1667         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1668         let payment_event_1 = {
1669                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1670                 check_added_monitors!(nodes[0], 1);
1671
1672                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1673                 assert_eq!(events.len(), 1);
1674                 SendEvent::from_event(events.remove(0))
1675         };
1676         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1677
1678         // Attempt to trigger a channel reserve violation --> payment failure.
1679         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1680         let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1681         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1682         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1683
1684         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1685         let secp_ctx = Secp256k1::new();
1686         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1687         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1688         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1689         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1690         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1691         let msg = msgs::UpdateAddHTLC {
1692                 channel_id: chan.2,
1693                 htlc_id: 1,
1694                 amount_msat: htlc_msat + 1,
1695                 payment_hash: our_payment_hash_1,
1696                 cltv_expiry: htlc_cltv,
1697                 onion_routing_packet: onion_packet,
1698         };
1699
1700         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1701         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1702         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1703         assert_eq!(nodes[1].node.list_channels().len(), 1);
1704         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1705         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1706         check_added_monitors!(nodes[1], 1);
1707 }
1708
1709 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1710         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1711 }
1712
1713 #[test]
1714 fn test_channel_reserve_holding_cell_htlcs() {
1715         let chanmon_cfgs = create_chanmon_cfgs(3);
1716         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1717         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1718         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1719         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1720         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1721         let logger = test_utils::TestLogger::new();
1722
1723         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1724         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1725
1726         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1727         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1728
1729         macro_rules! get_route_and_payment_hash {
1730                 ($recv_value: expr) => {{
1731                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1732                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1733                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1734                         (route, payment_hash, payment_preimage)
1735                 }}
1736         };
1737
1738         macro_rules! expect_forward {
1739                 ($node: expr) => {{
1740                         let mut events = $node.node.get_and_clear_pending_msg_events();
1741                         assert_eq!(events.len(), 1);
1742                         check_added_monitors!($node, 1);
1743                         let payment_event = SendEvent::from_event(events.remove(0));
1744                         payment_event
1745                 }}
1746         }
1747
1748         let feemsat = 239; // somehow we know?
1749         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1750         let feerate = get_feerate!(nodes[0], chan_1.2);
1751
1752         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1753
1754         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1755         {
1756                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1757                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1758                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1759                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1760                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1761                 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);
1762         }
1763
1764         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1765         // nodes[0]'s wealth
1766         loop {
1767                 let amt_msat = recv_value_0 + total_fee_msat;
1768                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1769                 // Also, ensure that each payment has enough to be over the dust limit to
1770                 // ensure it'll be included in each commit tx fee calculation.
1771                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1772                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1773                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1774                         break;
1775                 }
1776                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1777
1778                 let (stat01_, stat11_, stat12_, stat22_) = (
1779                         get_channel_value_stat!(nodes[0], chan_1.2),
1780                         get_channel_value_stat!(nodes[1], chan_1.2),
1781                         get_channel_value_stat!(nodes[1], chan_2.2),
1782                         get_channel_value_stat!(nodes[2], chan_2.2),
1783                 );
1784
1785                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1786                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1787                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1788                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1789                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1790         }
1791
1792         // adding pending output.
1793         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1794         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1795         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1796         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1797         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1798         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1799         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1800         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1801         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1802         // policy.
1803         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1804         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1805         let amt_msat_1 = recv_value_1 + total_fee_msat;
1806
1807         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1808         let payment_event_1 = {
1809                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1810                 check_added_monitors!(nodes[0], 1);
1811
1812                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1813                 assert_eq!(events.len(), 1);
1814                 SendEvent::from_event(events.remove(0))
1815         };
1816         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1817
1818         // channel reserve test with htlc pending output > 0
1819         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1820         {
1821                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1822                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1823                         assert_eq!(err, "Cannot send value that would put us under local channel reserve value"));
1824                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1825         }
1826
1827         // split the rest to test holding cell
1828         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1829         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1830         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1831         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1832         {
1833                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1834                 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 + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
1835         }
1836
1837         // now see if they go through on both sides
1838         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1839         // but this will stuck in the holding cell
1840         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
1841         check_added_monitors!(nodes[0], 0);
1842         let events = nodes[0].node.get_and_clear_pending_events();
1843         assert_eq!(events.len(), 0);
1844
1845         // test with outbound holding cell amount > 0
1846         {
1847                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1848                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1849                         assert_eq!(err, "Cannot send value that would put us under local channel reserve value"));
1850                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1851                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
1852         }
1853
1854         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1855         // this will also stuck in the holding cell
1856         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
1857         check_added_monitors!(nodes[0], 0);
1858         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1859         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1860
1861         // flush the pending htlc
1862         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1863         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1864         check_added_monitors!(nodes[1], 1);
1865
1866         // the pending htlc should be promoted to committed
1867         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1868         check_added_monitors!(nodes[0], 1);
1869         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1870
1871         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1872         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1873         // No commitment_signed so get_event_msg's assert(len == 1) passes
1874         check_added_monitors!(nodes[0], 1);
1875
1876         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1877         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1878         check_added_monitors!(nodes[1], 1);
1879
1880         expect_pending_htlcs_forwardable!(nodes[1]);
1881
1882         let ref payment_event_11 = expect_forward!(nodes[1]);
1883         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1884         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1885
1886         expect_pending_htlcs_forwardable!(nodes[2]);
1887         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1888
1889         // flush the htlcs in the holding cell
1890         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1891         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1892         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1893         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1894         expect_pending_htlcs_forwardable!(nodes[1]);
1895
1896         let ref payment_event_3 = expect_forward!(nodes[1]);
1897         assert_eq!(payment_event_3.msgs.len(), 2);
1898         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1899         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1900
1901         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1902         expect_pending_htlcs_forwardable!(nodes[2]);
1903
1904         let events = nodes[2].node.get_and_clear_pending_events();
1905         assert_eq!(events.len(), 2);
1906         match events[0] {
1907                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1908                         assert_eq!(our_payment_hash_21, *payment_hash);
1909                         assert_eq!(*payment_secret, None);
1910                         assert_eq!(recv_value_21, amt);
1911                 },
1912                 _ => panic!("Unexpected event"),
1913         }
1914         match events[1] {
1915                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1916                         assert_eq!(our_payment_hash_22, *payment_hash);
1917                         assert_eq!(None, *payment_secret);
1918                         assert_eq!(recv_value_22, amt);
1919                 },
1920                 _ => panic!("Unexpected event"),
1921         }
1922
1923         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1924         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1925         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1926
1927         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1928         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1929         {
1930                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
1931                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1932                 match err {
1933                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1934                                 match fails[0] {
1935                                         APIError::ChannelUnavailable{err} =>
1936                                                 assert_eq!(err, "Cannot send value that would put us under local channel reserve value"),
1937                                         _ => panic!("Unexpected error variant"),
1938                                 }
1939                         },
1940                         _ => panic!("Unexpected error variant"),
1941                 }
1942                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1943                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
1944         }
1945
1946         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
1947
1948         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1949         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) - (recv_value_3 + total_fee_msat);
1950         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1951         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1952         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1953
1954         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1955         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1956 }
1957
1958 #[test]
1959 fn channel_reserve_in_flight_removes() {
1960         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1961         // can send to its counterparty, but due to update ordering, the other side may not yet have
1962         // considered those HTLCs fully removed.
1963         // This tests that we don't count HTLCs which will not be included in the next remote
1964         // commitment transaction towards the reserve value (as it implies no commitment transaction
1965         // will be generated which violates the remote reserve value).
1966         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1967         // To test this we:
1968         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1969         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1970         //    you only consider the value of the first HTLC, it may not),
1971         //  * start routing a third HTLC from A to B,
1972         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1973         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1974         //  * deliver the first fulfill from B
1975         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1976         //    claim,
1977         //  * deliver A's response CS and RAA.
1978         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1979         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1980         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1981         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1982         let chanmon_cfgs = create_chanmon_cfgs(2);
1983         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1985         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1986         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1987         let logger = test_utils::TestLogger::new();
1988
1989         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1990         // Route the first two HTLCs.
1991         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1992         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1993
1994         // Start routing the third HTLC (this is just used to get everyone in the right state).
1995         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1996         let send_1 = {
1997                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1998                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1999                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2000                 check_added_monitors!(nodes[0], 1);
2001                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2002                 assert_eq!(events.len(), 1);
2003                 SendEvent::from_event(events.remove(0))
2004         };
2005
2006         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2007         // initial fulfill/CS.
2008         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2009         check_added_monitors!(nodes[1], 1);
2010         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2011
2012         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2013         // remove the second HTLC when we send the HTLC back from B to A.
2014         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2015         check_added_monitors!(nodes[1], 1);
2016         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2017
2018         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2019         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2020         check_added_monitors!(nodes[0], 1);
2021         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2022         expect_payment_sent!(nodes[0], payment_preimage_1);
2023
2024         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2025         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2026         check_added_monitors!(nodes[1], 1);
2027         // B is already AwaitingRAA, so cant generate a CS here
2028         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2029
2030         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2031         check_added_monitors!(nodes[1], 1);
2032         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2033
2034         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2035         check_added_monitors!(nodes[0], 1);
2036         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2037
2038         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2039         check_added_monitors!(nodes[1], 1);
2040         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2041
2042         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2043         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2044         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2045         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2046         // on-chain as necessary).
2047         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2048         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2049         check_added_monitors!(nodes[0], 1);
2050         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2051         expect_payment_sent!(nodes[0], payment_preimage_2);
2052
2053         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2054         check_added_monitors!(nodes[1], 1);
2055         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2056
2057         expect_pending_htlcs_forwardable!(nodes[1]);
2058         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2059
2060         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2061         // resolve the second HTLC from A's point of view.
2062         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2063         check_added_monitors!(nodes[0], 1);
2064         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2065
2066         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2067         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2068         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2069         let send_2 = {
2070                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2071                 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2072                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2073                 check_added_monitors!(nodes[1], 1);
2074                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2075                 assert_eq!(events.len(), 1);
2076                 SendEvent::from_event(events.remove(0))
2077         };
2078
2079         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2080         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2081         check_added_monitors!(nodes[0], 1);
2082         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2083
2084         // Now just resolve all the outstanding messages/HTLCs for completeness...
2085
2086         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2087         check_added_monitors!(nodes[1], 1);
2088         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2089
2090         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2091         check_added_monitors!(nodes[1], 1);
2092
2093         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2094         check_added_monitors!(nodes[0], 1);
2095         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2096
2097         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2098         check_added_monitors!(nodes[1], 1);
2099         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2100
2101         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2102         check_added_monitors!(nodes[0], 1);
2103
2104         expect_pending_htlcs_forwardable!(nodes[0]);
2105         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2106
2107         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2108         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2109 }
2110
2111 #[test]
2112 fn channel_monitor_network_test() {
2113         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2114         // tests that ChannelMonitor is able to recover from various states.
2115         let chanmon_cfgs = create_chanmon_cfgs(5);
2116         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2117         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2118         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2119
2120         // Create some initial channels
2121         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2122         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2123         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2124         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2125
2126         // Rebalance the network a bit by relaying one payment through all the channels...
2127         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2128         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2129         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2130         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2131
2132         // Simple case with no pending HTLCs:
2133         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2134         check_added_monitors!(nodes[1], 1);
2135         {
2136                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2137                 let 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![node_txn.drain(..).next().unwrap()] }, 1);
2139                 check_added_monitors!(nodes[0], 1);
2140                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2141         }
2142         get_announce_close_broadcast_events(&nodes, 0, 1);
2143         assert_eq!(nodes[0].node.list_channels().len(), 0);
2144         assert_eq!(nodes[1].node.list_channels().len(), 1);
2145
2146         // One pending HTLC is discarded by the force-close:
2147         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2148
2149         // Simple case of one pending HTLC to HTLC-Timeout
2150         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2151         check_added_monitors!(nodes[1], 1);
2152         {
2153                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2154                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2155                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2156                 check_added_monitors!(nodes[2], 1);
2157                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2158         }
2159         get_announce_close_broadcast_events(&nodes, 1, 2);
2160         assert_eq!(nodes[1].node.list_channels().len(), 0);
2161         assert_eq!(nodes[2].node.list_channels().len(), 1);
2162
2163         macro_rules! claim_funds {
2164                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2165                         {
2166                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2167                                 check_added_monitors!($node, 1);
2168
2169                                 let events = $node.node.get_and_clear_pending_msg_events();
2170                                 assert_eq!(events.len(), 1);
2171                                 match events[0] {
2172                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2173                                                 assert!(update_add_htlcs.is_empty());
2174                                                 assert!(update_fail_htlcs.is_empty());
2175                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2176                                         },
2177                                         _ => panic!("Unexpected event"),
2178                                 };
2179                         }
2180                 }
2181         }
2182
2183         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2184         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2185         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2186         check_added_monitors!(nodes[2], 1);
2187         let node2_commitment_txid;
2188         {
2189                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2190                 node2_commitment_txid = node_txn[0].txid();
2191
2192                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2193                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2194
2195                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2196                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2197                 check_added_monitors!(nodes[3], 1);
2198
2199                 check_preimage_claim(&nodes[3], &node_txn);
2200         }
2201         get_announce_close_broadcast_events(&nodes, 2, 3);
2202         assert_eq!(nodes[2].node.list_channels().len(), 0);
2203         assert_eq!(nodes[3].node.list_channels().len(), 1);
2204
2205         { // Cheat and reset nodes[4]'s height to 1
2206                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2207                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2208         }
2209
2210         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2211         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2212         // One pending HTLC to time out:
2213         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2214         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2215         // buffer space).
2216
2217         {
2218                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2219                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2220                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2221                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2222                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2223                 }
2224                 check_added_monitors!(nodes[3], 1);
2225
2226                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2227                 {
2228                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2229                         node_txn.retain(|tx| {
2230                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2231                                         false
2232                                 } else { true }
2233                         });
2234                 }
2235
2236                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2237
2238                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2239                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2240
2241                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2242
2243                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2244                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2245                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2246                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2247                 }
2248
2249                 check_added_monitors!(nodes[4], 1);
2250                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2251
2252                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2253                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2254
2255                 check_preimage_claim(&nodes[4], &node_txn);
2256         }
2257         get_announce_close_broadcast_events(&nodes, 3, 4);
2258         assert_eq!(nodes[3].node.list_channels().len(), 0);
2259         assert_eq!(nodes[4].node.list_channels().len(), 0);
2260 }
2261
2262 #[test]
2263 fn test_justice_tx() {
2264         // Test justice txn built on revoked HTLC-Success tx, against both sides
2265         let mut alice_config = UserConfig::default();
2266         alice_config.channel_options.announced_channel = true;
2267         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2268         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2269         let mut bob_config = UserConfig::default();
2270         bob_config.channel_options.announced_channel = true;
2271         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2272         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2273         let user_cfgs = [Some(alice_config), Some(bob_config)];
2274         let chanmon_cfgs = create_chanmon_cfgs(2);
2275         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2276         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2277         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2278         // Create some new channels:
2279         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2280
2281         // A pending HTLC which will be revoked:
2282         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2283         // Get the will-be-revoked local txn from nodes[0]
2284         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2285         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2286         assert_eq!(revoked_local_txn[0].input.len(), 1);
2287         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2288         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2289         assert_eq!(revoked_local_txn[1].input.len(), 1);
2290         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2291         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2292         // Revoke the old state
2293         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2294
2295         {
2296                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2297                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2298                 {
2299                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2300                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2301                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2302
2303                         check_spends!(node_txn[0], revoked_local_txn[0]);
2304                         node_txn.swap_remove(0);
2305                         node_txn.truncate(1);
2306                 }
2307                 check_added_monitors!(nodes[1], 1);
2308                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2309
2310                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2311                 // Verify broadcast of revoked HTLC-timeout
2312                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2313                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2314                 check_added_monitors!(nodes[0], 1);
2315                 // Broadcast revoked HTLC-timeout on node 1
2316                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2317                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2318         }
2319         get_announce_close_broadcast_events(&nodes, 0, 1);
2320
2321         assert_eq!(nodes[0].node.list_channels().len(), 0);
2322         assert_eq!(nodes[1].node.list_channels().len(), 0);
2323
2324         // We test justice_tx build by A on B's revoked HTLC-Success tx
2325         // Create some new channels:
2326         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2327         {
2328                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2329                 node_txn.clear();
2330         }
2331
2332         // A pending HTLC which will be revoked:
2333         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2334         // Get the will-be-revoked local txn from B
2335         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2336         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2337         assert_eq!(revoked_local_txn[0].input.len(), 1);
2338         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2339         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2340         // Revoke the old state
2341         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2342         {
2343                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2344                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2345                 {
2346                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2347                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2348                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2349
2350                         check_spends!(node_txn[0], revoked_local_txn[0]);
2351                         node_txn.swap_remove(0);
2352                 }
2353                 check_added_monitors!(nodes[0], 1);
2354                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2355
2356                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2357                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2358                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2359                 check_added_monitors!(nodes[1], 1);
2360                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2361                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2362         }
2363         get_announce_close_broadcast_events(&nodes, 0, 1);
2364         assert_eq!(nodes[0].node.list_channels().len(), 0);
2365         assert_eq!(nodes[1].node.list_channels().len(), 0);
2366 }
2367
2368 #[test]
2369 fn revoked_output_claim() {
2370         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2371         // transaction is broadcast by its counterparty
2372         let chanmon_cfgs = create_chanmon_cfgs(2);
2373         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2374         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2375         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2376         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2377         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2378         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2379         assert_eq!(revoked_local_txn.len(), 1);
2380         // Only output is the full channel value back to nodes[0]:
2381         assert_eq!(revoked_local_txn[0].output.len(), 1);
2382         // Send a payment through, updating everyone's latest commitment txn
2383         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2384
2385         // Inform nodes[1] that nodes[0] broadcast a stale tx
2386         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2387         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2388         check_added_monitors!(nodes[1], 1);
2389         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2390         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2391
2392         check_spends!(node_txn[0], revoked_local_txn[0]);
2393         check_spends!(node_txn[1], chan_1.3);
2394
2395         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2396         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2397         get_announce_close_broadcast_events(&nodes, 0, 1);
2398         check_added_monitors!(nodes[0], 1)
2399 }
2400
2401 #[test]
2402 fn claim_htlc_outputs_shared_tx() {
2403         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2404         let chanmon_cfgs = create_chanmon_cfgs(2);
2405         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2406         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2407         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2408
2409         // Create some new channel:
2410         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2411
2412         // Rebalance the network to generate htlc in the two directions
2413         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2414         // 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
2415         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2416         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2417
2418         // Get the will-be-revoked local txn from node[0]
2419         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2420         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2421         assert_eq!(revoked_local_txn[0].input.len(), 1);
2422         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2423         assert_eq!(revoked_local_txn[1].input.len(), 1);
2424         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2425         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2426         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2427
2428         //Revoke the old state
2429         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2430
2431         {
2432                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2433                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2434                 check_added_monitors!(nodes[0], 1);
2435                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2436                 check_added_monitors!(nodes[1], 1);
2437                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2438                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2439
2440                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2441                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2442
2443                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2444                 check_spends!(node_txn[0], revoked_local_txn[0]);
2445
2446                 let mut witness_lens = BTreeSet::new();
2447                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2448                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2449                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2450                 assert_eq!(witness_lens.len(), 3);
2451                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2452                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2453                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2454
2455                 // Next nodes[1] broadcasts its current local tx state:
2456                 assert_eq!(node_txn[1].input.len(), 1);
2457                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2458
2459                 assert_eq!(node_txn[2].input.len(), 1);
2460                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2461                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2462                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2463                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2464                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2465         }
2466         get_announce_close_broadcast_events(&nodes, 0, 1);
2467         assert_eq!(nodes[0].node.list_channels().len(), 0);
2468         assert_eq!(nodes[1].node.list_channels().len(), 0);
2469 }
2470
2471 #[test]
2472 fn claim_htlc_outputs_single_tx() {
2473         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2474         let chanmon_cfgs = create_chanmon_cfgs(2);
2475         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2476         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2477         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2478
2479         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2480
2481         // Rebalance the network to generate htlc in the two directions
2482         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2483         // 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
2484         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2485         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2486         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2487
2488         // Get the will-be-revoked local txn from node[0]
2489         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2490
2491         //Revoke the old state
2492         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2493
2494         {
2495                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2496                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2497                 check_added_monitors!(nodes[0], 1);
2498                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2499                 check_added_monitors!(nodes[1], 1);
2500                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2501
2502                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2503                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2504
2505                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2506                 assert_eq!(node_txn.len(), 9);
2507                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2508                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2509                 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2510                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2511
2512                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2513                 assert_eq!(node_txn[2].input.len(), 1);
2514                 check_spends!(node_txn[2], chan_1.3);
2515                 assert_eq!(node_txn[3].input.len(), 1);
2516                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2517                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2518                 check_spends!(node_txn[3], node_txn[2]);
2519
2520                 // Justice transactions are indices 1-2-4
2521                 assert_eq!(node_txn[0].input.len(), 1);
2522                 assert_eq!(node_txn[1].input.len(), 1);
2523                 assert_eq!(node_txn[4].input.len(), 1);
2524
2525                 check_spends!(node_txn[0], revoked_local_txn[0]);
2526                 check_spends!(node_txn[1], revoked_local_txn[0]);
2527                 check_spends!(node_txn[4], revoked_local_txn[0]);
2528
2529                 let mut witness_lens = BTreeSet::new();
2530                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2531                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2532                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2533                 assert_eq!(witness_lens.len(), 3);
2534                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2535                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2536                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2537         }
2538         get_announce_close_broadcast_events(&nodes, 0, 1);
2539         assert_eq!(nodes[0].node.list_channels().len(), 0);
2540         assert_eq!(nodes[1].node.list_channels().len(), 0);
2541 }
2542
2543 #[test]
2544 fn test_htlc_on_chain_success() {
2545         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2546         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2547         // broadcasting the right event to other nodes in payment path.
2548         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2549         // A --------------------> B ----------------------> C (preimage)
2550         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2551         // commitment transaction was broadcast.
2552         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2553         // towards B.
2554         // B should be able to claim via preimage if A then broadcasts its local tx.
2555         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2556         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2557         // PaymentSent event).
2558
2559         let chanmon_cfgs = create_chanmon_cfgs(3);
2560         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2561         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2562         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2563
2564         // Create some initial channels
2565         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2566         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2567
2568         // Rebalance the network a bit by relaying one payment through all the channels...
2569         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2570         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2571
2572         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2573         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2574         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2575
2576         // Broadcast legit commitment tx from C on B's chain
2577         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2578         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2579         assert_eq!(commitment_tx.len(), 1);
2580         check_spends!(commitment_tx[0], chan_2.3);
2581         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2582         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2583         check_added_monitors!(nodes[2], 2);
2584         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2585         assert!(updates.update_add_htlcs.is_empty());
2586         assert!(updates.update_fail_htlcs.is_empty());
2587         assert!(updates.update_fail_malformed_htlcs.is_empty());
2588         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2589
2590         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2591         check_closed_broadcast!(nodes[2], false);
2592         check_added_monitors!(nodes[2], 1);
2593         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2594         assert_eq!(node_txn.len(), 5);
2595         assert_eq!(node_txn[0], node_txn[3]);
2596         assert_eq!(node_txn[1], node_txn[4]);
2597         assert_eq!(node_txn[2], commitment_tx[0]);
2598         check_spends!(node_txn[0], commitment_tx[0]);
2599         check_spends!(node_txn[1], commitment_tx[0]);
2600         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2601         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2602         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2603         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2604         assert_eq!(node_txn[0].lock_time, 0);
2605         assert_eq!(node_txn[1].lock_time, 0);
2606
2607         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2608         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2609         {
2610                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2611                 assert_eq!(added_monitors.len(), 1);
2612                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2613                 added_monitors.clear();
2614         }
2615         let events = nodes[1].node.get_and_clear_pending_msg_events();
2616         {
2617                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2618                 assert_eq!(added_monitors.len(), 2);
2619                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2620                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2621                 added_monitors.clear();
2622         }
2623         assert_eq!(events.len(), 2);
2624         match events[0] {
2625                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2626                 _ => panic!("Unexpected event"),
2627         }
2628         match events[1] {
2629                 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, .. } } => {
2630                         assert!(update_add_htlcs.is_empty());
2631                         assert!(update_fail_htlcs.is_empty());
2632                         assert_eq!(update_fulfill_htlcs.len(), 1);
2633                         assert!(update_fail_malformed_htlcs.is_empty());
2634                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2635                 },
2636                 _ => panic!("Unexpected event"),
2637         };
2638         macro_rules! check_tx_local_broadcast {
2639                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2640                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2641                         assert_eq!(node_txn.len(), 5);
2642                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2643                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2644                         check_spends!(node_txn[0], $commitment_tx);
2645                         check_spends!(node_txn[1], $commitment_tx);
2646                         assert_ne!(node_txn[0].lock_time, 0);
2647                         assert_ne!(node_txn[1].lock_time, 0);
2648                         if $htlc_offered {
2649                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2650                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2651                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2652                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2653                         } else {
2654                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2655                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2656                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2657                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2658                         }
2659                         check_spends!(node_txn[2], $chan_tx);
2660                         check_spends!(node_txn[3], node_txn[2]);
2661                         check_spends!(node_txn[4], node_txn[2]);
2662                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2663                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2664                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2665                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2666                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2667                         assert_ne!(node_txn[3].lock_time, 0);
2668                         assert_ne!(node_txn[4].lock_time, 0);
2669                         node_txn.clear();
2670                 } }
2671         }
2672         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2673         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2674         // timeout-claim of the output that nodes[2] just claimed via success.
2675         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2676
2677         // Broadcast legit commitment tx from A on B's chain
2678         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2679         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2680         check_spends!(commitment_tx[0], chan_1.3);
2681         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2682         check_closed_broadcast!(nodes[1], false);
2683         check_added_monitors!(nodes[1], 1);
2684         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2685         assert_eq!(node_txn.len(), 4);
2686         check_spends!(node_txn[0], commitment_tx[0]);
2687         assert_eq!(node_txn[0].input.len(), 2);
2688         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2689         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2690         assert_eq!(node_txn[0].lock_time, 0);
2691         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2692         check_spends!(node_txn[1], chan_1.3);
2693         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2694         check_spends!(node_txn[2], node_txn[1]);
2695         check_spends!(node_txn[3], node_txn[1]);
2696         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2697         // we already checked the same situation with A.
2698
2699         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2700         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2701         check_closed_broadcast!(nodes[0], false);
2702         check_added_monitors!(nodes[0], 1);
2703         let events = nodes[0].node.get_and_clear_pending_events();
2704         assert_eq!(events.len(), 2);
2705         let mut first_claimed = false;
2706         for event in events {
2707                 match event {
2708                         Event::PaymentSent { payment_preimage } => {
2709                                 if payment_preimage == our_payment_preimage {
2710                                         assert!(!first_claimed);
2711                                         first_claimed = true;
2712                                 } else {
2713                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2714                                 }
2715                         },
2716                         _ => panic!("Unexpected event"),
2717                 }
2718         }
2719         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2720 }
2721
2722 #[test]
2723 fn test_htlc_on_chain_timeout() {
2724         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2725         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2726         // broadcasting the right event to other nodes in payment path.
2727         // A ------------------> B ----------------------> C (timeout)
2728         //    B's commitment tx                 C's commitment tx
2729         //            \                                  \
2730         //         B's HTLC timeout tx               B's timeout tx
2731
2732         let chanmon_cfgs = create_chanmon_cfgs(3);
2733         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2734         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2735         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2736
2737         // Create some intial channels
2738         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2739         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2740
2741         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2742         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2743         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2744
2745         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2746         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2747
2748         // Broadcast legit commitment tx from C on B's chain
2749         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2750         check_spends!(commitment_tx[0], chan_2.3);
2751         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2752         check_added_monitors!(nodes[2], 0);
2753         expect_pending_htlcs_forwardable!(nodes[2]);
2754         check_added_monitors!(nodes[2], 1);
2755
2756         let events = nodes[2].node.get_and_clear_pending_msg_events();
2757         assert_eq!(events.len(), 1);
2758         match events[0] {
2759                 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, .. } } => {
2760                         assert!(update_add_htlcs.is_empty());
2761                         assert!(!update_fail_htlcs.is_empty());
2762                         assert!(update_fulfill_htlcs.is_empty());
2763                         assert!(update_fail_malformed_htlcs.is_empty());
2764                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2765                 },
2766                 _ => panic!("Unexpected event"),
2767         };
2768         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2769         check_closed_broadcast!(nodes[2], false);
2770         check_added_monitors!(nodes[2], 1);
2771         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2772         assert_eq!(node_txn.len(), 1);
2773         check_spends!(node_txn[0], chan_2.3);
2774         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2775
2776         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2777         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2778         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2779         let timeout_tx;
2780         {
2781                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2782                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2783                 assert_eq!(node_txn[1], node_txn[3]);
2784                 assert_eq!(node_txn[2], node_txn[4]);
2785
2786                 check_spends!(node_txn[0], commitment_tx[0]);
2787                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2788
2789                 check_spends!(node_txn[1], chan_2.3);
2790                 check_spends!(node_txn[2], node_txn[1]);
2791                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2792                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2793
2794                 timeout_tx = node_txn[0].clone();
2795                 node_txn.clear();
2796         }
2797
2798         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2799         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2800         check_added_monitors!(nodes[1], 1);
2801         check_closed_broadcast!(nodes[1], false);
2802
2803         expect_pending_htlcs_forwardable!(nodes[1]);
2804         check_added_monitors!(nodes[1], 1);
2805         let events = nodes[1].node.get_and_clear_pending_msg_events();
2806         assert_eq!(events.len(), 1);
2807         match events[0] {
2808                 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, .. } } => {
2809                         assert!(update_add_htlcs.is_empty());
2810                         assert!(!update_fail_htlcs.is_empty());
2811                         assert!(update_fulfill_htlcs.is_empty());
2812                         assert!(update_fail_malformed_htlcs.is_empty());
2813                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2814                 },
2815                 _ => panic!("Unexpected event"),
2816         };
2817         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
2818         assert_eq!(node_txn.len(), 0);
2819
2820         // Broadcast legit commitment tx from B on A's chain
2821         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2822         check_spends!(commitment_tx[0], chan_1.3);
2823
2824         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2825         check_closed_broadcast!(nodes[0], false);
2826         check_added_monitors!(nodes[0], 1);
2827         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2828         assert_eq!(node_txn.len(), 3);
2829         check_spends!(node_txn[0], commitment_tx[0]);
2830         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2831         check_spends!(node_txn[1], chan_1.3);
2832         check_spends!(node_txn[2], node_txn[1]);
2833         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2834         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835 }
2836
2837 #[test]
2838 fn test_simple_commitment_revoked_fail_backward() {
2839         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2840         // and fail backward accordingly.
2841
2842         let chanmon_cfgs = create_chanmon_cfgs(3);
2843         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2844         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2845         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2846
2847         // Create some initial channels
2848         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2849         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2850
2851         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2852         // Get the will-be-revoked local txn from nodes[2]
2853         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2854         // Revoke the old state
2855         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2856
2857         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2858
2859         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2860         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2861         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2862         check_added_monitors!(nodes[1], 1);
2863         check_closed_broadcast!(nodes[1], false);
2864
2865         expect_pending_htlcs_forwardable!(nodes[1]);
2866         check_added_monitors!(nodes[1], 1);
2867         let events = nodes[1].node.get_and_clear_pending_msg_events();
2868         assert_eq!(events.len(), 1);
2869         match events[0] {
2870                 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, .. } } => {
2871                         assert!(update_add_htlcs.is_empty());
2872                         assert_eq!(update_fail_htlcs.len(), 1);
2873                         assert!(update_fulfill_htlcs.is_empty());
2874                         assert!(update_fail_malformed_htlcs.is_empty());
2875                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2876
2877                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2878                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2879
2880                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2881                         assert_eq!(events.len(), 1);
2882                         match events[0] {
2883                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2884                                 _ => panic!("Unexpected event"),
2885                         }
2886                         expect_payment_failed!(nodes[0], payment_hash, false);
2887                 },
2888                 _ => panic!("Unexpected event"),
2889         }
2890 }
2891
2892 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2893         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2894         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2895         // commitment transaction anymore.
2896         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2897         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2898         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2899         // technically disallowed and we should probably handle it reasonably.
2900         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2901         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2902         // transactions:
2903         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2904         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2905         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2906         //   and once they revoke the previous commitment transaction (allowing us to send a new
2907         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2908         let chanmon_cfgs = create_chanmon_cfgs(3);
2909         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2910         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2911         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2912
2913         // Create some initial channels
2914         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2915         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2916
2917         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2918         // Get the will-be-revoked local txn from nodes[2]
2919         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2920         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2921         // Revoke the old state
2922         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2923
2924         let value = if use_dust {
2925                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2926                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2927                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2928         } else { 3000000 };
2929
2930         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2931         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2932         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2933
2934         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2935         expect_pending_htlcs_forwardable!(nodes[2]);
2936         check_added_monitors!(nodes[2], 1);
2937         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2938         assert!(updates.update_add_htlcs.is_empty());
2939         assert!(updates.update_fulfill_htlcs.is_empty());
2940         assert!(updates.update_fail_malformed_htlcs.is_empty());
2941         assert_eq!(updates.update_fail_htlcs.len(), 1);
2942         assert!(updates.update_fee.is_none());
2943         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2944         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2945         // Drop the last RAA from 3 -> 2
2946
2947         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2948         expect_pending_htlcs_forwardable!(nodes[2]);
2949         check_added_monitors!(nodes[2], 1);
2950         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2951         assert!(updates.update_add_htlcs.is_empty());
2952         assert!(updates.update_fulfill_htlcs.is_empty());
2953         assert!(updates.update_fail_malformed_htlcs.is_empty());
2954         assert_eq!(updates.update_fail_htlcs.len(), 1);
2955         assert!(updates.update_fee.is_none());
2956         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2957         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2958         check_added_monitors!(nodes[1], 1);
2959         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2960         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2961         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2962         check_added_monitors!(nodes[2], 1);
2963
2964         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2965         expect_pending_htlcs_forwardable!(nodes[2]);
2966         check_added_monitors!(nodes[2], 1);
2967         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2968         assert!(updates.update_add_htlcs.is_empty());
2969         assert!(updates.update_fulfill_htlcs.is_empty());
2970         assert!(updates.update_fail_malformed_htlcs.is_empty());
2971         assert_eq!(updates.update_fail_htlcs.len(), 1);
2972         assert!(updates.update_fee.is_none());
2973         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2974         // At this point first_payment_hash has dropped out of the latest two commitment
2975         // transactions that nodes[1] is tracking...
2976         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2977         check_added_monitors!(nodes[1], 1);
2978         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2979         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2980         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2981         check_added_monitors!(nodes[2], 1);
2982
2983         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2984         // on nodes[2]'s RAA.
2985         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2986         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2987         let logger = test_utils::TestLogger::new();
2988         let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
2989         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
2990         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2991         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2992         check_added_monitors!(nodes[1], 0);
2993
2994         if deliver_bs_raa {
2995                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2996                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2997                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2998                 check_added_monitors!(nodes[1], 1);
2999                 let events = nodes[1].node.get_and_clear_pending_events();
3000                 assert_eq!(events.len(), 1);
3001                 match events[0] {
3002                         Event::PendingHTLCsForwardable { .. } => { },
3003                         _ => panic!("Unexpected event"),
3004                 };
3005                 // Deliberately don't process the pending fail-back so they all fail back at once after
3006                 // block connection just like the !deliver_bs_raa case
3007         }
3008
3009         let mut failed_htlcs = HashSet::new();
3010         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3011
3012         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3013         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3014         check_added_monitors!(nodes[1], 1);
3015         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3016
3017         let events = nodes[1].node.get_and_clear_pending_events();
3018         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3019         match events[0] {
3020                 Event::PaymentFailed { ref payment_hash, .. } => {
3021                         assert_eq!(*payment_hash, fourth_payment_hash);
3022                 },
3023                 _ => panic!("Unexpected event"),
3024         }
3025         if !deliver_bs_raa {
3026                 match events[1] {
3027                         Event::PendingHTLCsForwardable { .. } => { },
3028                         _ => panic!("Unexpected event"),
3029                 };
3030         }
3031         nodes[1].node.process_pending_htlc_forwards();
3032         check_added_monitors!(nodes[1], 1);
3033
3034         let events = nodes[1].node.get_and_clear_pending_msg_events();
3035         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3036         match events[if deliver_bs_raa { 1 } else { 0 }] {
3037                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3038                 _ => panic!("Unexpected event"),
3039         }
3040         if deliver_bs_raa {
3041                 match events[0] {
3042                         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, .. } } => {
3043                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3044                                 assert_eq!(update_add_htlcs.len(), 1);
3045                                 assert!(update_fulfill_htlcs.is_empty());
3046                                 assert!(update_fail_htlcs.is_empty());
3047                                 assert!(update_fail_malformed_htlcs.is_empty());
3048                         },
3049                         _ => panic!("Unexpected event"),
3050                 }
3051         }
3052         match events[if deliver_bs_raa { 2 } else { 1 }] {
3053                 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, .. } } => {
3054                         assert!(update_add_htlcs.is_empty());
3055                         assert_eq!(update_fail_htlcs.len(), 3);
3056                         assert!(update_fulfill_htlcs.is_empty());
3057                         assert!(update_fail_malformed_htlcs.is_empty());
3058                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3059
3060                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3061                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3062                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3063
3064                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3065
3066                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3067                         // If we delivered B's RAA we got an unknown preimage error, not something
3068                         // that we should update our routing table for.
3069                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3070                         for event in events {
3071                                 match event {
3072                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3073                                         _ => panic!("Unexpected event"),
3074                                 }
3075                         }
3076                         let events = nodes[0].node.get_and_clear_pending_events();
3077                         assert_eq!(events.len(), 3);
3078                         match events[0] {
3079                                 Event::PaymentFailed { ref payment_hash, .. } => {
3080                                         assert!(failed_htlcs.insert(payment_hash.0));
3081                                 },
3082                                 _ => panic!("Unexpected event"),
3083                         }
3084                         match events[1] {
3085                                 Event::PaymentFailed { ref payment_hash, .. } => {
3086                                         assert!(failed_htlcs.insert(payment_hash.0));
3087                                 },
3088                                 _ => panic!("Unexpected event"),
3089                         }
3090                         match events[2] {
3091                                 Event::PaymentFailed { ref payment_hash, .. } => {
3092                                         assert!(failed_htlcs.insert(payment_hash.0));
3093                                 },
3094                                 _ => panic!("Unexpected event"),
3095                         }
3096                 },
3097                 _ => panic!("Unexpected event"),
3098         }
3099
3100         assert!(failed_htlcs.contains(&first_payment_hash.0));
3101         assert!(failed_htlcs.contains(&second_payment_hash.0));
3102         assert!(failed_htlcs.contains(&third_payment_hash.0));
3103 }
3104
3105 #[test]
3106 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3107         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3108         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3109         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3110         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3111 }
3112
3113 #[test]
3114 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3115         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3116         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3117         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3118         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3119 }
3120
3121 #[test]
3122 fn fail_backward_pending_htlc_upon_channel_failure() {
3123         let chanmon_cfgs = create_chanmon_cfgs(2);
3124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3126         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3127         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3128         let logger = test_utils::TestLogger::new();
3129
3130         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3131         {
3132                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3133                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3134                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3135                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3136                 check_added_monitors!(nodes[0], 1);
3137
3138                 let payment_event = {
3139                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3140                         assert_eq!(events.len(), 1);
3141                         SendEvent::from_event(events.remove(0))
3142                 };
3143                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3144                 assert_eq!(payment_event.msgs.len(), 1);
3145         }
3146
3147         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3148         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3149         {
3150                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3151                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3152                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3153                 check_added_monitors!(nodes[0], 0);
3154
3155                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3156         }
3157
3158         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3159         {
3160                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3161
3162                 let secp_ctx = Secp256k1::new();
3163                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3164                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3165                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3166                 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3167                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3168                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3169                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3170
3171                 // Send a 0-msat update_add_htlc to fail the channel.
3172                 let update_add_htlc = msgs::UpdateAddHTLC {
3173                         channel_id: chan.2,
3174                         htlc_id: 0,
3175                         amount_msat: 0,
3176                         payment_hash,
3177                         cltv_expiry,
3178                         onion_routing_packet,
3179                 };
3180                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3181         }
3182
3183         // Check that Alice fails backward the pending HTLC from the second payment.
3184         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3185         check_closed_broadcast!(nodes[0], true);
3186         check_added_monitors!(nodes[0], 1);
3187 }
3188
3189 #[test]
3190 fn test_htlc_ignore_latest_remote_commitment() {
3191         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3192         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3193         let chanmon_cfgs = create_chanmon_cfgs(2);
3194         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3195         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3196         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3197         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3198
3199         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3200         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3201         check_closed_broadcast!(nodes[0], false);
3202         check_added_monitors!(nodes[0], 1);
3203
3204         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3205         assert_eq!(node_txn.len(), 2);
3206
3207         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3208         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3209         check_closed_broadcast!(nodes[1], false);
3210         check_added_monitors!(nodes[1], 1);
3211
3212         // Duplicate the block_connected call since this may happen due to other listeners
3213         // registering new transactions
3214         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3215 }
3216
3217 #[test]
3218 fn test_force_close_fail_back() {
3219         // Check which HTLCs are failed-backwards on channel force-closure
3220         let chanmon_cfgs = create_chanmon_cfgs(3);
3221         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3222         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3223         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3224         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3225         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3226         let logger = test_utils::TestLogger::new();
3227
3228         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3229
3230         let mut payment_event = {
3231                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3232                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3233                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3234                 check_added_monitors!(nodes[0], 1);
3235
3236                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3237                 assert_eq!(events.len(), 1);
3238                 SendEvent::from_event(events.remove(0))
3239         };
3240
3241         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3242         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3243
3244         expect_pending_htlcs_forwardable!(nodes[1]);
3245
3246         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3247         assert_eq!(events_2.len(), 1);
3248         payment_event = SendEvent::from_event(events_2.remove(0));
3249         assert_eq!(payment_event.msgs.len(), 1);
3250
3251         check_added_monitors!(nodes[1], 1);
3252         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3253         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3254         check_added_monitors!(nodes[2], 1);
3255         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3256
3257         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3258         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3259         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3260
3261         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3262         check_closed_broadcast!(nodes[2], false);
3263         check_added_monitors!(nodes[2], 1);
3264         let tx = {
3265                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3266                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3267                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3268                 // back to nodes[1] upon timeout otherwise.
3269                 assert_eq!(node_txn.len(), 1);
3270                 node_txn.remove(0)
3271         };
3272
3273         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3274         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3275
3276         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3277         check_closed_broadcast!(nodes[1], false);
3278         check_added_monitors!(nodes[1], 1);
3279
3280         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3281         {
3282                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3283                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3284                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3285         }
3286         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3287         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3288         assert_eq!(node_txn.len(), 1);
3289         assert_eq!(node_txn[0].input.len(), 1);
3290         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3291         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3292         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3293
3294         check_spends!(node_txn[0], tx);
3295 }
3296
3297 #[test]
3298 fn test_unconf_chan() {
3299         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3300         let chanmon_cfgs = create_chanmon_cfgs(2);
3301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3304         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3305
3306         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3307         assert_eq!(channel_state.by_id.len(), 1);
3308         assert_eq!(channel_state.short_to_id.len(), 1);
3309         mem::drop(channel_state);
3310
3311         let mut headers = Vec::new();
3312         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3313         headers.push(header.clone());
3314         for _i in 2..100 {
3315                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3316                 headers.push(header.clone());
3317         }
3318         let mut height = 99;
3319         while !headers.is_empty() {
3320                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3321                 height -= 1;
3322         }
3323         check_closed_broadcast!(nodes[0], false);
3324         check_added_monitors!(nodes[0], 1);
3325         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3326         assert_eq!(channel_state.by_id.len(), 0);
3327         assert_eq!(channel_state.short_to_id.len(), 0);
3328 }
3329
3330 #[test]
3331 fn test_simple_peer_disconnect() {
3332         // Test that we can reconnect when there are no lost messages
3333         let chanmon_cfgs = create_chanmon_cfgs(3);
3334         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3335         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3336         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3337         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3338         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3339
3340         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3341         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3342         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3343
3344         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3345         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3346         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3347         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3348
3349         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3350         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3351         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3352
3353         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3354         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3355         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3356         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3357
3358         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3359         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3360
3361         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3362         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3363
3364         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3365         {
3366                 let events = nodes[0].node.get_and_clear_pending_events();
3367                 assert_eq!(events.len(), 2);
3368                 match events[0] {
3369                         Event::PaymentSent { payment_preimage } => {
3370                                 assert_eq!(payment_preimage, payment_preimage_3);
3371                         },
3372                         _ => panic!("Unexpected event"),
3373                 }
3374                 match events[1] {
3375                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3376                                 assert_eq!(payment_hash, payment_hash_5);
3377                                 assert!(rejected_by_dest);
3378                         },
3379                         _ => panic!("Unexpected event"),
3380                 }
3381         }
3382
3383         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3384         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3385 }
3386
3387 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3388         // Test that we can reconnect when in-flight HTLC updates get dropped
3389         let chanmon_cfgs = create_chanmon_cfgs(2);
3390         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3391         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3392         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3393         if messages_delivered == 0 {
3394                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3395                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3396         } else {
3397                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3398         }
3399
3400         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3401
3402         let logger = test_utils::TestLogger::new();
3403         let payment_event = {
3404                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3405                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3406                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3407                 check_added_monitors!(nodes[0], 1);
3408
3409                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3410                 assert_eq!(events.len(), 1);
3411                 SendEvent::from_event(events.remove(0))
3412         };
3413         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3414
3415         if messages_delivered < 2 {
3416                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3417         } else {
3418                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3419                 if messages_delivered >= 3 {
3420                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3421                         check_added_monitors!(nodes[1], 1);
3422                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3423
3424                         if messages_delivered >= 4 {
3425                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3426                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3427                                 check_added_monitors!(nodes[0], 1);
3428
3429                                 if messages_delivered >= 5 {
3430                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3431                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3432                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3433                                         check_added_monitors!(nodes[0], 1);
3434
3435                                         if messages_delivered >= 6 {
3436                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3437                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3438                                                 check_added_monitors!(nodes[1], 1);
3439                                         }
3440                                 }
3441                         }
3442                 }
3443         }
3444
3445         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3446         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3447         if messages_delivered < 3 {
3448                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3449                 // received on either side, both sides will need to resend them.
3450                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3451         } else if messages_delivered == 3 {
3452                 // nodes[0] still wants its RAA + commitment_signed
3453                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3454         } else if messages_delivered == 4 {
3455                 // nodes[0] still wants its commitment_signed
3456                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3457         } else if messages_delivered == 5 {
3458                 // nodes[1] still wants its final RAA
3459                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3460         } else if messages_delivered == 6 {
3461                 // Everything was delivered...
3462                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3463         }
3464
3465         let events_1 = nodes[1].node.get_and_clear_pending_events();
3466         assert_eq!(events_1.len(), 1);
3467         match events_1[0] {
3468                 Event::PendingHTLCsForwardable { .. } => { },
3469                 _ => panic!("Unexpected event"),
3470         };
3471
3472         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3473         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3474         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3475
3476         nodes[1].node.process_pending_htlc_forwards();
3477
3478         let events_2 = nodes[1].node.get_and_clear_pending_events();
3479         assert_eq!(events_2.len(), 1);
3480         match events_2[0] {
3481                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3482                         assert_eq!(payment_hash_1, *payment_hash);
3483                         assert_eq!(*payment_secret, None);
3484                         assert_eq!(amt, 1000000);
3485                 },
3486                 _ => panic!("Unexpected event"),
3487         }
3488
3489         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3490         check_added_monitors!(nodes[1], 1);
3491
3492         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3493         assert_eq!(events_3.len(), 1);
3494         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3495                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3496                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3497                         assert!(updates.update_add_htlcs.is_empty());
3498                         assert!(updates.update_fail_htlcs.is_empty());
3499                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3500                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3501                         assert!(updates.update_fee.is_none());
3502                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3503                 },
3504                 _ => panic!("Unexpected event"),
3505         };
3506
3507         if messages_delivered >= 1 {
3508                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3509
3510                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3511                 assert_eq!(events_4.len(), 1);
3512                 match events_4[0] {
3513                         Event::PaymentSent { ref payment_preimage } => {
3514                                 assert_eq!(payment_preimage_1, *payment_preimage);
3515                         },
3516                         _ => panic!("Unexpected event"),
3517                 }
3518
3519                 if messages_delivered >= 2 {
3520                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3521                         check_added_monitors!(nodes[0], 1);
3522                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3523
3524                         if messages_delivered >= 3 {
3525                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3526                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3527                                 check_added_monitors!(nodes[1], 1);
3528
3529                                 if messages_delivered >= 4 {
3530                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3531                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3532                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3533                                         check_added_monitors!(nodes[1], 1);
3534
3535                                         if messages_delivered >= 5 {
3536                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3537                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3538                                                 check_added_monitors!(nodes[0], 1);
3539                                         }
3540                                 }
3541                         }
3542                 }
3543         }
3544
3545         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3546         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3547         if messages_delivered < 2 {
3548                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3549                 //TODO: Deduplicate PaymentSent events, then enable this if:
3550                 //if messages_delivered < 1 {
3551                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3552                         assert_eq!(events_4.len(), 1);
3553                         match events_4[0] {
3554                                 Event::PaymentSent { ref payment_preimage } => {
3555                                         assert_eq!(payment_preimage_1, *payment_preimage);
3556                                 },
3557                                 _ => panic!("Unexpected event"),
3558                         }
3559                 //}
3560         } else if messages_delivered == 2 {
3561                 // nodes[0] still wants its RAA + commitment_signed
3562                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3563         } else if messages_delivered == 3 {
3564                 // nodes[0] still wants its commitment_signed
3565                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3566         } else if messages_delivered == 4 {
3567                 // nodes[1] still wants its final RAA
3568                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3569         } else if messages_delivered == 5 {
3570                 // Everything was delivered...
3571                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3572         }
3573
3574         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3575         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3576         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3577
3578         // Channel should still work fine...
3579         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3580         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3581         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3582         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3583 }
3584
3585 #[test]
3586 fn test_drop_messages_peer_disconnect_a() {
3587         do_test_drop_messages_peer_disconnect(0);
3588         do_test_drop_messages_peer_disconnect(1);
3589         do_test_drop_messages_peer_disconnect(2);
3590         do_test_drop_messages_peer_disconnect(3);
3591 }
3592
3593 #[test]
3594 fn test_drop_messages_peer_disconnect_b() {
3595         do_test_drop_messages_peer_disconnect(4);
3596         do_test_drop_messages_peer_disconnect(5);
3597         do_test_drop_messages_peer_disconnect(6);
3598 }
3599
3600 #[test]
3601 fn test_funding_peer_disconnect() {
3602         // Test that we can lock in our funding tx while disconnected
3603         let chanmon_cfgs = create_chanmon_cfgs(2);
3604         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3605         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3606         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3607         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3608
3609         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3610         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3611
3612         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3613         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3614         assert_eq!(events_1.len(), 1);
3615         match events_1[0] {
3616                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3617                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3618                 },
3619                 _ => panic!("Unexpected event"),
3620         }
3621
3622         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3623
3624         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3625         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3626
3627         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3628         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3629         assert_eq!(events_2.len(), 2);
3630         let funding_locked = match events_2[0] {
3631                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3632                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3633                         msg.clone()
3634                 },
3635                 _ => panic!("Unexpected event"),
3636         };
3637         let bs_announcement_sigs = match events_2[1] {
3638                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3639                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3640                         msg.clone()
3641                 },
3642                 _ => panic!("Unexpected event"),
3643         };
3644
3645         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3646
3647         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3648         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3649         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3650         assert_eq!(events_3.len(), 2);
3651         let as_announcement_sigs = match events_3[0] {
3652                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3653                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3654                         msg.clone()
3655                 },
3656                 _ => panic!("Unexpected event"),
3657         };
3658         let (as_announcement, as_update) = match events_3[1] {
3659                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3660                         (msg.clone(), update_msg.clone())
3661                 },
3662                 _ => panic!("Unexpected event"),
3663         };
3664
3665         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3666         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3667         assert_eq!(events_4.len(), 1);
3668         let (_, bs_update) = match events_4[0] {
3669                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3670                         (msg.clone(), update_msg.clone())
3671                 },
3672                 _ => panic!("Unexpected event"),
3673         };
3674
3675         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3676         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3677         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3678
3679         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3680         let logger = test_utils::TestLogger::new();
3681         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3682         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3683         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3684 }
3685
3686 #[test]
3687 fn test_drop_messages_peer_disconnect_dual_htlc() {
3688         // Test that we can handle reconnecting when both sides of a channel have pending
3689         // commitment_updates when we disconnect.
3690         let chanmon_cfgs = create_chanmon_cfgs(2);
3691         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3692         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3693         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3694         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3695         let logger = test_utils::TestLogger::new();
3696
3697         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3698
3699         // Now try to send a second payment which will fail to send
3700         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3701         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3702         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3703         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3704         check_added_monitors!(nodes[0], 1);
3705
3706         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3707         assert_eq!(events_1.len(), 1);
3708         match events_1[0] {
3709                 MessageSendEvent::UpdateHTLCs { .. } => {},
3710                 _ => panic!("Unexpected event"),
3711         }
3712
3713         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3714         check_added_monitors!(nodes[1], 1);
3715
3716         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3717         assert_eq!(events_2.len(), 1);
3718         match events_2[0] {
3719                 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 } } => {
3720                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3721                         assert!(update_add_htlcs.is_empty());
3722                         assert_eq!(update_fulfill_htlcs.len(), 1);
3723                         assert!(update_fail_htlcs.is_empty());
3724                         assert!(update_fail_malformed_htlcs.is_empty());
3725                         assert!(update_fee.is_none());
3726
3727                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3728                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3729                         assert_eq!(events_3.len(), 1);
3730                         match events_3[0] {
3731                                 Event::PaymentSent { ref payment_preimage } => {
3732                                         assert_eq!(*payment_preimage, payment_preimage_1);
3733                                 },
3734                                 _ => panic!("Unexpected event"),
3735                         }
3736
3737                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3738                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3739                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3740                         check_added_monitors!(nodes[0], 1);
3741                 },
3742                 _ => panic!("Unexpected event"),
3743         }
3744
3745         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3746         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3747
3748         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3749         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3750         assert_eq!(reestablish_1.len(), 1);
3751         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3752         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3753         assert_eq!(reestablish_2.len(), 1);
3754
3755         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3756         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3757         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3758         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3759
3760         assert!(as_resp.0.is_none());
3761         assert!(bs_resp.0.is_none());
3762
3763         assert!(bs_resp.1.is_none());
3764         assert!(bs_resp.2.is_none());
3765
3766         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3767
3768         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3769         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3770         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3771         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3772         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3773         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3774         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3775         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3776         // No commitment_signed so get_event_msg's assert(len == 1) passes
3777         check_added_monitors!(nodes[1], 1);
3778
3779         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3780         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3781         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3782         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3783         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3784         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3785         assert!(bs_second_commitment_signed.update_fee.is_none());
3786         check_added_monitors!(nodes[1], 1);
3787
3788         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3789         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3790         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3791         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3792         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3793         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3794         assert!(as_commitment_signed.update_fee.is_none());
3795         check_added_monitors!(nodes[0], 1);
3796
3797         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3798         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3799         // No commitment_signed so get_event_msg's assert(len == 1) passes
3800         check_added_monitors!(nodes[0], 1);
3801
3802         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3803         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3804         // No commitment_signed so get_event_msg's assert(len == 1) passes
3805         check_added_monitors!(nodes[1], 1);
3806
3807         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3808         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3809         check_added_monitors!(nodes[1], 1);
3810
3811         expect_pending_htlcs_forwardable!(nodes[1]);
3812
3813         let events_5 = nodes[1].node.get_and_clear_pending_events();
3814         assert_eq!(events_5.len(), 1);
3815         match events_5[0] {
3816                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3817                         assert_eq!(payment_hash_2, *payment_hash);
3818                         assert_eq!(*payment_secret, None);
3819                 },
3820                 _ => panic!("Unexpected event"),
3821         }
3822
3823         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3824         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3825         check_added_monitors!(nodes[0], 1);
3826
3827         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3828 }
3829
3830 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3831         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3832         // to avoid our counterparty failing the channel.
3833         let chanmon_cfgs = create_chanmon_cfgs(2);
3834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3836         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3837
3838         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3839         let logger = test_utils::TestLogger::new();
3840
3841         let our_payment_hash = if send_partial_mpp {
3842                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3843                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3844                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
3845                 let payment_secret = PaymentSecret([0xdb; 32]);
3846                 // Use the utility function send_payment_along_path to send the payment with MPP data which
3847                 // indicates there are more HTLCs coming.
3848                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
3849                 check_added_monitors!(nodes[0], 1);
3850                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3851                 assert_eq!(events.len(), 1);
3852                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3853                 // hop should *not* yet generate any PaymentReceived event(s).
3854                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
3855                 our_payment_hash
3856         } else {
3857                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3858         };
3859
3860         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3861         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3862         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3863         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
3864                 header.prev_blockhash = header.bitcoin_hash();
3865                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
3866                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
3867         }
3868
3869         expect_pending_htlcs_forwardable!(nodes[1]);
3870
3871         check_added_monitors!(nodes[1], 1);
3872         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3873         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3874         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3875         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3876         assert!(htlc_timeout_updates.update_fee.is_none());
3877
3878         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3879         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3880         // 100_000 msat as u64, followed by a height of 123 as u32
3881         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3882         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
3883         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3884 }
3885
3886 #[test]
3887 fn test_htlc_timeout() {
3888         do_test_htlc_timeout(true);
3889         do_test_htlc_timeout(false);
3890 }
3891
3892 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
3893         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
3894         let chanmon_cfgs = create_chanmon_cfgs(3);
3895         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3896         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3897         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3898         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3899         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3900         let logger = test_utils::TestLogger::new();
3901
3902         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
3903         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3904         {
3905                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3906                 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3907                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
3908         }
3909         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
3910         check_added_monitors!(nodes[1], 1);
3911
3912         // Now attempt to route a second payment, which should be placed in the holding cell
3913         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3914         if forwarded_htlc {
3915                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3916                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3917                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
3918                 check_added_monitors!(nodes[0], 1);
3919                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
3920                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3921                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3922                 expect_pending_htlcs_forwardable!(nodes[1]);
3923                 check_added_monitors!(nodes[1], 0);
3924         } else {
3925                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3926                 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3927                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
3928                 check_added_monitors!(nodes[1], 0);
3929         }
3930
3931         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3932         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3933         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
3934                 header.prev_blockhash = header.bitcoin_hash();
3935                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
3936         }
3937
3938         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3939         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3940
3941         header.prev_blockhash = header.bitcoin_hash();
3942         nodes[1].block_notifier.block_connected_checked(&header, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, &[], &[]);
3943
3944         if forwarded_htlc {
3945                 expect_pending_htlcs_forwardable!(nodes[1]);
3946                 check_added_monitors!(nodes[1], 1);
3947                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
3948                 assert_eq!(fail_commit.len(), 1);
3949                 match fail_commit[0] {
3950                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
3951                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3952                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
3953                         },
3954                         _ => unreachable!(),
3955                 }
3956                 expect_payment_failed!(nodes[0], second_payment_hash, false);
3957                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
3958                         match update {
3959                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
3960                                 _ => panic!("Unexpected event"),
3961                         }
3962                 } else {
3963                         panic!("Unexpected event");
3964                 }
3965         } else {
3966                 expect_payment_failed!(nodes[1], second_payment_hash, true);
3967         }
3968 }
3969
3970 #[test]
3971 fn test_holding_cell_htlc_add_timeouts() {
3972         do_test_holding_cell_htlc_add_timeouts(false);
3973         do_test_holding_cell_htlc_add_timeouts(true);
3974 }
3975
3976 #[test]
3977 fn test_invalid_channel_announcement() {
3978         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3979         let secp_ctx = Secp256k1::new();
3980         let chanmon_cfgs = create_chanmon_cfgs(2);
3981         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3982         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3983         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3984
3985         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
3986
3987         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3988         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3989         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3990         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3991
3992         nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3993
3994         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3995         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3996
3997         let as_network_key = nodes[0].node.get_our_node_id();
3998         let bs_network_key = nodes[1].node.get_our_node_id();
3999
4000         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4001
4002         let mut chan_announcement;
4003
4004         macro_rules! dummy_unsigned_msg {
4005                 () => {
4006                         msgs::UnsignedChannelAnnouncement {
4007                                 features: ChannelFeatures::known(),
4008                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4009                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4010                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4011                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4012                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4013                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4014                                 excess_data: Vec::new(),
4015                         };
4016                 }
4017         }
4018
4019         macro_rules! sign_msg {
4020                 ($unsigned_msg: expr) => {
4021                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4022                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4023                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4024                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4025                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4026                         chan_announcement = msgs::ChannelAnnouncement {
4027                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4028                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4029                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4030                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4031                                 contents: $unsigned_msg
4032                         }
4033                 }
4034         }
4035
4036         let unsigned_msg = dummy_unsigned_msg!();
4037         sign_msg!(unsigned_msg);
4038         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4039         let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4040
4041         // Configured with Network::Testnet
4042         let mut unsigned_msg = dummy_unsigned_msg!();
4043         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4044         sign_msg!(unsigned_msg);
4045         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4046
4047         let mut unsigned_msg = dummy_unsigned_msg!();
4048         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4049         sign_msg!(unsigned_msg);
4050         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4051 }
4052
4053 #[test]
4054 fn test_no_txn_manager_serialize_deserialize() {
4055         let chanmon_cfgs = create_chanmon_cfgs(2);
4056         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4057         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4058         let logger: test_utils::TestLogger;
4059         let fee_estimator: test_utils::TestFeeEstimator;
4060         let new_chan_monitor: test_utils::TestChannelMonitor;
4061         let keys_manager: test_utils::TestKeysInterface;
4062         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4063         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4064
4065         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4066
4067         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4068
4069         let nodes_0_serialized = nodes[0].node.encode();
4070         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4071         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4072
4073         logger = test_utils::TestLogger::new();
4074         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4075         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4076         nodes[0].chan_monitor = &new_chan_monitor;
4077         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4078         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4079         assert!(chan_0_monitor_read.is_empty());
4080
4081         let mut nodes_0_read = &nodes_0_serialized[..];
4082         let config = UserConfig::default();
4083         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4084         let (_, nodes_0_deserialized_tmp) = {
4085                 let mut channel_monitors = HashMap::new();
4086                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
4087                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4088                         default_config: config,
4089                         keys_manager: &keys_manager,
4090                         fee_estimator: &fee_estimator,
4091                         monitor: nodes[0].chan_monitor,
4092                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4093                         logger: &logger,
4094                         channel_monitors: &mut channel_monitors,
4095                 }).unwrap()
4096         };
4097         nodes_0_deserialized = nodes_0_deserialized_tmp;
4098         assert!(nodes_0_read.is_empty());
4099
4100         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
4101         nodes[0].node = &nodes_0_deserialized;
4102         nodes[0].block_notifier.register_listener(nodes[0].node);
4103         assert_eq!(nodes[0].node.list_channels().len(), 1);
4104         check_added_monitors!(nodes[0], 1);
4105
4106         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4107         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4108         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4109         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4110
4111         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4112         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4113         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4114         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4115
4116         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4117         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4118         for node in nodes.iter() {
4119                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4120                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4121                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4122         }
4123
4124         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4125 }
4126
4127 #[test]
4128 fn test_manager_serialize_deserialize_events() {
4129         // This test makes sure the events field in ChannelManager survives de/serialization
4130         let chanmon_cfgs = create_chanmon_cfgs(2);
4131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4133         let fee_estimator: test_utils::TestFeeEstimator;
4134         let logger: test_utils::TestLogger;
4135         let new_chan_monitor: test_utils::TestChannelMonitor;
4136         let keys_manager: test_utils::TestKeysInterface;
4137         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4138         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4139
4140         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4141         let channel_value = 100000;
4142         let push_msat = 10001;
4143         let a_flags = InitFeatures::known();
4144         let b_flags = InitFeatures::known();
4145         let node_a = nodes.pop().unwrap();
4146         let node_b = nodes.pop().unwrap();
4147         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4148         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4149         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4150
4151         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4152
4153         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4154         check_added_monitors!(node_a, 0);
4155
4156         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4157         {
4158                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4159                 assert_eq!(added_monitors.len(), 1);
4160                 assert_eq!(added_monitors[0].0, funding_output);
4161                 added_monitors.clear();
4162         }
4163
4164         node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4165         {
4166                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4167                 assert_eq!(added_monitors.len(), 1);
4168                 assert_eq!(added_monitors[0].0, funding_output);
4169                 added_monitors.clear();
4170         }
4171         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4172
4173         nodes.push(node_a);
4174         nodes.push(node_b);
4175
4176         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4177         let nodes_0_serialized = nodes[0].node.encode();
4178         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4179         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4180
4181         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4182         logger = test_utils::TestLogger::new();
4183         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4184         nodes[0].chan_monitor = &new_chan_monitor;
4185         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4186         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4187         assert!(chan_0_monitor_read.is_empty());
4188
4189         let mut nodes_0_read = &nodes_0_serialized[..];
4190         let config = UserConfig::default();
4191         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4192         let (_, nodes_0_deserialized_tmp) = {
4193                 let mut channel_monitors = HashMap::new();
4194                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
4195                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4196                         default_config: config,
4197                         keys_manager: &keys_manager,
4198                         fee_estimator: &fee_estimator,
4199                         monitor: nodes[0].chan_monitor,
4200                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4201                         logger: &logger,
4202                         channel_monitors: &mut channel_monitors,
4203                 }).unwrap()
4204         };
4205         nodes_0_deserialized = nodes_0_deserialized_tmp;
4206         assert!(nodes_0_read.is_empty());
4207
4208         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4209
4210         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
4211         nodes[0].node = &nodes_0_deserialized;
4212
4213         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4214         let events_4 = nodes[0].node.get_and_clear_pending_events();
4215         assert_eq!(events_4.len(), 1);
4216         match events_4[0] {
4217                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4218                         assert_eq!(user_channel_id, 42);
4219                         assert_eq!(*funding_txo, funding_output);
4220                 },
4221                 _ => panic!("Unexpected event"),
4222         };
4223
4224         // Make sure the channel is functioning as though the de/serialization never happened
4225         nodes[0].block_notifier.register_listener(nodes[0].node);
4226         assert_eq!(nodes[0].node.list_channels().len(), 1);
4227         check_added_monitors!(nodes[0], 1);
4228
4229         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4230         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4231         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4232         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4233
4234         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4235         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4236         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4237         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4238
4239         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4240         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4241         for node in nodes.iter() {
4242                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4243                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4244                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4245         }
4246
4247         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4248 }
4249
4250 #[test]
4251 fn test_simple_manager_serialize_deserialize() {
4252         let chanmon_cfgs = create_chanmon_cfgs(2);
4253         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4254         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4255         let logger: test_utils::TestLogger;
4256         let fee_estimator: test_utils::TestFeeEstimator;
4257         let new_chan_monitor: test_utils::TestChannelMonitor;
4258         let keys_manager: test_utils::TestKeysInterface;
4259         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4260         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4261         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4262
4263         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4264         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4265
4266         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4267
4268         let nodes_0_serialized = nodes[0].node.encode();
4269         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4270         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4271
4272         logger = test_utils::TestLogger::new();
4273         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4274         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4275         nodes[0].chan_monitor = &new_chan_monitor;
4276         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4277         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4278         assert!(chan_0_monitor_read.is_empty());
4279
4280         let mut nodes_0_read = &nodes_0_serialized[..];
4281         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4282         let (_, nodes_0_deserialized_tmp) = {
4283                 let mut channel_monitors = HashMap::new();
4284                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
4285                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4286                         default_config: UserConfig::default(),
4287                         keys_manager: &keys_manager,
4288                         fee_estimator: &fee_estimator,
4289                         monitor: nodes[0].chan_monitor,
4290                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4291                         logger: &logger,
4292                         channel_monitors: &mut channel_monitors,
4293                 }).unwrap()
4294         };
4295         nodes_0_deserialized = nodes_0_deserialized_tmp;
4296         assert!(nodes_0_read.is_empty());
4297
4298         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
4299         nodes[0].node = &nodes_0_deserialized;
4300         check_added_monitors!(nodes[0], 1);
4301
4302         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4303
4304         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4305         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4306 }
4307
4308 #[test]
4309 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4310         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4311         let chanmon_cfgs = create_chanmon_cfgs(4);
4312         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4313         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4314         let logger: test_utils::TestLogger;
4315         let fee_estimator: test_utils::TestFeeEstimator;
4316         let new_chan_monitor: test_utils::TestChannelMonitor;
4317         let keys_manager: test_utils::TestKeysInterface;
4318         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4319         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4320         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4321         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4322         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4323
4324         let mut node_0_stale_monitors_serialized = Vec::new();
4325         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4326                 let mut writer = test_utils::TestVecWriter(Vec::new());
4327                 monitor.1.write_for_disk(&mut writer).unwrap();
4328                 node_0_stale_monitors_serialized.push(writer.0);
4329         }
4330
4331         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4332
4333         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4334         let nodes_0_serialized = nodes[0].node.encode();
4335
4336         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4337         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4338         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4339         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4340
4341         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4342         // nodes[3])
4343         let mut node_0_monitors_serialized = Vec::new();
4344         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4345                 let mut writer = test_utils::TestVecWriter(Vec::new());
4346                 monitor.1.write_for_disk(&mut writer).unwrap();
4347                 node_0_monitors_serialized.push(writer.0);
4348         }
4349
4350         logger = test_utils::TestLogger::new();
4351         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4352         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4353         nodes[0].chan_monitor = &new_chan_monitor;
4354
4355         let mut node_0_stale_monitors = Vec::new();
4356         for serialized in node_0_stale_monitors_serialized.iter() {
4357                 let mut read = &serialized[..];
4358                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4359                 assert!(read.is_empty());
4360                 node_0_stale_monitors.push(monitor);
4361         }
4362
4363         let mut node_0_monitors = Vec::new();
4364         for serialized in node_0_monitors_serialized.iter() {
4365                 let mut read = &serialized[..];
4366                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4367                 assert!(read.is_empty());
4368                 node_0_monitors.push(monitor);
4369         }
4370
4371         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4372
4373         let mut nodes_0_read = &nodes_0_serialized[..];
4374         if let Err(msgs::DecodeError::InvalidValue) =
4375                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4376                 default_config: UserConfig::default(),
4377                 keys_manager: &keys_manager,
4378                 fee_estimator: &fee_estimator,
4379                 monitor: nodes[0].chan_monitor,
4380                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4381                 logger: &logger,
4382                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
4383         }) { } else {
4384                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4385         };
4386
4387         let mut nodes_0_read = &nodes_0_serialized[..];
4388         let (_, nodes_0_deserialized_tmp) =
4389                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4390                 default_config: UserConfig::default(),
4391                 keys_manager: &keys_manager,
4392                 fee_estimator: &fee_estimator,
4393                 monitor: nodes[0].chan_monitor,
4394                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4395                 logger: &logger,
4396                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
4397         }).unwrap();
4398         nodes_0_deserialized = nodes_0_deserialized_tmp;
4399         assert!(nodes_0_read.is_empty());
4400
4401         { // Channel close should result in a commitment tx and an HTLC tx
4402                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4403                 assert_eq!(txn.len(), 2);
4404                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4405                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4406         }
4407
4408         for monitor in node_0_monitors.drain(..) {
4409                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo(), monitor).is_ok());
4410                 check_added_monitors!(nodes[0], 1);
4411         }
4412         nodes[0].node = &nodes_0_deserialized;
4413
4414         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4415         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4416         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4417         //... and we can even still claim the payment!
4418         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4419
4420         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4421         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4422         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4423         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4424         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4425         assert_eq!(msg_events.len(), 1);
4426         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4427                 match action {
4428                         &ErrorAction::SendErrorMessage { ref msg } => {
4429                                 assert_eq!(msg.channel_id, channel_id);
4430                         },
4431                         _ => panic!("Unexpected event!"),
4432                 }
4433         }
4434 }
4435
4436 macro_rules! check_spendable_outputs {
4437         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4438                 {
4439                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4440                         let mut txn = Vec::new();
4441                         for event in events {
4442                                 match event {
4443                                         Event::SpendableOutputs { ref outputs } => {
4444                                                 for outp in outputs {
4445                                                         match *outp {
4446                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4447                                                                         let input = TxIn {
4448                                                                                 previous_output: outpoint.clone(),
4449                                                                                 script_sig: Script::new(),
4450                                                                                 sequence: 0,
4451                                                                                 witness: Vec::new(),
4452                                                                         };
4453                                                                         let outp = TxOut {
4454                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4455                                                                                 value: output.value,
4456                                                                         };
4457                                                                         let mut spend_tx = Transaction {
4458                                                                                 version: 2,
4459                                                                                 lock_time: 0,
4460                                                                                 input: vec![input],
4461                                                                                 output: vec![outp],
4462                                                                         };
4463                                                                         let secp_ctx = Secp256k1::new();
4464                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4465                                                                         let remotepubkey = keys.pubkeys().payment_point;
4466                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4467                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4468                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4469                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4470                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4471                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4472                                                                         txn.push(spend_tx);
4473                                                                 },
4474                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4475                                                                         let input = TxIn {
4476                                                                                 previous_output: outpoint.clone(),
4477                                                                                 script_sig: Script::new(),
4478                                                                                 sequence: *to_self_delay as u32,
4479                                                                                 witness: Vec::new(),
4480                                                                         };
4481                                                                         let outp = TxOut {
4482                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4483                                                                                 value: output.value,
4484                                                                         };
4485                                                                         let mut spend_tx = Transaction {
4486                                                                                 version: 2,
4487                                                                                 lock_time: 0,
4488                                                                                 input: vec![input],
4489                                                                                 output: vec![outp],
4490                                                                         };
4491                                                                         let secp_ctx = Secp256k1::new();
4492                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4493                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4494
4495                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4496                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4497                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4498                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4499                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4500                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4501                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4502                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4503                                                                         } else { panic!() }
4504                                                                         txn.push(spend_tx);
4505                                                                 },
4506                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4507                                                                         let secp_ctx = Secp256k1::new();
4508                                                                         let input = TxIn {
4509                                                                                 previous_output: outpoint.clone(),
4510                                                                                 script_sig: Script::new(),
4511                                                                                 sequence: 0,
4512                                                                                 witness: Vec::new(),
4513                                                                         };
4514                                                                         let outp = TxOut {
4515                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4516                                                                                 value: output.value,
4517                                                                         };
4518                                                                         let mut spend_tx = Transaction {
4519                                                                                 version: 2,
4520                                                                                 lock_time: 0,
4521                                                                                 input: vec![input],
4522                                                                                 output: vec![outp.clone()],
4523                                                                         };
4524                                                                         let secret = {
4525                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4526                                                                                         Ok(master_key) => {
4527                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4528                                                                                                         Ok(key) => key,
4529                                                                                                         Err(_) => panic!("Your RNG is busted"),
4530                                                                                                 }
4531                                                                                         }
4532                                                                                         Err(_) => panic!("Your rng is busted"),
4533                                                                                 }
4534                                                                         };
4535                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4536                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4537                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4538                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4539                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4540                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4541                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4542                                                                         txn.push(spend_tx);
4543                                                                 },
4544                                                         }
4545                                                 }
4546                                         },
4547                                         _ => panic!("Unexpected event"),
4548                                 };
4549                         }
4550                         txn
4551                 }
4552         }
4553 }
4554
4555 #[test]
4556 fn test_claim_sizeable_push_msat() {
4557         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4558         let chanmon_cfgs = create_chanmon_cfgs(2);
4559         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4560         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4561         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4562
4563         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4564         nodes[1].node.force_close_channel(&chan.2);
4565         check_closed_broadcast!(nodes[1], false);
4566         check_added_monitors!(nodes[1], 1);
4567         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4568         assert_eq!(node_txn.len(), 1);
4569         check_spends!(node_txn[0], chan.3);
4570         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
4571
4572         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4573         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4574         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4575
4576         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4577         assert_eq!(spend_txn.len(), 1);
4578         check_spends!(spend_txn[0], node_txn[0]);
4579 }
4580
4581 #[test]
4582 fn test_claim_on_remote_sizeable_push_msat() {
4583         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4584         // to_remote output is encumbered by a P2WPKH
4585         let chanmon_cfgs = create_chanmon_cfgs(2);
4586         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4587         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4588         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4589
4590         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4591         nodes[0].node.force_close_channel(&chan.2);
4592         check_closed_broadcast!(nodes[0], false);
4593         check_added_monitors!(nodes[0], 1);
4594
4595         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4596         assert_eq!(node_txn.len(), 1);
4597         check_spends!(node_txn[0], chan.3);
4598         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
4599
4600         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4601         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4602         check_closed_broadcast!(nodes[1], false);
4603         check_added_monitors!(nodes[1], 1);
4604         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4605
4606         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4607         assert_eq!(spend_txn.len(), 2);
4608         assert_eq!(spend_txn[0], spend_txn[1]);
4609         check_spends!(spend_txn[0], node_txn[0]);
4610 }
4611
4612 #[test]
4613 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4614         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4615         // to_remote output is encumbered by a P2WPKH
4616
4617         let chanmon_cfgs = create_chanmon_cfgs(2);
4618         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4619         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4620         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4621
4622         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4623         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4624         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4625         assert_eq!(revoked_local_txn[0].input.len(), 1);
4626         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4627
4628         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4629         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4630         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4631         check_closed_broadcast!(nodes[1], false);
4632         check_added_monitors!(nodes[1], 1);
4633
4634         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4635         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4636         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4637         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4638
4639         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4640         assert_eq!(spend_txn.len(), 3);
4641         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4642         check_spends!(spend_txn[0], revoked_local_txn[0]);
4643         check_spends!(spend_txn[2], node_txn[0]);
4644 }
4645
4646 #[test]
4647 fn test_static_spendable_outputs_preimage_tx() {
4648         let chanmon_cfgs = create_chanmon_cfgs(2);
4649         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4651         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4652
4653         // Create some initial channels
4654         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4655
4656         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4657
4658         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4659         assert_eq!(commitment_tx[0].input.len(), 1);
4660         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4661
4662         // Settle A's commitment tx on B's chain
4663         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4664         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4665         check_added_monitors!(nodes[1], 1);
4666         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4667         check_added_monitors!(nodes[1], 1);
4668         let events = nodes[1].node.get_and_clear_pending_msg_events();
4669         match events[0] {
4670                 MessageSendEvent::UpdateHTLCs { .. } => {},
4671                 _ => panic!("Unexpected event"),
4672         }
4673         match events[1] {
4674                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4675                 _ => panic!("Unexepected event"),
4676         }
4677
4678         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4679         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4680         assert_eq!(node_txn.len(), 3);
4681         check_spends!(node_txn[0], commitment_tx[0]);
4682         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4683         check_spends!(node_txn[1], chan_1.3);
4684         check_spends!(node_txn[2], node_txn[1]);
4685
4686         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4687         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4688         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4689
4690         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4691         assert_eq!(spend_txn.len(), 1);
4692         check_spends!(spend_txn[0], node_txn[0]);
4693 }
4694
4695 #[test]
4696 fn test_static_spendable_outputs_timeout_tx() {
4697         let chanmon_cfgs = create_chanmon_cfgs(2);
4698         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4699         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4700         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4701
4702         // Create some initial channels
4703         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4704
4705         // Rebalance the network a bit by relaying one payment through all the channels ...
4706         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4707
4708         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4709
4710         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4711         assert_eq!(commitment_tx[0].input.len(), 1);
4712         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4713
4714         // Settle A's commitment tx on B' chain
4715         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4716         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4717         check_added_monitors!(nodes[1], 1);
4718         let events = nodes[1].node.get_and_clear_pending_msg_events();
4719         match events[0] {
4720                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4721                 _ => panic!("Unexpected event"),
4722         }
4723
4724         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4725         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4726         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4727         check_spends!(node_txn[0],  commitment_tx[0].clone());
4728         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4729         check_spends!(node_txn[1], chan_1.3.clone());
4730         check_spends!(node_txn[2], node_txn[1]);
4731
4732         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4733         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4734         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4735         expect_payment_failed!(nodes[1], our_payment_hash, true);
4736
4737         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4738         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4739         check_spends!(spend_txn[2], node_txn[0].clone());
4740 }
4741
4742 #[test]
4743 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4744         let chanmon_cfgs = create_chanmon_cfgs(2);
4745         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4746         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4747         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4748
4749         // Create some initial channels
4750         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4751
4752         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4753         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4754         assert_eq!(revoked_local_txn[0].input.len(), 1);
4755         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4756
4757         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4758
4759         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4760         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4761         check_closed_broadcast!(nodes[1], false);
4762         check_added_monitors!(nodes[1], 1);
4763
4764         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4765         assert_eq!(node_txn.len(), 2);
4766         assert_eq!(node_txn[0].input.len(), 2);
4767         check_spends!(node_txn[0], revoked_local_txn[0]);
4768
4769         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4770         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4771         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4772
4773         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4774         assert_eq!(spend_txn.len(), 1);
4775         check_spends!(spend_txn[0], node_txn[0]);
4776 }
4777
4778 #[test]
4779 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4780         let chanmon_cfgs = create_chanmon_cfgs(2);
4781         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4782         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4783         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4784
4785         // Create some initial channels
4786         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4787
4788         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4789         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4790         assert_eq!(revoked_local_txn[0].input.len(), 1);
4791         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4792
4793         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4794
4795         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4796         // A will generate HTLC-Timeout from revoked commitment tx
4797         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4798         check_closed_broadcast!(nodes[0], false);
4799         check_added_monitors!(nodes[0], 1);
4800
4801         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4802         assert_eq!(revoked_htlc_txn.len(), 2);
4803         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4804         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4805         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4806         check_spends!(revoked_htlc_txn[1], chan_1.3);
4807
4808         // B will generate justice tx from A's revoked commitment/HTLC tx
4809         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4810         check_closed_broadcast!(nodes[1], false);
4811         check_added_monitors!(nodes[1], 1);
4812
4813         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4814         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
4815         assert_eq!(node_txn[0].input.len(), 2);
4816         check_spends!(node_txn[0], revoked_local_txn[0]);
4817         check_spends!(node_txn[1], chan_1.3);
4818         assert_eq!(node_txn[2].input.len(), 1);
4819         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4820         assert_eq!(node_txn[3].input.len(), 1);
4821         check_spends!(node_txn[3], revoked_local_txn[0]);
4822
4823         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4824         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4825         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4826
4827         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4828         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4829         assert_eq!(spend_txn.len(), 2);
4830         check_spends!(spend_txn[0], node_txn[0]);
4831         check_spends!(spend_txn[1], node_txn[2]);
4832 }
4833
4834 #[test]
4835 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4836         let chanmon_cfgs = create_chanmon_cfgs(2);
4837         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4838         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4839         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4840
4841         // Create some initial channels
4842         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4843
4844         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4845         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4846         assert_eq!(revoked_local_txn[0].input.len(), 1);
4847         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4848
4849         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4850
4851         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4852         // B will generate HTLC-Success from revoked commitment tx
4853         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4854         check_closed_broadcast!(nodes[1], false);
4855         check_added_monitors!(nodes[1], 1);
4856         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4857
4858         assert_eq!(revoked_htlc_txn.len(), 2);
4859         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4860         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4861         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4862
4863         // A will generate justice tx from B's revoked commitment/HTLC tx
4864         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4865         check_closed_broadcast!(nodes[0], false);
4866         check_added_monitors!(nodes[0], 1);
4867
4868         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4869         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4870         assert_eq!(node_txn[2].input.len(), 1);
4871         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4872
4873         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4874         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4875         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4876
4877         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4878         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
4879         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4880         assert_eq!(spend_txn[0], spend_txn[1]);
4881         assert_eq!(spend_txn[0], spend_txn[2]);
4882         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4883         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4884         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4885 }
4886
4887 #[test]
4888 fn test_onchain_to_onchain_claim() {
4889         // Test that in case of channel closure, we detect the state of output thanks to
4890         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4891         // First, have C claim an HTLC against its own latest commitment transaction.
4892         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4893         // channel.
4894         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4895         // gets broadcast.
4896
4897         let chanmon_cfgs = create_chanmon_cfgs(3);
4898         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4899         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4900         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4901
4902         // Create some initial channels
4903         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4904         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4905
4906         // Rebalance the network a bit by relaying one payment through all the channels ...
4907         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4908         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4909
4910         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4911         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4912         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4913         check_spends!(commitment_tx[0], chan_2.3);
4914         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4915         check_added_monitors!(nodes[2], 1);
4916         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4917         assert!(updates.update_add_htlcs.is_empty());
4918         assert!(updates.update_fail_htlcs.is_empty());
4919         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4920         assert!(updates.update_fail_malformed_htlcs.is_empty());
4921
4922         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4923         check_closed_broadcast!(nodes[2], false);
4924         check_added_monitors!(nodes[2], 1);
4925
4926         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4927         assert_eq!(c_txn.len(), 3);
4928         assert_eq!(c_txn[0], c_txn[2]);
4929         assert_eq!(commitment_tx[0], c_txn[1]);
4930         check_spends!(c_txn[1], chan_2.3);
4931         check_spends!(c_txn[2], c_txn[1]);
4932         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4933         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4934         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4935         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4936
4937         // 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
4938         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4939         {
4940                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4941                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4942                 assert_eq!(b_txn.len(), 3);
4943                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4944                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4945                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4946                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4947                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4948                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4949                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4950                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4951                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4952                 b_txn.clear();
4953         }
4954         check_added_monitors!(nodes[1], 1);
4955         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4956         check_added_monitors!(nodes[1], 1);
4957         match msg_events[0] {
4958                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4959                 _ => panic!("Unexpected event"),
4960         }
4961         match msg_events[1] {
4962                 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, .. } } => {
4963                         assert!(update_add_htlcs.is_empty());
4964                         assert!(update_fail_htlcs.is_empty());
4965                         assert_eq!(update_fulfill_htlcs.len(), 1);
4966                         assert!(update_fail_malformed_htlcs.is_empty());
4967                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4968                 },
4969                 _ => panic!("Unexpected event"),
4970         };
4971         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4972         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4973         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4974         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4975         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4976         assert_eq!(b_txn.len(), 3);
4977         check_spends!(b_txn[1], chan_1.3);
4978         check_spends!(b_txn[2], b_txn[1]);
4979         check_spends!(b_txn[0], commitment_tx[0]);
4980         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4981         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4982         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4983
4984         check_closed_broadcast!(nodes[1], false);
4985         check_added_monitors!(nodes[1], 1);
4986 }
4987
4988 #[test]
4989 fn test_duplicate_payment_hash_one_failure_one_success() {
4990         // Topology : A --> B --> C
4991         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4992         let chanmon_cfgs = create_chanmon_cfgs(3);
4993         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4994         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4995         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4996
4997         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4998         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4999
5000         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5001         *nodes[0].network_payment_count.borrow_mut() -= 1;
5002         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5003
5004         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5005         assert_eq!(commitment_txn[0].input.len(), 1);
5006         check_spends!(commitment_txn[0], chan_2.3);
5007
5008         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5009         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5010         check_closed_broadcast!(nodes[1], false);
5011         check_added_monitors!(nodes[1], 1);
5012
5013         let htlc_timeout_tx;
5014         { // Extract one of the two HTLC-Timeout transaction
5015                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5016                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5017                 assert_eq!(node_txn.len(), 5);
5018                 check_spends!(node_txn[0], commitment_txn[0]);
5019                 assert_eq!(node_txn[0].input.len(), 1);
5020                 check_spends!(node_txn[1], commitment_txn[0]);
5021                 assert_eq!(node_txn[1].input.len(), 1);
5022                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5023                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5024                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5025                 check_spends!(node_txn[2], chan_2.3);
5026                 check_spends!(node_txn[3], node_txn[2]);
5027                 check_spends!(node_txn[4], node_txn[2]);
5028                 htlc_timeout_tx = node_txn[1].clone();
5029         }
5030
5031         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5032         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5033         check_added_monitors!(nodes[2], 3);
5034         let events = nodes[2].node.get_and_clear_pending_msg_events();
5035         match events[0] {
5036                 MessageSendEvent::UpdateHTLCs { .. } => {},
5037                 _ => panic!("Unexpected event"),
5038         }
5039         match events[1] {
5040                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5041                 _ => panic!("Unexepected event"),
5042         }
5043         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5044         assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
5045         check_spends!(htlc_success_txn[2], chan_2.3);
5046         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5047         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5048         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5049         assert_eq!(htlc_success_txn[0].input.len(), 1);
5050         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5051         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5052         assert_eq!(htlc_success_txn[1].input.len(), 1);
5053         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5054         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5055         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5056         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5057
5058         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5059         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5060         expect_pending_htlcs_forwardable!(nodes[1]);
5061         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5062         assert!(htlc_updates.update_add_htlcs.is_empty());
5063         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5064         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5065         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5066         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5067         check_added_monitors!(nodes[1], 1);
5068
5069         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5070         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5071         {
5072                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5073                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5074                 assert_eq!(events.len(), 1);
5075                 match events[0] {
5076                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5077                         },
5078                         _ => { panic!("Unexpected event"); }
5079                 }
5080         }
5081         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5082
5083         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5084         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5085         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5086         assert!(updates.update_add_htlcs.is_empty());
5087         assert!(updates.update_fail_htlcs.is_empty());
5088         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5089         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5090         assert!(updates.update_fail_malformed_htlcs.is_empty());
5091         check_added_monitors!(nodes[1], 1);
5092
5093         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5094         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5095
5096         let events = nodes[0].node.get_and_clear_pending_events();
5097         match events[0] {
5098                 Event::PaymentSent { ref payment_preimage } => {
5099                         assert_eq!(*payment_preimage, our_payment_preimage);
5100                 }
5101                 _ => panic!("Unexpected event"),
5102         }
5103 }
5104
5105 #[test]
5106 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5107         let chanmon_cfgs = create_chanmon_cfgs(2);
5108         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5109         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5110         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5111
5112         // Create some initial channels
5113         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5114
5115         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5116         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5117         assert_eq!(local_txn[0].input.len(), 1);
5118         check_spends!(local_txn[0], chan_1.3);
5119
5120         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5121         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5122         check_added_monitors!(nodes[1], 1);
5123         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5124         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5125         check_added_monitors!(nodes[1], 1);
5126         let events = nodes[1].node.get_and_clear_pending_msg_events();
5127         match events[0] {
5128                 MessageSendEvent::UpdateHTLCs { .. } => {},
5129                 _ => panic!("Unexpected event"),
5130         }
5131         match events[1] {
5132                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5133                 _ => panic!("Unexepected event"),
5134         }
5135         let node_txn = {
5136                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5137                 assert_eq!(node_txn[0].input.len(), 1);
5138                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5139                 check_spends!(node_txn[0], local_txn[0]);
5140                 vec![node_txn[0].clone(), node_txn[2].clone()]
5141         };
5142
5143         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5144         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5145         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5146
5147         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5148         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5149         assert_eq!(spend_txn.len(), 2);
5150         check_spends!(spend_txn[0], node_txn[0]);
5151         check_spends!(spend_txn[1], node_txn[1]);
5152 }
5153
5154 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5155         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5156         // unrevoked commitment transaction.
5157         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5158         // a remote RAA before they could be failed backwards (and combinations thereof).
5159         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5160         // use the same payment hashes.
5161         // Thus, we use a six-node network:
5162         //
5163         // A \         / E
5164         //    - C - D -
5165         // B /         \ F
5166         // And test where C fails back to A/B when D announces its latest commitment transaction
5167         let chanmon_cfgs = create_chanmon_cfgs(6);
5168         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5169         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5170         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5171         let logger = test_utils::TestLogger::new();
5172
5173         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5174         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5175         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5176         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5177         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5178
5179         // Rebalance and check output sanity...
5180         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5181         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5182         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5183
5184         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5185         // 0th HTLC:
5186         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
5187         // 1st HTLC:
5188         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
5189         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5190         let our_node_id = &nodes[1].node.get_our_node_id();
5191         let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5192         // 2nd HTLC:
5193         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
5194         // 3rd HTLC:
5195         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
5196         // 4th HTLC:
5197         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5198         // 5th HTLC:
5199         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5200         let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5201         // 6th HTLC:
5202         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5203         // 7th HTLC:
5204         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5205
5206         // 8th HTLC:
5207         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5208         // 9th HTLC:
5209         let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5210         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
5211
5212         // 10th HTLC:
5213         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
5214         // 11th HTLC:
5215         let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5216         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5217
5218         // Double-check that six of the new HTLC were added
5219         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5220         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5221         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5222         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5223
5224         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5225         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5226         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5227         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5228         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5229         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5230         check_added_monitors!(nodes[4], 0);
5231         expect_pending_htlcs_forwardable!(nodes[4]);
5232         check_added_monitors!(nodes[4], 1);
5233
5234         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5235         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5236         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5237         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5238         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5239         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5240
5241         // Fail 3rd below-dust and 7th above-dust HTLCs
5242         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5243         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5244         check_added_monitors!(nodes[5], 0);
5245         expect_pending_htlcs_forwardable!(nodes[5]);
5246         check_added_monitors!(nodes[5], 1);
5247
5248         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5249         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5250         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5251         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5252
5253         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5254
5255         expect_pending_htlcs_forwardable!(nodes[3]);
5256         check_added_monitors!(nodes[3], 1);
5257         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5258         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5259         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5260         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5261         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5262         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5263         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5264         if deliver_last_raa {
5265                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5266         } else {
5267                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5268         }
5269
5270         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5271         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5272         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5273         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5274         //
5275         // We now broadcast the latest commitment transaction, which *should* result in failures for
5276         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5277         // the non-broadcast above-dust HTLCs.
5278         //
5279         // Alternatively, we may broadcast the previous commitment transaction, which should only
5280         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5281         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5282
5283         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5284         if announce_latest {
5285                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5286         } else {
5287                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5288         }
5289         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5290         check_closed_broadcast!(nodes[2], false);
5291         expect_pending_htlcs_forwardable!(nodes[2]);
5292         check_added_monitors!(nodes[2], 3);
5293
5294         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5295         assert_eq!(cs_msgs.len(), 2);
5296         let mut a_done = false;
5297         for msg in cs_msgs {
5298                 match msg {
5299                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5300                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5301                                 // should be failed-backwards here.
5302                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5303                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5304                                         for htlc in &updates.update_fail_htlcs {
5305                                                 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 });
5306                                         }
5307                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5308                                         assert!(!a_done);
5309                                         a_done = true;
5310                                         &nodes[0]
5311                                 } else {
5312                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5313                                         for htlc in &updates.update_fail_htlcs {
5314                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5315                                         }
5316                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5317                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5318                                         &nodes[1]
5319                                 };
5320                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5321                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5322                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5323                                 if announce_latest {
5324                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5325                                         if *node_id == nodes[0].node.get_our_node_id() {
5326                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5327                                         }
5328                                 }
5329                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5330                         },
5331                         _ => panic!("Unexpected event"),
5332                 }
5333         }
5334
5335         let as_events = nodes[0].node.get_and_clear_pending_events();
5336         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5337         let mut as_failds = HashSet::new();
5338         for event in as_events.iter() {
5339                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5340                         assert!(as_failds.insert(*payment_hash));
5341                         if *payment_hash != payment_hash_2 {
5342                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5343                         } else {
5344                                 assert!(!rejected_by_dest);
5345                         }
5346                 } else { panic!("Unexpected event"); }
5347         }
5348         assert!(as_failds.contains(&payment_hash_1));
5349         assert!(as_failds.contains(&payment_hash_2));
5350         if announce_latest {
5351                 assert!(as_failds.contains(&payment_hash_3));
5352                 assert!(as_failds.contains(&payment_hash_5));
5353         }
5354         assert!(as_failds.contains(&payment_hash_6));
5355
5356         let bs_events = nodes[1].node.get_and_clear_pending_events();
5357         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5358         let mut bs_failds = HashSet::new();
5359         for event in bs_events.iter() {
5360                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5361                         assert!(bs_failds.insert(*payment_hash));
5362                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5363                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5364                         } else {
5365                                 assert!(!rejected_by_dest);
5366                         }
5367                 } else { panic!("Unexpected event"); }
5368         }
5369         assert!(bs_failds.contains(&payment_hash_1));
5370         assert!(bs_failds.contains(&payment_hash_2));
5371         if announce_latest {
5372                 assert!(bs_failds.contains(&payment_hash_4));
5373         }
5374         assert!(bs_failds.contains(&payment_hash_5));
5375
5376         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5377         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5378         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5379         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5380         // PaymentFailureNetworkUpdates.
5381         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5382         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5383         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5384         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5385         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5386                 match event {
5387                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5388                         _ => panic!("Unexpected event"),
5389                 }
5390         }
5391 }
5392
5393 #[test]
5394 fn test_fail_backwards_latest_remote_announce_a() {
5395         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5396 }
5397
5398 #[test]
5399 fn test_fail_backwards_latest_remote_announce_b() {
5400         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5401 }
5402
5403 #[test]
5404 fn test_fail_backwards_previous_remote_announce() {
5405         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5406         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5407         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5408 }
5409
5410 #[test]
5411 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5412         let chanmon_cfgs = create_chanmon_cfgs(2);
5413         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5414         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5415         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5416
5417         // Create some initial channels
5418         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5419
5420         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5421         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5422         assert_eq!(local_txn[0].input.len(), 1);
5423         check_spends!(local_txn[0], chan_1.3);
5424
5425         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5426         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5427         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5428         check_closed_broadcast!(nodes[0], false);
5429         check_added_monitors!(nodes[0], 1);
5430
5431         let htlc_timeout = {
5432                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5433                 assert_eq!(node_txn[0].input.len(), 1);
5434                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5435                 check_spends!(node_txn[0], local_txn[0]);
5436                 node_txn[0].clone()
5437         };
5438
5439         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5440         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5441         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5442         expect_payment_failed!(nodes[0], our_payment_hash, true);
5443
5444         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5445         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5446         assert_eq!(spend_txn.len(), 3);
5447         assert_eq!(spend_txn[0], spend_txn[1]);
5448         check_spends!(spend_txn[0], local_txn[0]);
5449         check_spends!(spend_txn[2], htlc_timeout);
5450 }
5451
5452 #[test]
5453 fn test_key_derivation_params() {
5454         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5455         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5456         // let us re-derive the channel key set to then derive a delayed_payment_key.
5457
5458         let chanmon_cfgs = create_chanmon_cfgs(3);
5459
5460         // We manually create the node configuration to backup the seed.
5461         let seed = [42; 32];
5462         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5463         let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5464         let node = NodeCfg { chain_monitor: &chanmon_cfgs[0].chain_monitor, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chan_monitor, keys_manager, node_seed: seed };
5465         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5466         node_cfgs.remove(0);
5467         node_cfgs.insert(0, node);
5468
5469         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5470         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5471
5472         // Create some initial channels
5473         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5474         // for node 0
5475         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5476         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5477         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5478
5479         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5480         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5481         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5482         assert_eq!(local_txn_1[0].input.len(), 1);
5483         check_spends!(local_txn_1[0], chan_1.3);
5484
5485         // We check funding pubkey are unique
5486         let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5487         let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5488         if from_0_funding_key_0 == from_1_funding_key_0
5489             || from_0_funding_key_0 == from_1_funding_key_1
5490             || from_0_funding_key_1 == from_1_funding_key_0
5491             || from_0_funding_key_1 == from_1_funding_key_1 {
5492                 panic!("Funding pubkeys aren't unique");
5493         }
5494
5495         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5496         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5497         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5498         check_closed_broadcast!(nodes[0], false);
5499         check_added_monitors!(nodes[0], 1);
5500
5501         let htlc_timeout = {
5502                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5503                 assert_eq!(node_txn[0].input.len(), 1);
5504                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5505                 check_spends!(node_txn[0], local_txn_1[0]);
5506                 node_txn[0].clone()
5507         };
5508
5509         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5510         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5511         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5512         expect_payment_failed!(nodes[0], our_payment_hash, true);
5513
5514         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5515         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5516         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5517         assert_eq!(spend_txn.len(), 3);
5518         assert_eq!(spend_txn[0], spend_txn[1]);
5519         check_spends!(spend_txn[0], local_txn_1[0]);
5520         check_spends!(spend_txn[2], htlc_timeout);
5521 }
5522
5523 #[test]
5524 fn test_static_output_closing_tx() {
5525         let chanmon_cfgs = create_chanmon_cfgs(2);
5526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5528         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5529
5530         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5531
5532         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5533         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5534
5535         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5536         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5537         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5538
5539         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5540         assert_eq!(spend_txn.len(), 1);
5541         check_spends!(spend_txn[0], closing_tx);
5542
5543         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5544         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5545
5546         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5547         assert_eq!(spend_txn.len(), 1);
5548         check_spends!(spend_txn[0], closing_tx);
5549 }
5550
5551 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5552         let chanmon_cfgs = create_chanmon_cfgs(2);
5553         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5554         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5555         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5556         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5557
5558         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5559
5560         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5561         // present in B's local commitment transaction, but none of A's commitment transactions.
5562         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5563         check_added_monitors!(nodes[1], 1);
5564
5565         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5566         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5567         let events = nodes[0].node.get_and_clear_pending_events();
5568         assert_eq!(events.len(), 1);
5569         match events[0] {
5570                 Event::PaymentSent { payment_preimage } => {
5571                         assert_eq!(payment_preimage, our_payment_preimage);
5572                 },
5573                 _ => panic!("Unexpected event"),
5574         }
5575
5576         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5577         check_added_monitors!(nodes[0], 1);
5578         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5579         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5580         check_added_monitors!(nodes[1], 1);
5581
5582         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5583         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5584                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5585                 header.prev_blockhash = header.bitcoin_hash();
5586         }
5587         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5588         check_closed_broadcast!(nodes[1], false);
5589         check_added_monitors!(nodes[1], 1);
5590 }
5591
5592 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5593         let chanmon_cfgs = create_chanmon_cfgs(2);
5594         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5595         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5596         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5597         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5598         let logger = test_utils::TestLogger::new();
5599
5600         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5601         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5602         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5603         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5604         check_added_monitors!(nodes[0], 1);
5605
5606         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5607
5608         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5609         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5610         // to "time out" the HTLC.
5611
5612         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5613
5614         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5615                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5616                 header.prev_blockhash = header.bitcoin_hash();
5617         }
5618         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5619         check_closed_broadcast!(nodes[0], false);
5620         check_added_monitors!(nodes[0], 1);
5621 }
5622
5623 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5624         let chanmon_cfgs = create_chanmon_cfgs(3);
5625         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5626         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5627         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5628         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5629
5630         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5631         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5632         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5633         // actually revoked.
5634         let htlc_value = if use_dust { 50000 } else { 3000000 };
5635         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5636         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5637         expect_pending_htlcs_forwardable!(nodes[1]);
5638         check_added_monitors!(nodes[1], 1);
5639
5640         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5641         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5642         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5643         check_added_monitors!(nodes[0], 1);
5644         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5645         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5646         check_added_monitors!(nodes[1], 1);
5647         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5648         check_added_monitors!(nodes[1], 1);
5649         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5650
5651         if check_revoke_no_close {
5652                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5653                 check_added_monitors!(nodes[0], 1);
5654         }
5655
5656         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5657         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5658                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5659                 header.prev_blockhash = header.bitcoin_hash();
5660         }
5661         if !check_revoke_no_close {
5662                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5663                 check_closed_broadcast!(nodes[0], false);
5664                 check_added_monitors!(nodes[0], 1);
5665         } else {
5666                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5667         }
5668 }
5669
5670 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5671 // There are only a few cases to test here:
5672 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5673 //    broadcastable commitment transactions result in channel closure,
5674 //  * its included in an unrevoked-but-previous remote commitment transaction,
5675 //  * its included in the latest remote or local commitment transactions.
5676 // We test each of the three possible commitment transactions individually and use both dust and
5677 // non-dust HTLCs.
5678 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5679 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5680 // tested for at least one of the cases in other tests.
5681 #[test]
5682 fn htlc_claim_single_commitment_only_a() {
5683         do_htlc_claim_local_commitment_only(true);
5684         do_htlc_claim_local_commitment_only(false);
5685
5686         do_htlc_claim_current_remote_commitment_only(true);
5687         do_htlc_claim_current_remote_commitment_only(false);
5688 }
5689
5690 #[test]
5691 fn htlc_claim_single_commitment_only_b() {
5692         do_htlc_claim_previous_remote_commitment_only(true, false);
5693         do_htlc_claim_previous_remote_commitment_only(false, false);
5694         do_htlc_claim_previous_remote_commitment_only(true, true);
5695         do_htlc_claim_previous_remote_commitment_only(false, true);
5696 }
5697
5698 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>)
5699         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5700                                 F2: FnMut(),
5701 {
5702         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);
5703 }
5704
5705 // test_case
5706 // 0: node1 fails backward
5707 // 1: final node fails backward
5708 // 2: payment completed but the user rejects the payment
5709 // 3: final node fails backward (but tamper onion payloads from node0)
5710 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5711 // 200: trigger error in the final node and tamper returning fail_htlc
5712 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>)
5713         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5714                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5715                                 F3: FnMut(),
5716 {
5717
5718         // reset block height
5719         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5720         for ix in 0..nodes.len() {
5721                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5722         }
5723
5724         macro_rules! expect_event {
5725                 ($node: expr, $event_type: path) => {{
5726                         let events = $node.node.get_and_clear_pending_events();
5727                         assert_eq!(events.len(), 1);
5728                         match events[0] {
5729                                 $event_type { .. } => {},
5730                                 _ => panic!("Unexpected event"),
5731                         }
5732                 }}
5733         }
5734
5735         macro_rules! expect_htlc_forward {
5736                 ($node: expr) => {{
5737                         expect_event!($node, Event::PendingHTLCsForwardable);
5738                         $node.node.process_pending_htlc_forwards();
5739                 }}
5740         }
5741
5742         // 0 ~~> 2 send payment
5743         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5744         check_added_monitors!(nodes[0], 1);
5745         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5746         // temper update_add (0 => 1)
5747         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5748         if test_case == 0 || test_case == 3 || test_case == 100 {
5749                 callback_msg(&mut update_add_0);
5750                 callback_node();
5751         }
5752         // 0 => 1 update_add & CS
5753         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5754         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5755
5756         let update_1_0 = match test_case {
5757                 0|100 => { // intermediate node failure; fail backward to 0
5758                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5759                         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));
5760                         update_1_0
5761                 },
5762                 1|2|3|200 => { // final node failure; forwarding to 2
5763                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5764                         // forwarding on 1
5765                         if test_case != 200 {
5766                                 callback_node();
5767                         }
5768                         expect_htlc_forward!(&nodes[1]);
5769
5770                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5771                         check_added_monitors!(&nodes[1], 1);
5772                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5773                         // tamper update_add (1 => 2)
5774                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5775                         if test_case != 3 && test_case != 200 {
5776                                 callback_msg(&mut update_add_1);
5777                         }
5778
5779                         // 1 => 2
5780                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5781                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5782
5783                         if test_case == 2 || test_case == 200 {
5784                                 expect_htlc_forward!(&nodes[2]);
5785                                 expect_event!(&nodes[2], Event::PaymentReceived);
5786                                 callback_node();
5787                                 expect_pending_htlcs_forwardable!(nodes[2]);
5788                         }
5789
5790                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5791                         if test_case == 2 || test_case == 200 {
5792                                 check_added_monitors!(&nodes[2], 1);
5793                         }
5794                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5795
5796                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5797                         if test_case == 200 {
5798                                 callback_fail(&mut fail_msg);
5799                         }
5800
5801                         // 2 => 1
5802                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5803                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5804
5805                         // backward fail on 1
5806                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5807                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5808                         update_1_0
5809                 },
5810                 _ => unreachable!(),
5811         };
5812
5813         // 1 => 0 commitment_signed_dance
5814         if update_1_0.update_fail_htlcs.len() > 0 {
5815                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5816                 if test_case == 100 {
5817                         callback_fail(&mut fail_msg);
5818                 }
5819                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5820         } else {
5821                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5822         };
5823
5824         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5825
5826         let events = nodes[0].node.get_and_clear_pending_events();
5827         assert_eq!(events.len(), 1);
5828         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
5829                 assert_eq!(*rejected_by_dest, !expected_retryable);
5830                 assert_eq!(*error_code, expected_error_code);
5831         } else {
5832                 panic!("Uexpected event");
5833         }
5834
5835         let events = nodes[0].node.get_and_clear_pending_msg_events();
5836         if expected_channel_update.is_some() {
5837                 assert_eq!(events.len(), 1);
5838                 match events[0] {
5839                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5840                                 match update {
5841                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5842                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5843                                                         panic!("channel_update not found!");
5844                                                 }
5845                                         },
5846                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5847                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5848                                                         assert!(*short_channel_id == *expected_short_channel_id);
5849                                                         assert!(*is_permanent == *expected_is_permanent);
5850                                                 } else {
5851                                                         panic!("Unexpected message event");
5852                                                 }
5853                                         },
5854                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5855                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5856                                                         assert!(*node_id == *expected_node_id);
5857                                                         assert!(*is_permanent == *expected_is_permanent);
5858                                                 } else {
5859                                                         panic!("Unexpected message event");
5860                                                 }
5861                                         },
5862                                 }
5863                         },
5864                         _ => panic!("Unexpected message event"),
5865                 }
5866         } else {
5867                 assert_eq!(events.len(), 0);
5868         }
5869 }
5870
5871 impl msgs::ChannelUpdate {
5872         fn dummy() -> msgs::ChannelUpdate {
5873                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5874                 use bitcoin::secp256k1::Signature;
5875                 msgs::ChannelUpdate {
5876                         signature: Signature::from(FFISignature::new()),
5877                         contents: msgs::UnsignedChannelUpdate {
5878                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
5879                                 short_channel_id: 0,
5880                                 timestamp: 0,
5881                                 flags: 0,
5882                                 cltv_expiry_delta: 0,
5883                                 htlc_minimum_msat: 0,
5884                                 fee_base_msat: 0,
5885                                 fee_proportional_millionths: 0,
5886                                 excess_data: vec![],
5887                         }
5888                 }
5889         }
5890 }
5891
5892 struct BogusOnionHopData {
5893         data: Vec<u8>
5894 }
5895 impl BogusOnionHopData {
5896         fn new(orig: msgs::OnionHopData) -> Self {
5897                 Self { data: orig.encode() }
5898         }
5899 }
5900 impl Writeable for BogusOnionHopData {
5901         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5902                 writer.write_all(&self.data[..])
5903         }
5904 }
5905
5906 #[test]
5907 fn test_onion_failure() {
5908         use ln::msgs::ChannelUpdate;
5909         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5910         use bitcoin::secp256k1;
5911
5912         const BADONION: u16 = 0x8000;
5913         const PERM: u16 = 0x4000;
5914         const NODE: u16 = 0x2000;
5915         const UPDATE: u16 = 0x1000;
5916
5917         let chanmon_cfgs = create_chanmon_cfgs(3);
5918         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5919         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5920         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5921         for node in nodes.iter() {
5922                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5923         }
5924         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
5925         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5926         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5927         let logger = test_utils::TestLogger::new();
5928         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
5929         // positve case
5930         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5931
5932         // intermediate node failure
5933         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5934                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5935                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5936                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5937                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5938                 let mut new_payloads = Vec::new();
5939                 for payload in onion_payloads.drain(..) {
5940                         new_payloads.push(BogusOnionHopData::new(payload));
5941                 }
5942                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5943                 // describing a length-1 TLV payload, which is obviously bogus.
5944                 new_payloads[0].data[0] = 1;
5945                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5946         }, ||{}, 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
5947
5948         // final node failure
5949         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5950                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5951                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5952                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5953                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5954                 let mut new_payloads = Vec::new();
5955                 for payload in onion_payloads.drain(..) {
5956                         new_payloads.push(BogusOnionHopData::new(payload));
5957                 }
5958                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5959                 // length-1 TLV payload, which is obviously bogus.
5960                 new_payloads[1].data[0] = 1;
5961                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5962         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5963
5964         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5965         // receiving simulated fail messages
5966         // intermediate node failure
5967         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5968                 // trigger error
5969                 msg.amount_msat -= 1;
5970         }, |msg| {
5971                 // and tamper returning error message
5972                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5973                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5974                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5975         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5976
5977         // final node failure
5978         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5979                 // and tamper returning error message
5980                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5981                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5982                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5983         }, ||{
5984                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5985         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5986
5987         // intermediate node failure
5988         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5989                 msg.amount_msat -= 1;
5990         }, |msg| {
5991                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5992                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5993                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5994         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5995
5996         // final node failure
5997         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5998                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5999                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6000                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6001         }, ||{
6002                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6003         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6004
6005         // intermediate node failure
6006         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6007                 msg.amount_msat -= 1;
6008         }, |msg| {
6009                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6010                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6011                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6012         }, ||{
6013                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6014         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6015
6016         // final node failure
6017         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6018                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6019                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6020                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6021         }, ||{
6022                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6023         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6024
6025         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6026                 Some(BADONION|PERM|4), None);
6027
6028         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6029                 Some(BADONION|PERM|5), None);
6030
6031         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6032                 Some(BADONION|PERM|6), None);
6033
6034         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6035                 msg.amount_msat -= 1;
6036         }, |msg| {
6037                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6038                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6039                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6040         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6041
6042         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6043                 msg.amount_msat -= 1;
6044         }, |msg| {
6045                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6046                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6047                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6048                 // short_channel_id from the processing node
6049         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6050
6051         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6052                 msg.amount_msat -= 1;
6053         }, |msg| {
6054                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6055                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6056                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6057                 // short_channel_id from the processing node
6058         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6059
6060         let mut bogus_route = route.clone();
6061         bogus_route.paths[0][1].short_channel_id -= 1;
6062         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6063           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6064
6065         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6066         let mut bogus_route = route.clone();
6067         let route_len = bogus_route.paths[0].len();
6068         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6069         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6070
6071         //TODO: with new config API, we will be able to generate both valid and
6072         //invalid channel_update cases.
6073         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6074                 msg.amount_msat -= 1;
6075         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6076
6077         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6078                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6079                 msg.cltv_expiry -= 1;
6080         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6081
6082         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6083                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6084                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6085
6086                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
6087         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6088
6089         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6090                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6091         }, false, Some(PERM|15), None);
6092
6093         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6094                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6095                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6096
6097                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
6098         }, || {}, true, Some(17), None);
6099
6100         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6101                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6102                         for f in pending_forwards.iter_mut() {
6103                                 match f {
6104                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6105                                                 forward_info.outgoing_cltv_value += 1,
6106                                         _ => {},
6107                                 }
6108                         }
6109                 }
6110         }, true, Some(18), None);
6111
6112         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6113                 // violate amt_to_forward > msg.amount_msat
6114                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6115                         for f in pending_forwards.iter_mut() {
6116                                 match f {
6117                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6118                                                 forward_info.amt_to_forward -= 1,
6119                                         _ => {},
6120                                 }
6121                         }
6122                 }
6123         }, true, Some(19), None);
6124
6125         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6126                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6127                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6128                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6129         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6130         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6131
6132         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6133                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6134                 let mut route = route.clone();
6135                 let height = 1;
6136                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6137                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6138                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6139                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6140                 msg.cltv_expiry = htlc_cltv;
6141                 msg.onion_routing_packet = onion_packet;
6142         }, ||{}, true, Some(21), None);
6143 }
6144
6145 #[test]
6146 #[should_panic]
6147 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6148         let chanmon_cfgs = create_chanmon_cfgs(2);
6149         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6150         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6151         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6152         //Force duplicate channel ids
6153         for node in nodes.iter() {
6154                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6155         }
6156
6157         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6158         let channel_value_satoshis=10000;
6159         let push_msat=10001;
6160         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6161         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6162         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6163
6164         //Create a second channel with a channel_id collision
6165         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6166 }
6167
6168 #[test]
6169 fn bolt2_open_channel_sending_node_checks_part2() {
6170         let chanmon_cfgs = create_chanmon_cfgs(2);
6171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6174
6175         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6176         let channel_value_satoshis=2^24;
6177         let push_msat=10001;
6178         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6179
6180         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6181         let channel_value_satoshis=10000;
6182         // Test when push_msat is equal to 1000 * funding_satoshis.
6183         let push_msat=1000*channel_value_satoshis+1;
6184         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6185
6186         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6187         let channel_value_satoshis=10000;
6188         let push_msat=10001;
6189         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_ok()); //Create a valid channel
6190         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6191         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6192
6193         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6194         // 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
6195         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6196
6197         // 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.
6198         assert!(BREAKDOWN_TIMEOUT>0);
6199         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6200
6201         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6202         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6203         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6204
6205         // 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.
6206         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6207         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6208         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6209         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6210         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6211 }
6212
6213 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6214 // 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.
6215 //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.
6216
6217 #[test]
6218 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6219         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6220         let chanmon_cfgs = create_chanmon_cfgs(2);
6221         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6222         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6223         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6224         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6225
6226         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6227         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6228         let logger = test_utils::TestLogger::new();
6229         let mut route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6230         route.paths[0][0].fee_msat = 100;
6231
6232         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6233                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
6234         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6235         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6236 }
6237
6238 #[test]
6239 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6240         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6241         let chanmon_cfgs = create_chanmon_cfgs(2);
6242         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6243         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6244         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6245         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6246         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6247
6248         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6249         let logger = test_utils::TestLogger::new();
6250         let mut route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6251         route.paths[0][0].fee_msat = 0;
6252         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6253                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6254
6255         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6256         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6257 }
6258
6259 #[test]
6260 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6261         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6262         let chanmon_cfgs = create_chanmon_cfgs(2);
6263         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6264         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6265         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6266         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6267
6268         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6269         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6270         let logger = test_utils::TestLogger::new();
6271         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6272         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6273         check_added_monitors!(nodes[0], 1);
6274         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6275         updates.update_add_htlcs[0].amount_msat = 0;
6276
6277         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6278         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6279         check_closed_broadcast!(nodes[1], true).unwrap();
6280         check_added_monitors!(nodes[1], 1);
6281 }
6282
6283 #[test]
6284 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6285         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6286         //It is enforced when constructing a route.
6287         let chanmon_cfgs = create_chanmon_cfgs(2);
6288         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6289         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6290         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6291         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6292         let logger = test_utils::TestLogger::new();
6293
6294         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6295
6296         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6297         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001, &logger).unwrap();
6298         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
6299                 assert_eq!(err, "Channel CLTV overflowed?!"));
6300 }
6301
6302 #[test]
6303 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6304         //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.
6305         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6306         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6307         let chanmon_cfgs = create_chanmon_cfgs(2);
6308         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6309         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6310         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6311         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6312         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6313
6314         let logger = test_utils::TestLogger::new();
6315         for i in 0..max_accepted_htlcs {
6316                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6317                 let payment_event = {
6318                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6319                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6320                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6321                         check_added_monitors!(nodes[0], 1);
6322
6323                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6324                         assert_eq!(events.len(), 1);
6325                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6326                                 assert_eq!(htlcs[0].htlc_id, i);
6327                         } else {
6328                                 assert!(false);
6329                         }
6330                         SendEvent::from_event(events.remove(0))
6331                 };
6332                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6333                 check_added_monitors!(nodes[1], 0);
6334                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6335
6336                 expect_pending_htlcs_forwardable!(nodes[1]);
6337                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6338         }
6339         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6340         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6341         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6342         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6343                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
6344
6345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6346         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6347 }
6348
6349 #[test]
6350 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6351         //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.
6352         let chanmon_cfgs = create_chanmon_cfgs(2);
6353         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6354         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6355         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6356         let channel_value = 100000;
6357         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6358         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6359
6360         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6361
6362         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6363         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6364         let logger = test_utils::TestLogger::new();
6365         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6366         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6367                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
6368
6369         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6370         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);
6371
6372         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6373 }
6374
6375 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6376 #[test]
6377 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6378         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6379         let chanmon_cfgs = create_chanmon_cfgs(2);
6380         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6381         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6382         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6383         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6384         let htlc_minimum_msat: u64;
6385         {
6386                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6387                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6388                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6389         }
6390
6391         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6392         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6393         let logger = test_utils::TestLogger::new();
6394         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6395         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6396         check_added_monitors!(nodes[0], 1);
6397         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6398         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6399         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6400         assert!(nodes[1].node.list_channels().is_empty());
6401         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6402         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
6403         check_added_monitors!(nodes[1], 1);
6404 }
6405
6406 #[test]
6407 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6408         //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
6409         let chanmon_cfgs = create_chanmon_cfgs(2);
6410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6413         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6414         let logger = test_utils::TestLogger::new();
6415
6416         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6417         let channel_reserve = chan_stat.channel_reserve_msat;
6418         let feerate = get_feerate!(nodes[0], chan.2);
6419         // The 2* and +1 are for the fee spike reserve.
6420         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6421
6422         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6423         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6424         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6425         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6426         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6427         check_added_monitors!(nodes[0], 1);
6428         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6429
6430         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6431         // at this time channel-initiatee receivers are not required to enforce that senders
6432         // respect the fee_spike_reserve.
6433         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6434         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6435
6436         assert!(nodes[1].node.list_channels().is_empty());
6437         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6438         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6439         check_added_monitors!(nodes[1], 1);
6440 }
6441
6442 #[test]
6443 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6444         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6445         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6446         let chanmon_cfgs = create_chanmon_cfgs(2);
6447         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6448         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6449         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6450         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6451         let logger = test_utils::TestLogger::new();
6452
6453         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6454         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6455
6456         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6457         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6458
6459         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6460         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6461         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6462         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6463
6464         let mut msg = msgs::UpdateAddHTLC {
6465                 channel_id: chan.2,
6466                 htlc_id: 0,
6467                 amount_msat: 1000,
6468                 payment_hash: our_payment_hash,
6469                 cltv_expiry: htlc_cltv,
6470                 onion_routing_packet: onion_packet.clone(),
6471         };
6472
6473         for i in 0..super::channel::OUR_MAX_HTLCS {
6474                 msg.htlc_id = i as u64;
6475                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6476         }
6477         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6478         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6479
6480         assert!(nodes[1].node.list_channels().is_empty());
6481         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6482         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
6483         check_added_monitors!(nodes[1], 1);
6484 }
6485
6486 #[test]
6487 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6488         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6489         let chanmon_cfgs = create_chanmon_cfgs(2);
6490         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6491         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6492         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6493         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6494         let logger = test_utils::TestLogger::new();
6495
6496         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6497         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6498         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6499         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6500         check_added_monitors!(nodes[0], 1);
6501         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6502         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6503         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6504
6505         assert!(nodes[1].node.list_channels().is_empty());
6506         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6507         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
6508         check_added_monitors!(nodes[1], 1);
6509 }
6510
6511 #[test]
6512 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6513         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6514         let chanmon_cfgs = create_chanmon_cfgs(2);
6515         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6516         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6517         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6518         let logger = test_utils::TestLogger::new();
6519
6520         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6521         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6522         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6523         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6524         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6525         check_added_monitors!(nodes[0], 1);
6526         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6527         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6528         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6529
6530         assert!(nodes[1].node.list_channels().is_empty());
6531         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6532         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6533         check_added_monitors!(nodes[1], 1);
6534 }
6535
6536 #[test]
6537 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6538         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6539         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6540         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6541         let chanmon_cfgs = create_chanmon_cfgs(2);
6542         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6543         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6544         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6545         let logger = test_utils::TestLogger::new();
6546
6547         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6548         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6549         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6550         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6551         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6552         check_added_monitors!(nodes[0], 1);
6553         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6554         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6555
6556         //Disconnect and Reconnect
6557         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6558         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6559         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6560         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6561         assert_eq!(reestablish_1.len(), 1);
6562         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6563         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6564         assert_eq!(reestablish_2.len(), 1);
6565         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6566         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6567         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6568         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6569
6570         //Resend HTLC
6571         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6572         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6573         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6574         check_added_monitors!(nodes[1], 1);
6575         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6576
6577         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6578
6579         assert!(nodes[1].node.list_channels().is_empty());
6580         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6581         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6582         check_added_monitors!(nodes[1], 1);
6583 }
6584
6585 #[test]
6586 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6587         //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.
6588
6589         let chanmon_cfgs = create_chanmon_cfgs(2);
6590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6592         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6593         let logger = test_utils::TestLogger::new();
6594         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6595         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6596         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6597         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6598         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6599
6600         check_added_monitors!(nodes[0], 1);
6601         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6602         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6603
6604         let update_msg = msgs::UpdateFulfillHTLC{
6605                 channel_id: chan.2,
6606                 htlc_id: 0,
6607                 payment_preimage: our_payment_preimage,
6608         };
6609
6610         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6611
6612         assert!(nodes[0].node.list_channels().is_empty());
6613         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6614         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6615         check_added_monitors!(nodes[0], 1);
6616 }
6617
6618 #[test]
6619 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6620         //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.
6621
6622         let chanmon_cfgs = create_chanmon_cfgs(2);
6623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6626         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6627         let logger = test_utils::TestLogger::new();
6628
6629         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6630         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6631         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6632         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6633         check_added_monitors!(nodes[0], 1);
6634         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6635         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6636
6637         let update_msg = msgs::UpdateFailHTLC{
6638                 channel_id: chan.2,
6639                 htlc_id: 0,
6640                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6641         };
6642
6643         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6644
6645         assert!(nodes[0].node.list_channels().is_empty());
6646         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6647         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6648         check_added_monitors!(nodes[0], 1);
6649 }
6650
6651 #[test]
6652 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6653         //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.
6654
6655         let chanmon_cfgs = create_chanmon_cfgs(2);
6656         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6657         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6658         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6659         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6660         let logger = test_utils::TestLogger::new();
6661
6662         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6663         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6664         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6665         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6666         check_added_monitors!(nodes[0], 1);
6667         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6668         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6669
6670         let update_msg = msgs::UpdateFailMalformedHTLC{
6671                 channel_id: chan.2,
6672                 htlc_id: 0,
6673                 sha256_of_onion: [1; 32],
6674                 failure_code: 0x8000,
6675         };
6676
6677         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6678
6679         assert!(nodes[0].node.list_channels().is_empty());
6680         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6681         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6682         check_added_monitors!(nodes[0], 1);
6683 }
6684
6685 #[test]
6686 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6687         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6688
6689         let chanmon_cfgs = create_chanmon_cfgs(2);
6690         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6691         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6692         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6693         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6694
6695         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6696
6697         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6698         check_added_monitors!(nodes[1], 1);
6699
6700         let events = nodes[1].node.get_and_clear_pending_msg_events();
6701         assert_eq!(events.len(), 1);
6702         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6703                 match events[0] {
6704                         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, .. } } => {
6705                                 assert!(update_add_htlcs.is_empty());
6706                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6707                                 assert!(update_fail_htlcs.is_empty());
6708                                 assert!(update_fail_malformed_htlcs.is_empty());
6709                                 assert!(update_fee.is_none());
6710                                 update_fulfill_htlcs[0].clone()
6711                         },
6712                         _ => panic!("Unexpected event"),
6713                 }
6714         };
6715
6716         update_fulfill_msg.htlc_id = 1;
6717
6718         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6719
6720         assert!(nodes[0].node.list_channels().is_empty());
6721         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6722         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6723         check_added_monitors!(nodes[0], 1);
6724 }
6725
6726 #[test]
6727 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6728         //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.
6729
6730         let chanmon_cfgs = create_chanmon_cfgs(2);
6731         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6732         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6733         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6734         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6735
6736         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6737
6738         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6739         check_added_monitors!(nodes[1], 1);
6740
6741         let events = nodes[1].node.get_and_clear_pending_msg_events();
6742         assert_eq!(events.len(), 1);
6743         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6744                 match events[0] {
6745                         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, .. } } => {
6746                                 assert!(update_add_htlcs.is_empty());
6747                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6748                                 assert!(update_fail_htlcs.is_empty());
6749                                 assert!(update_fail_malformed_htlcs.is_empty());
6750                                 assert!(update_fee.is_none());
6751                                 update_fulfill_htlcs[0].clone()
6752                         },
6753                         _ => panic!("Unexpected event"),
6754                 }
6755         };
6756
6757         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6758
6759         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6760
6761         assert!(nodes[0].node.list_channels().is_empty());
6762         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6763         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6764         check_added_monitors!(nodes[0], 1);
6765 }
6766
6767 #[test]
6768 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6769         //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.
6770
6771         let chanmon_cfgs = create_chanmon_cfgs(2);
6772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6774         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6775         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6776         let logger = test_utils::TestLogger::new();
6777
6778         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6779         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6780         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6781         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6782         check_added_monitors!(nodes[0], 1);
6783
6784         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6785         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6786
6787         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6788         check_added_monitors!(nodes[1], 0);
6789         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6790
6791         let events = nodes[1].node.get_and_clear_pending_msg_events();
6792
6793         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6794                 match events[0] {
6795                         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, .. } } => {
6796                                 assert!(update_add_htlcs.is_empty());
6797                                 assert!(update_fulfill_htlcs.is_empty());
6798                                 assert!(update_fail_htlcs.is_empty());
6799                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6800                                 assert!(update_fee.is_none());
6801                                 update_fail_malformed_htlcs[0].clone()
6802                         },
6803                         _ => panic!("Unexpected event"),
6804                 }
6805         };
6806         update_msg.failure_code &= !0x8000;
6807         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6808
6809         assert!(nodes[0].node.list_channels().is_empty());
6810         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6811         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6812         check_added_monitors!(nodes[0], 1);
6813 }
6814
6815 #[test]
6816 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6817         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6818         //    * 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.
6819
6820         let chanmon_cfgs = create_chanmon_cfgs(3);
6821         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6822         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6823         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6824         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6825         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6826         let logger = test_utils::TestLogger::new();
6827
6828         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6829
6830         //First hop
6831         let mut payment_event = {
6832                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6833                 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6834                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6835                 check_added_monitors!(nodes[0], 1);
6836                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6837                 assert_eq!(events.len(), 1);
6838                 SendEvent::from_event(events.remove(0))
6839         };
6840         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6841         check_added_monitors!(nodes[1], 0);
6842         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6843         expect_pending_htlcs_forwardable!(nodes[1]);
6844         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6845         assert_eq!(events_2.len(), 1);
6846         check_added_monitors!(nodes[1], 1);
6847         payment_event = SendEvent::from_event(events_2.remove(0));
6848         assert_eq!(payment_event.msgs.len(), 1);
6849
6850         //Second Hop
6851         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6852         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6853         check_added_monitors!(nodes[2], 0);
6854         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6855
6856         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6857         assert_eq!(events_3.len(), 1);
6858         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6859                 match events_3[0] {
6860                         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 } } => {
6861                                 assert!(update_add_htlcs.is_empty());
6862                                 assert!(update_fulfill_htlcs.is_empty());
6863                                 assert!(update_fail_htlcs.is_empty());
6864                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6865                                 assert!(update_fee.is_none());
6866                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6867                         },
6868                         _ => panic!("Unexpected event"),
6869                 }
6870         };
6871
6872         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6873
6874         check_added_monitors!(nodes[1], 0);
6875         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6876         expect_pending_htlcs_forwardable!(nodes[1]);
6877         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6878         assert_eq!(events_4.len(), 1);
6879
6880         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6881         match events_4[0] {
6882                 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, .. } } => {
6883                         assert!(update_add_htlcs.is_empty());
6884                         assert!(update_fulfill_htlcs.is_empty());
6885                         assert_eq!(update_fail_htlcs.len(), 1);
6886                         assert!(update_fail_malformed_htlcs.is_empty());
6887                         assert!(update_fee.is_none());
6888                 },
6889                 _ => panic!("Unexpected event"),
6890         };
6891
6892         check_added_monitors!(nodes[1], 1);
6893 }
6894
6895 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6896         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6897         // 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
6898         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6899
6900         let chanmon_cfgs = create_chanmon_cfgs(2);
6901         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6902         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6903         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6904         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6905
6906         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6907
6908         // We route 2 dust-HTLCs between A and B
6909         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6910         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6911         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6912
6913         // Cache one local commitment tx as previous
6914         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6915
6916         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6917         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6918         check_added_monitors!(nodes[1], 0);
6919         expect_pending_htlcs_forwardable!(nodes[1]);
6920         check_added_monitors!(nodes[1], 1);
6921
6922         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6923         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6924         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6925         check_added_monitors!(nodes[0], 1);
6926
6927         // Cache one local commitment tx as lastest
6928         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6929
6930         let events = nodes[0].node.get_and_clear_pending_msg_events();
6931         match events[0] {
6932                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6933                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6934                 },
6935                 _ => panic!("Unexpected event"),
6936         }
6937         match events[1] {
6938                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6939                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6940                 },
6941                 _ => panic!("Unexpected event"),
6942         }
6943
6944         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6945         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6946         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6947
6948         if announce_latest {
6949                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6950         } else {
6951                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6952         }
6953
6954         check_closed_broadcast!(nodes[0], false);
6955         check_added_monitors!(nodes[0], 1);
6956
6957         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6958         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6959         let events = nodes[0].node.get_and_clear_pending_events();
6960         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6961         assert_eq!(events.len(), 2);
6962         let mut first_failed = false;
6963         for event in events {
6964                 match event {
6965                         Event::PaymentFailed { payment_hash, .. } => {
6966                                 if payment_hash == payment_hash_1 {
6967                                         assert!(!first_failed);
6968                                         first_failed = true;
6969                                 } else {
6970                                         assert_eq!(payment_hash, payment_hash_2);
6971                                 }
6972                         }
6973                         _ => panic!("Unexpected event"),
6974                 }
6975         }
6976 }
6977
6978 #[test]
6979 fn test_failure_delay_dust_htlc_local_commitment() {
6980         do_test_failure_delay_dust_htlc_local_commitment(true);
6981         do_test_failure_delay_dust_htlc_local_commitment(false);
6982 }
6983
6984 #[test]
6985 fn test_no_failure_dust_htlc_local_commitment() {
6986         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6987         // prone to error, we test here that a dummy transaction don't fail them.
6988
6989         let chanmon_cfgs = create_chanmon_cfgs(2);
6990         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6991         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6992         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6993         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6994
6995         // Rebalance a bit
6996         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6997
6998         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6999         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7000
7001         // We route 2 dust-HTLCs between A and B
7002         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7003         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7004
7005         // Build a dummy invalid transaction trying to spend a commitment tx
7006         let input = TxIn {
7007                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7008                 script_sig: Script::new(),
7009                 sequence: 0,
7010                 witness: Vec::new(),
7011         };
7012
7013         let outp = TxOut {
7014                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7015                 value: 10000,
7016         };
7017
7018         let dummy_tx = Transaction {
7019                 version: 2,
7020                 lock_time: 0,
7021                 input: vec![input],
7022                 output: vec![outp]
7023         };
7024
7025         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7026         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
7027         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7028         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7029         // We broadcast a few more block to check everything is all right
7030         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
7031         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7032         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7033
7034         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7035         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7036 }
7037
7038 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7039         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7040         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7041         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7042         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7043         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7044         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7045
7046         let chanmon_cfgs = create_chanmon_cfgs(3);
7047         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7048         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7049         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7050         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7051
7052         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7053
7054         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7055         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7056
7057         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7058         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7059
7060         // We revoked bs_commitment_tx
7061         if revoked {
7062                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7063                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7064         }
7065
7066         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7067         let mut timeout_tx = Vec::new();
7068         if local {
7069                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7070                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7071                 check_closed_broadcast!(nodes[0], false);
7072                 check_added_monitors!(nodes[0], 1);
7073                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7074                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7075                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7076                 expect_payment_failed!(nodes[0], dust_hash, true);
7077                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7078                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7079                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7080                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7081                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7082                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7083                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7084                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7085         } else {
7086                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7087                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7088                 check_closed_broadcast!(nodes[0], false);
7089                 check_added_monitors!(nodes[0], 1);
7090                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7091                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7092                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7093                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7094                 if !revoked {
7095                         expect_payment_failed!(nodes[0], dust_hash, true);
7096                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7097                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7098                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7099                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7100                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7101                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7102                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7103                 } else {
7104                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7105                         // commitment tx
7106                         let events = nodes[0].node.get_and_clear_pending_events();
7107                         assert_eq!(events.len(), 2);
7108                         let first;
7109                         match events[0] {
7110                                 Event::PaymentFailed { payment_hash, .. } => {
7111                                         if payment_hash == dust_hash { first = true; }
7112                                         else { first = false; }
7113                                 },
7114                                 _ => panic!("Unexpected event"),
7115                         }
7116                         match events[1] {
7117                                 Event::PaymentFailed { payment_hash, .. } => {
7118                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7119                                         else { assert_eq!(payment_hash, dust_hash); }
7120                                 },
7121                                 _ => panic!("Unexpected event"),
7122                         }
7123                 }
7124         }
7125 }
7126
7127 #[test]
7128 fn test_sweep_outbound_htlc_failure_update() {
7129         do_test_sweep_outbound_htlc_failure_update(false, true);
7130         do_test_sweep_outbound_htlc_failure_update(false, false);
7131         do_test_sweep_outbound_htlc_failure_update(true, false);
7132 }
7133
7134 #[test]
7135 fn test_upfront_shutdown_script() {
7136         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7137         // enforce it at shutdown message
7138
7139         let mut config = UserConfig::default();
7140         config.channel_options.announced_channel = true;
7141         config.peer_channel_config_limits.force_announced_channel_preference = false;
7142         config.channel_options.commit_upfront_shutdown_pubkey = false;
7143         let user_cfgs = [None, Some(config), None];
7144         let chanmon_cfgs = create_chanmon_cfgs(3);
7145         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7146         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7147         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7148
7149         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7150         let flags = InitFeatures::known();
7151         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7152         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7153         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7154         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7155         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7156         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7157         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
7158         check_added_monitors!(nodes[2], 1);
7159
7160         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7161         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7162         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7163         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7164         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7165         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7166         let events = nodes[2].node.get_and_clear_pending_msg_events();
7167         assert_eq!(events.len(), 1);
7168         match events[0] {
7169                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7170                 _ => panic!("Unexpected event"),
7171         }
7172
7173         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7174         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7175         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7176         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7177         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7178         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7179         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7180         let events = nodes[1].node.get_and_clear_pending_msg_events();
7181         assert_eq!(events.len(), 1);
7182         match events[0] {
7183                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7184                 _ => panic!("Unexpected event"),
7185         }
7186
7187         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7188         // channel smoothly, opt-out is from channel initiator here
7189         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7190         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7191         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7192         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7193         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7194         let events = nodes[0].node.get_and_clear_pending_msg_events();
7195         assert_eq!(events.len(), 1);
7196         match events[0] {
7197                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7198                 _ => panic!("Unexpected event"),
7199         }
7200
7201         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7202         //// channel smoothly
7203         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7204         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7205         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7206         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7207         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7208         let events = nodes[0].node.get_and_clear_pending_msg_events();
7209         assert_eq!(events.len(), 2);
7210         match events[0] {
7211                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7212                 _ => panic!("Unexpected event"),
7213         }
7214         match events[1] {
7215                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7216                 _ => panic!("Unexpected event"),
7217         }
7218 }
7219
7220 #[test]
7221 fn test_user_configurable_csv_delay() {
7222         // We test our channel constructors yield errors when we pass them absurd csv delay
7223
7224         let mut low_our_to_self_config = UserConfig::default();
7225         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7226         let mut high_their_to_self_config = UserConfig::default();
7227         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7228         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7229         let chanmon_cfgs = create_chanmon_cfgs(2);
7230         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7231         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7232         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7233
7234         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7235         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7236         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, &low_our_to_self_config) {
7237                 match error {
7238                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
7239                         _ => panic!("Unexpected event"),
7240                 }
7241         } else { assert!(false) }
7242
7243         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7244         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7245         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7246         open_channel.to_self_delay = 200;
7247         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::known(), &open_channel, 0, &low_our_to_self_config) {
7248                 match error {
7249                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
7250                         _ => panic!("Unexpected event"),
7251                 }
7252         } else { assert!(false); }
7253
7254         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7255         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7256         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7257         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7258         accept_channel.to_self_delay = 200;
7259         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7260         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7261                 match action {
7262                         &ErrorAction::SendErrorMessage { ref msg } => {
7263                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
7264                         },
7265                         _ => { assert!(false); }
7266                 }
7267         } else { assert!(false); }
7268
7269         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7270         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7271         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7272         open_channel.to_self_delay = 200;
7273         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::known(), &open_channel, 0, &high_their_to_self_config) {
7274                 match error {
7275                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
7276                         _ => panic!("Unexpected event"),
7277                 }
7278         } else { assert!(false); }
7279 }
7280
7281 #[test]
7282 fn test_data_loss_protect() {
7283         // We want to be sure that :
7284         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7285         // * we close channel in case of detecting other being fallen behind
7286         // * we are able to claim our own outputs thanks to to_remote being static
7287         let keys_manager;
7288         let logger;
7289         let fee_estimator;
7290         let tx_broadcaster;
7291         let chain_monitor;
7292         let monitor;
7293         let node_state_0;
7294         let chanmon_cfgs = create_chanmon_cfgs(2);
7295         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7296         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7297         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7298
7299         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7300
7301         // Cache node A state before any channel update
7302         let previous_node_state = nodes[0].node.encode();
7303         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7304         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7305
7306         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7307         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7308
7309         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7310         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7311
7312         // Restore node A from previous state
7313         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7314         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7315         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7316         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7317         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7318         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7319         monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7320         node_state_0 = {
7321                 let mut channel_monitors = HashMap::new();
7322                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7323                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7324                         keys_manager: &keys_manager,
7325                         fee_estimator: &fee_estimator,
7326                         monitor: &monitor,
7327                         logger: &logger,
7328                         tx_broadcaster: &tx_broadcaster,
7329                         default_config: UserConfig::default(),
7330                         channel_monitors: &mut channel_monitors,
7331                 }).unwrap().1
7332         };
7333         nodes[0].node = &node_state_0;
7334         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7335         nodes[0].chan_monitor = &monitor;
7336         nodes[0].chain_monitor = &chain_monitor;
7337
7338         nodes[0].block_notifier = BlockNotifier::new(&nodes[0].chain_monitor);
7339         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7340         nodes[0].block_notifier.register_listener(nodes[0].node);
7341
7342         check_added_monitors!(nodes[0], 1);
7343
7344         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7345         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7346
7347         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7348
7349         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7350         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7351         check_added_monitors!(nodes[0], 1);
7352
7353         {
7354                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7355                 assert_eq!(node_txn.len(), 0);
7356         }
7357
7358         let mut reestablish_1 = Vec::with_capacity(1);
7359         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7360                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7361                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7362                         reestablish_1.push(msg.clone());
7363                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7364                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7365                         match action {
7366                                 &ErrorAction::SendErrorMessage { ref msg } => {
7367                                         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");
7368                                 },
7369                                 _ => panic!("Unexpected event!"),
7370                         }
7371                 } else {
7372                         panic!("Unexpected event")
7373                 }
7374         }
7375
7376         // Check we close channel detecting A is fallen-behind
7377         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7378         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7379         check_added_monitors!(nodes[1], 1);
7380
7381
7382         // Check A is able to claim to_remote output
7383         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7384         assert_eq!(node_txn.len(), 1);
7385         check_spends!(node_txn[0], chan.3);
7386         assert_eq!(node_txn[0].output.len(), 2);
7387         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7388         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7389         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7390         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7391         assert_eq!(spend_txn.len(), 1);
7392         check_spends!(spend_txn[0], node_txn[0]);
7393 }
7394
7395 #[test]
7396 fn test_check_htlc_underpaying() {
7397         // Send payment through A -> B but A is maliciously
7398         // sending a probe payment (i.e less than expected value0
7399         // to B, B should refuse payment.
7400
7401         let chanmon_cfgs = create_chanmon_cfgs(2);
7402         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7403         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7404         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7405
7406         // Create some initial channels
7407         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7408
7409         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7410
7411         // Node 3 is expecting payment of 100_000 but receive 10_000,
7412         // fail htlc like we didn't know the preimage.
7413         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7414         nodes[1].node.process_pending_htlc_forwards();
7415
7416         let events = nodes[1].node.get_and_clear_pending_msg_events();
7417         assert_eq!(events.len(), 1);
7418         let (update_fail_htlc, commitment_signed) = match events[0] {
7419                 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 } } => {
7420                         assert!(update_add_htlcs.is_empty());
7421                         assert!(update_fulfill_htlcs.is_empty());
7422                         assert_eq!(update_fail_htlcs.len(), 1);
7423                         assert!(update_fail_malformed_htlcs.is_empty());
7424                         assert!(update_fee.is_none());
7425                         (update_fail_htlcs[0].clone(), commitment_signed)
7426                 },
7427                 _ => panic!("Unexpected event"),
7428         };
7429         check_added_monitors!(nodes[1], 1);
7430
7431         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7432         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7433
7434         // 10_000 msat as u64, followed by a height of 99 as u32
7435         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7436         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7437         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7438         nodes[1].node.get_and_clear_pending_events();
7439 }
7440
7441 #[test]
7442 fn test_announce_disable_channels() {
7443         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7444         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7445
7446         let chanmon_cfgs = create_chanmon_cfgs(2);
7447         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7448         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7449         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7450
7451         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7452         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7453         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7454
7455         // Disconnect peers
7456         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7457         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7458
7459         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7460         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7461         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7462         assert_eq!(msg_events.len(), 3);
7463         for e in msg_events {
7464                 match e {
7465                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7466                                 let short_id = msg.contents.short_channel_id;
7467                                 // Check generated channel_update match list in PendingChannelUpdate
7468                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7469                                         panic!("Generated ChannelUpdate for wrong chan!");
7470                                 }
7471                         },
7472                         _ => panic!("Unexpected event"),
7473                 }
7474         }
7475         // Reconnect peers
7476         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7477         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7478         assert_eq!(reestablish_1.len(), 3);
7479         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7480         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7481         assert_eq!(reestablish_2.len(), 3);
7482
7483         // Reestablish chan_1
7484         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7485         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7486         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7487         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7488         // Reestablish chan_2
7489         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7490         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7491         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7492         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7493         // Reestablish chan_3
7494         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7495         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7496         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7497         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7498
7499         nodes[0].node.timer_chan_freshness_every_min();
7500         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7501 }
7502
7503 #[test]
7504 fn test_bump_penalty_txn_on_revoked_commitment() {
7505         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7506         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7507
7508         let chanmon_cfgs = create_chanmon_cfgs(2);
7509         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7510         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7511         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7512
7513         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7514         let logger = test_utils::TestLogger::new();
7515
7516
7517         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7518         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7519         let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7520         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7521
7522         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7523         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7524         assert_eq!(revoked_txn[0].output.len(), 4);
7525         assert_eq!(revoked_txn[0].input.len(), 1);
7526         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7527         let revoked_txid = revoked_txn[0].txid();
7528
7529         let mut penalty_sum = 0;
7530         for outp in revoked_txn[0].output.iter() {
7531                 if outp.script_pubkey.is_v0_p2wsh() {
7532                         penalty_sum += outp.value;
7533                 }
7534         }
7535
7536         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7537         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7538
7539         // Actually revoke tx by claiming a HTLC
7540         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7541         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7542         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7543         check_added_monitors!(nodes[1], 1);
7544
7545         // One or more justice tx should have been broadcast, check it
7546         let penalty_1;
7547         let feerate_1;
7548         {
7549                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7550                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7551                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7552                 assert_eq!(node_txn[0].output.len(), 1);
7553                 check_spends!(node_txn[0], revoked_txn[0]);
7554                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7555                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7556                 penalty_1 = node_txn[0].txid();
7557                 node_txn.clear();
7558         };
7559
7560         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7561         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7562         let mut penalty_2 = penalty_1;
7563         let mut feerate_2 = 0;
7564         {
7565                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7566                 assert_eq!(node_txn.len(), 1);
7567                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7568                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7569                         assert_eq!(node_txn[0].output.len(), 1);
7570                         check_spends!(node_txn[0], revoked_txn[0]);
7571                         penalty_2 = node_txn[0].txid();
7572                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7573                         assert_ne!(penalty_2, penalty_1);
7574                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7575                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7576                         // Verify 25% bump heuristic
7577                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7578                         node_txn.clear();
7579                 }
7580         }
7581         assert_ne!(feerate_2, 0);
7582
7583         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7584         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7585         let penalty_3;
7586         let mut feerate_3 = 0;
7587         {
7588                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7589                 assert_eq!(node_txn.len(), 1);
7590                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7591                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7592                         assert_eq!(node_txn[0].output.len(), 1);
7593                         check_spends!(node_txn[0], revoked_txn[0]);
7594                         penalty_3 = node_txn[0].txid();
7595                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7596                         assert_ne!(penalty_3, penalty_2);
7597                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7598                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7599                         // Verify 25% bump heuristic
7600                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7601                         node_txn.clear();
7602                 }
7603         }
7604         assert_ne!(feerate_3, 0);
7605
7606         nodes[1].node.get_and_clear_pending_events();
7607         nodes[1].node.get_and_clear_pending_msg_events();
7608 }
7609
7610 #[test]
7611 fn test_bump_penalty_txn_on_revoked_htlcs() {
7612         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7613         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7614
7615         let chanmon_cfgs = create_chanmon_cfgs(2);
7616         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7617         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7618         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7619
7620         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7621         // Lock HTLC in both directions
7622         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7623         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7624
7625         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7626         assert_eq!(revoked_local_txn[0].input.len(), 1);
7627         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7628
7629         // Revoke local commitment tx
7630         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7631
7632         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7633         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7634         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7635         check_closed_broadcast!(nodes[1], false);
7636         check_added_monitors!(nodes[1], 1);
7637
7638         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7639         assert_eq!(revoked_htlc_txn.len(), 4);
7640         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7641                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7642                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7643                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7644                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7645                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7646         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7647                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7648                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7649                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7650                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7651                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7652         }
7653
7654         // Broadcast set of revoked txn on A
7655         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7656         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7657
7658         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7659         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);
7660         let first;
7661         let feerate_1;
7662         let penalty_txn;
7663         {
7664                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7665                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7666                 // Verify claim tx are spending revoked HTLC txn
7667                 assert_eq!(node_txn[4].input.len(), 2);
7668                 assert_eq!(node_txn[4].output.len(), 1);
7669                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7670                 first = node_txn[4].txid();
7671                 // Store both feerates for later comparison
7672                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7673                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7674                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7675                 node_txn.clear();
7676         }
7677
7678         // Connect three more block to see if bumped penalty are issued for HTLC txn
7679         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7680         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7681         {
7682                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7683                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7684
7685                 check_spends!(node_txn[0], revoked_local_txn[0]);
7686                 check_spends!(node_txn[1], revoked_local_txn[0]);
7687
7688                 node_txn.clear();
7689         };
7690
7691         // Few more blocks to confirm penalty txn
7692         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7693         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7694         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7695         let node_txn = {
7696                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7697                 assert_eq!(node_txn.len(), 1);
7698
7699                 assert_eq!(node_txn[0].input.len(), 2);
7700                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7701                 // Verify bumped tx is different and 25% bump heuristic
7702                 assert_ne!(first, node_txn[0].txid());
7703                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7704                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7705                 assert!(feerate_2 * 100 > feerate_1 * 125);
7706                 let txn = vec![node_txn[0].clone()];
7707                 node_txn.clear();
7708                 txn
7709         };
7710         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7711         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7712         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7713         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7714         {
7715                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7716                 // We verify than no new transaction has been broadcast because previously
7717                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7718                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7719                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7720                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7721                 // up bumped justice generation.
7722                 assert_eq!(node_txn.len(), 0);
7723                 node_txn.clear();
7724         }
7725         check_closed_broadcast!(nodes[0], false);
7726         check_added_monitors!(nodes[0], 1);
7727 }
7728
7729 #[test]
7730 fn test_bump_penalty_txn_on_remote_commitment() {
7731         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7732         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7733
7734         // Create 2 HTLCs
7735         // Provide preimage for one
7736         // Check aggregation
7737
7738         let chanmon_cfgs = create_chanmon_cfgs(2);
7739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7741         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7742
7743         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7744         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7745         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7746
7747         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7748         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7749         assert_eq!(remote_txn[0].output.len(), 4);
7750         assert_eq!(remote_txn[0].input.len(), 1);
7751         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7752
7753         // Claim a HTLC without revocation (provide B monitor with preimage)
7754         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7755         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7756         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7757         check_added_monitors!(nodes[1], 2);
7758
7759         // One or more claim tx should have been broadcast, check it
7760         let timeout;
7761         let preimage;
7762         let feerate_timeout;
7763         let feerate_preimage;
7764         {
7765                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7766                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7767                 assert_eq!(node_txn[0].input.len(), 1);
7768                 assert_eq!(node_txn[1].input.len(), 1);
7769                 check_spends!(node_txn[0], remote_txn[0]);
7770                 check_spends!(node_txn[1], remote_txn[0]);
7771                 check_spends!(node_txn[2], chan.3);
7772                 check_spends!(node_txn[3], node_txn[2]);
7773                 check_spends!(node_txn[4], node_txn[2]);
7774                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7775                         timeout = node_txn[0].txid();
7776                         let index = node_txn[0].input[0].previous_output.vout;
7777                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7778                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7779
7780                         preimage = node_txn[1].txid();
7781                         let index = node_txn[1].input[0].previous_output.vout;
7782                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7783                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7784                 } else {
7785                         timeout = node_txn[1].txid();
7786                         let index = node_txn[1].input[0].previous_output.vout;
7787                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7788                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7789
7790                         preimage = node_txn[0].txid();
7791                         let index = node_txn[0].input[0].previous_output.vout;
7792                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7793                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7794                 }
7795                 node_txn.clear();
7796         };
7797         assert_ne!(feerate_timeout, 0);
7798         assert_ne!(feerate_preimage, 0);
7799
7800         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7801         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7802         {
7803                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7804                 assert_eq!(node_txn.len(), 2);
7805                 assert_eq!(node_txn[0].input.len(), 1);
7806                 assert_eq!(node_txn[1].input.len(), 1);
7807                 check_spends!(node_txn[0], remote_txn[0]);
7808                 check_spends!(node_txn[1], remote_txn[0]);
7809                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7810                         let index = node_txn[0].input[0].previous_output.vout;
7811                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7812                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7813                         assert!(new_feerate * 100 > feerate_timeout * 125);
7814                         assert_ne!(timeout, node_txn[0].txid());
7815
7816                         let index = node_txn[1].input[0].previous_output.vout;
7817                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7818                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7819                         assert!(new_feerate * 100 > feerate_preimage * 125);
7820                         assert_ne!(preimage, node_txn[1].txid());
7821                 } else {
7822                         let index = node_txn[1].input[0].previous_output.vout;
7823                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7824                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7825                         assert!(new_feerate * 100 > feerate_timeout * 125);
7826                         assert_ne!(timeout, node_txn[1].txid());
7827
7828                         let index = node_txn[0].input[0].previous_output.vout;
7829                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7830                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7831                         assert!(new_feerate * 100 > feerate_preimage * 125);
7832                         assert_ne!(preimage, node_txn[0].txid());
7833                 }
7834                 node_txn.clear();
7835         }
7836
7837         nodes[1].node.get_and_clear_pending_events();
7838         nodes[1].node.get_and_clear_pending_msg_events();
7839 }
7840
7841 #[test]
7842 fn test_set_outpoints_partial_claiming() {
7843         // - remote party claim tx, new bump tx
7844         // - disconnect remote claiming tx, new bump
7845         // - disconnect tx, see no tx anymore
7846         let chanmon_cfgs = create_chanmon_cfgs(2);
7847         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7848         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7849         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7850
7851         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7852         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7853         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7854
7855         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7856         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7857         assert_eq!(remote_txn.len(), 3);
7858         assert_eq!(remote_txn[0].output.len(), 4);
7859         assert_eq!(remote_txn[0].input.len(), 1);
7860         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7861         check_spends!(remote_txn[1], remote_txn[0]);
7862         check_spends!(remote_txn[2], remote_txn[0]);
7863
7864         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7865         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7866         // Provide node A with both preimage
7867         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7868         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7869         check_added_monitors!(nodes[0], 2);
7870         nodes[0].node.get_and_clear_pending_events();
7871         nodes[0].node.get_and_clear_pending_msg_events();
7872
7873         // Connect blocks on node A commitment transaction
7874         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7875         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7876         check_closed_broadcast!(nodes[0], false);
7877         check_added_monitors!(nodes[0], 1);
7878         // Verify node A broadcast tx claiming both HTLCs
7879         {
7880                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7881                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7882                 assert_eq!(node_txn.len(), 4);
7883                 check_spends!(node_txn[0], remote_txn[0]);
7884                 check_spends!(node_txn[1], chan.3);
7885                 check_spends!(node_txn[2], node_txn[1]);
7886                 check_spends!(node_txn[3], node_txn[1]);
7887                 assert_eq!(node_txn[0].input.len(), 2);
7888                 node_txn.clear();
7889         }
7890
7891         // Connect blocks on node B
7892         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7893         check_closed_broadcast!(nodes[1], false);
7894         check_added_monitors!(nodes[1], 1);
7895         // Verify node B broadcast 2 HTLC-timeout txn
7896         let partial_claim_tx = {
7897                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7898                 assert_eq!(node_txn.len(), 3);
7899                 check_spends!(node_txn[1], node_txn[0]);
7900                 check_spends!(node_txn[2], node_txn[0]);
7901                 assert_eq!(node_txn[1].input.len(), 1);
7902                 assert_eq!(node_txn[2].input.len(), 1);
7903                 node_txn[1].clone()
7904         };
7905
7906         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7907         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7908         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7909         {
7910                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7911                 assert_eq!(node_txn.len(), 1);
7912                 check_spends!(node_txn[0], remote_txn[0]);
7913                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7914                 node_txn.clear();
7915         }
7916         nodes[0].node.get_and_clear_pending_msg_events();
7917
7918         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7919         nodes[0].block_notifier.block_disconnected(&header, 102);
7920         {
7921                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7922                 assert_eq!(node_txn.len(), 1);
7923                 check_spends!(node_txn[0], remote_txn[0]);
7924                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7925                 node_txn.clear();
7926         }
7927
7928         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7929         nodes[0].block_notifier.block_disconnected(&header, 101);
7930         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7931         {
7932                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7933                 assert_eq!(node_txn.len(), 0);
7934                 node_txn.clear();
7935         }
7936 }
7937
7938 #[test]
7939 fn test_counterparty_raa_skip_no_crash() {
7940         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7941         // commitment transaction, we would have happily carried on and provided them the next
7942         // commitment transaction based on one RAA forward. This would probably eventually have led to
7943         // channel closure, but it would not have resulted in funds loss. Still, our
7944         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7945         // check simply that the channel is closed in response to such an RAA, but don't check whether
7946         // we decide to punish our counterparty for revoking their funds (as we don't currently
7947         // implement that).
7948         let chanmon_cfgs = create_chanmon_cfgs(2);
7949         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7950         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7951         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7952         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7953
7954         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7955         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7956         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7957                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7958         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7959
7960         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7961                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7962         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7963         check_added_monitors!(nodes[1], 1);
7964 }
7965
7966 #[test]
7967 fn test_bump_txn_sanitize_tracking_maps() {
7968         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7969         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7970
7971         let chanmon_cfgs = create_chanmon_cfgs(2);
7972         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7973         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7974         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7975
7976         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7977         // Lock HTLC in both directions
7978         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7979         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7980
7981         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7982         assert_eq!(revoked_local_txn[0].input.len(), 1);
7983         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7984
7985         // Revoke local commitment tx
7986         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7987
7988         // Broadcast set of revoked txn on A
7989         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7990         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7991
7992         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7993         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7994         check_closed_broadcast!(nodes[0], false);
7995         check_added_monitors!(nodes[0], 1);
7996         let penalty_txn = {
7997                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7998                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7999                 check_spends!(node_txn[0], revoked_local_txn[0]);
8000                 check_spends!(node_txn[1], revoked_local_txn[0]);
8001                 check_spends!(node_txn[2], revoked_local_txn[0]);
8002                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8003                 node_txn.clear();
8004                 penalty_txn
8005         };
8006         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8007         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8008         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
8009         {
8010                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8011                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8012                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8013                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8014                 }
8015         }
8016 }
8017
8018 #[test]
8019 fn test_override_channel_config() {
8020         let chanmon_cfgs = create_chanmon_cfgs(2);
8021         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8022         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8023         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8024
8025         // Node0 initiates a channel to node1 using the override config.
8026         let mut override_config = UserConfig::default();
8027         override_config.own_channel_config.our_to_self_delay = 200;
8028
8029         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8030
8031         // Assert the channel created by node0 is using the override config.
8032         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8033         assert_eq!(res.channel_flags, 0);
8034         assert_eq!(res.to_self_delay, 200);
8035 }
8036
8037 #[test]
8038 fn test_override_0msat_htlc_minimum() {
8039         let mut zero_config = UserConfig::default();
8040         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8041         let chanmon_cfgs = create_chanmon_cfgs(2);
8042         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8043         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8044         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8045
8046         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8047         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8048         assert_eq!(res.htlc_minimum_msat, 1);
8049
8050         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8051         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8052         assert_eq!(res.htlc_minimum_msat, 1);
8053 }
8054
8055 #[test]
8056 fn test_simple_payment_secret() {
8057         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8058         // features, however.
8059         let chanmon_cfgs = create_chanmon_cfgs(3);
8060         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8061         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8062         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8063
8064         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8065         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8066         let logger = test_utils::TestLogger::new();
8067
8068         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8069         let payment_secret = PaymentSecret([0xdb; 32]);
8070         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8071         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8072         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8073         // Claiming with all the correct values but the wrong secret should result in nothing...
8074         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8075         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8076         // ...but with the right secret we should be able to claim all the way back
8077         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8078 }
8079
8080 #[test]
8081 fn test_simple_mpp() {
8082         // Simple test of sending a multi-path payment.
8083         let chanmon_cfgs = create_chanmon_cfgs(4);
8084         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8085         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8086         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8087
8088         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8089         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8090         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8091         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8092         let logger = test_utils::TestLogger::new();
8093
8094         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8095         let payment_secret = PaymentSecret([0xdb; 32]);
8096         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8097         let mut route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8098         let path = route.paths[0].clone();
8099         route.paths.push(path);
8100         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8101         route.paths[0][0].short_channel_id = chan_1_id;
8102         route.paths[0][1].short_channel_id = chan_3_id;
8103         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8104         route.paths[1][0].short_channel_id = chan_2_id;
8105         route.paths[1][1].short_channel_id = chan_4_id;
8106         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8107         // Claiming with all the correct values but the wrong secret should result in nothing...
8108         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8109         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8110         // ...but with the right secret we should be able to claim all the way back
8111         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8112 }
8113
8114 #[test]
8115 fn test_update_err_monitor_lockdown() {
8116         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8117         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8118         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8119         //
8120         // This scenario may happen in a watchtower setup, where watchtower process a block height
8121         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8122         // commitment at same time.
8123
8124         let chanmon_cfgs = create_chanmon_cfgs(2);
8125         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8126         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8127         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8128
8129         // Create some initial channel
8130         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8131         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8132
8133         // Rebalance the network to generate htlc in the two directions
8134         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8135
8136         // Route a HTLC from node 0 to node 1 (but don't settle)
8137         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8138
8139         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8140         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8141         let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8142         let watchtower = {
8143                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8144                 let monitor = monitors.get(&outpoint).unwrap();
8145                 let mut w = test_utils::TestVecWriter(Vec::new());
8146                 monitor.write_for_disk(&mut w).unwrap();
8147                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8148                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8149                 assert!(new_monitor == *monitor);
8150                 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8151                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8152                 watchtower
8153         };
8154         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8155         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
8156
8157         // Try to update ChannelMonitor
8158         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8159         check_added_monitors!(nodes[1], 1);
8160         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8161         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8162         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8163         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8164                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8165                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8166                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8167                 } else { assert!(false); }
8168         } else { assert!(false); };
8169         // Our local monitor is in-sync and hasn't processed yet timeout
8170         check_added_monitors!(nodes[0], 1);
8171         let events = nodes[0].node.get_and_clear_pending_events();
8172         assert_eq!(events.len(), 1);
8173 }