_ Git - rust-lightning/blob - 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::chaininterface::{ChainListener, ChainWatchInterface};
   7 use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
   8 use chain::keysinterface;
   9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC, BREAKDOWN_TIMEOUT};
  10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash};
  11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
  12 use ln::channel::{ACCEPTED_HTLC_SCRIPT_WEIGHT, OFFERED_HTLC_SCRIPT_WEIGHT};
  13 use ln::onion_utils;
  14 use ln::router::{Route, RouteHop};
  15 use ln::msgs;
  16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate};
  17 use util::test_utils;
  18 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  19 use util::errors::APIError;
  20 use util::ser::{Writeable, ReadableArgs};
  21 use util::config::UserConfig;
  22 use util::rng;
  23
  24 use bitcoin::util::hash::BitcoinHash;
  25 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  26 use bitcoin::util::bip143;
  27 use bitcoin::util::address::Address;
  28 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  29 use bitcoin::blockdata::block::{Block, BlockHeader};
  30 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
  31 use bitcoin::blockdata::script::{Builder, Script};
  32 use bitcoin::blockdata::opcodes;
  33 use bitcoin::blockdata::constants::genesis_block;
  34 use bitcoin::network::constants::Network;
  35
  36 use bitcoin_hashes::sha256::Hash as Sha256;
  37 use bitcoin_hashes::Hash;
  38
  39 use secp256k1::{Secp256k1, Message};
  40 use secp256k1::key::{PublicKey,SecretKey};
  41
  42 use std::collections::{BTreeSet, HashMap, HashSet};
  43 use std::default::Default;
  44 use std::sync::Arc;
  45 use std::sync::atomic::Ordering;
  46 use std::mem;
  47
  48 use ln::functional_test_utils::*;
  49
  50 #[test]
  51 fn test_async_inbound_update_fee() {
  52         let mut nodes = create_network(2);
  53         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
  54         let channel_id = chan.2;
  55
  56         // balancing
  57         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
  58
  59         // A                                        B
  60         // update_fee                            ->
  61         // send (1) commitment_signed            -.
  62         //                                       <- update_add_htlc/commitment_signed
  63         // send (2) RAA (awaiting remote revoke) -.
  64         // (1) commitment_signed is delivered    ->
  65         //                                       .- send (3) RAA (awaiting remote revoke)
  66         // (2) RAA is delivered                  ->
  67         //                                       .- send (4) commitment_signed
  68         //                                       <- (3) RAA is delivered
  69         // send (5) commitment_signed            -.
  70         //                                       <- (4) commitment_signed is delivered
  71         // send (6) RAA                          -.
  72         // (5) commitment_signed is delivered    ->
  73         //                                       <- RAA
  74         // (6) RAA is delivered                  ->
  75
  76         // First nodes[0] generates an update_fee
  77         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
  78         check_added_monitors!(nodes[0], 1);
  79
  80         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
  81         assert_eq!(events_0.len(), 1);
  82         let (update_msg, commitment_signed) = match events_0[0] { // (1)
  83                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
  84                         (update_fee.as_ref(), commitment_signed)
  85                 },
  86                 _ => panic!("Unexpected event"),
  87         };
  88
  89         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
  90
  91         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
  92         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
  93         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
  94         check_added_monitors!(nodes[1], 1);
  95
  96         let payment_event = {
  97                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
  98                 assert_eq!(events_1.len(), 1);
  99                 SendEvent::from_event(events_1.remove(0))
 100         };
 101         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 102         assert_eq!(payment_event.msgs.len(), 1);
 103
 104         // ...now when the messages get delivered everyone should be happy
 105         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 106         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
 107         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 108         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 109         check_added_monitors!(nodes[0], 1);
 110
 111         // deliver(1), generate (3):
 112         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 113         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 114         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 115         check_added_monitors!(nodes[1], 1);
 116
 117         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
 118         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 119         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 120         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 121         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 122         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 123         assert!(bs_update.update_fee.is_none()); // (4)
 124         check_added_monitors!(nodes[1], 1);
 125
 126         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
 127         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 128         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 129         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 130         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 131         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 132         assert!(as_update.update_fee.is_none()); // (5)
 133         check_added_monitors!(nodes[0], 1);
 134
 135         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
 136         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 137         // only (6) so get_event_msg's assert(len == 1) passes
 138         check_added_monitors!(nodes[0], 1);
 139
 140         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
 141         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 142         check_added_monitors!(nodes[1], 1);
 143
 144         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
 145         check_added_monitors!(nodes[0], 1);
 146
 147         let events_2 = nodes[0].node.get_and_clear_pending_events();
 148         assert_eq!(events_2.len(), 1);
 149         match events_2[0] {
 150                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 151                 _ => panic!("Unexpected event"),
 152         }
 153
 154         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
 155         check_added_monitors!(nodes[1], 1);
 156 }
 157
 158 #[test]
 159 fn test_update_fee_unordered_raa() {
 160         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 161         // crash in an earlier version of the update_fee patch)
 162         let mut nodes = create_network(2);
 163         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 164         let channel_id = chan.2;
 165
 166         // balancing
 167         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 168
 169         // First nodes[0] generates an update_fee
 170         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 171         check_added_monitors!(nodes[0], 1);
 172
 173         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 174         assert_eq!(events_0.len(), 1);
 175         let update_msg = match events_0[0] { // (1)
 176                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 177                         update_fee.as_ref()
 178                 },
 179                 _ => panic!("Unexpected event"),
 180         };
 181
 182         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 183
 184         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 185         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 186         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
 187         check_added_monitors!(nodes[1], 1);
 188
 189         let payment_event = {
 190                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 191                 assert_eq!(events_1.len(), 1);
 192                 SendEvent::from_event(events_1.remove(0))
 193         };
 194         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 195         assert_eq!(payment_event.msgs.len(), 1);
 196
 197         // ...now when the messages get delivered everyone should be happy
 198         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 199         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
 200         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 201         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 202         check_added_monitors!(nodes[0], 1);
 203
 204         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
 205         check_added_monitors!(nodes[1], 1);
 206
 207         // We can't continue, sadly, because our (1) now has a bogus signature
 208 }
 209
 210 #[test]
 211 fn test_multi_flight_update_fee() {
 212         let nodes = create_network(2);
 213         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 214         let channel_id = chan.2;
 215
 216         // A                                        B
 217         // update_fee/commitment_signed          ->
 218         //                                       .- send (1) RAA and (2) commitment_signed
 219         // update_fee (never committed)          ->
 220         // (3) update_fee                        ->
 221         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 222         // don't track which updates correspond to which revoke_and_ack responses so we're in
 223         // AwaitingRAA mode and will not generate the update_fee yet.
 224         //                                       <- (1) RAA delivered
 225         // (3) is generated and send (4) CS      -.
 226         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 227         // know the per_commitment_point to use for it.
 228         //                                       <- (2) commitment_signed delivered
 229         // revoke_and_ack                        ->
 230         //                                          B should send no response here
 231         // (4) commitment_signed delivered       ->
 232         //                                       <- RAA/commitment_signed delivered
 233         // revoke_and_ack                        ->
 234
 235         // First nodes[0] generates an update_fee
 236         let initial_feerate = get_feerate!(nodes[0], channel_id);
 237         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 238         check_added_monitors!(nodes[0], 1);
 239
 240         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 241         assert_eq!(events_0.len(), 1);
 242         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 243                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 244                         (update_fee.as_ref().unwrap(), commitment_signed)
 245                 },
 246                 _ => panic!("Unexpected event"),
 247         };
 248
 249         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 250         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
 251         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
 252         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 253         check_added_monitors!(nodes[1], 1);
 254
 255         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 256         // transaction:
 257         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 258         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 259         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 260
 261         // Create the (3) update_fee message that nodes[0] will generate before it does...
 262         let mut update_msg_2 = msgs::UpdateFee {
 263                 channel_id: update_msg_1.channel_id.clone(),
 264                 feerate_per_kw: (initial_feerate + 30) as u32,
 265         };
 266
 267         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
 268
 269         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 270         // Deliver (3)
 271         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
 272
 273         // Deliver (1), generating (3) and (4)
 274         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
 275         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 276         check_added_monitors!(nodes[0], 1);
 277         assert!(as_second_update.update_add_htlcs.is_empty());
 278         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 279         assert!(as_second_update.update_fail_htlcs.is_empty());
 280         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 281         // Check that the update_fee newly generated matches what we delivered:
 282         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 283         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 284
 285         // Deliver (2) commitment_signed
 286         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
 287         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 288         check_added_monitors!(nodes[0], 1);
 289         // No commitment_signed so get_event_msg's assert(len == 1) passes
 290
 291         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
 292         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 293         check_added_monitors!(nodes[1], 1);
 294
 295         // Delever (4)
 296         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
 297         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 298         check_added_monitors!(nodes[1], 1);
 299
 300         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
 301         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 302         check_added_monitors!(nodes[0], 1);
 303
 304         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
 305         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 306         // No commitment_signed so get_event_msg's assert(len == 1) passes
 307         check_added_monitors!(nodes[0], 1);
 308
 309         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
 310         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 311         check_added_monitors!(nodes[1], 1);
 312 }
 313
 314 #[test]
 315 fn test_update_fee_vanilla() {
 316         let nodes = create_network(2);
 317         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 318         let channel_id = chan.2;
 319
 320         let feerate = get_feerate!(nodes[0], channel_id);
 321         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 322         check_added_monitors!(nodes[0], 1);
 323
 324         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 325         assert_eq!(events_0.len(), 1);
 326         let (update_msg, commitment_signed) = match events_0[0] {
 327                         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 } } => {
 328                         (update_fee.as_ref(), commitment_signed)
 329                 },
 330                 _ => panic!("Unexpected event"),
 331         };
 332         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 333
 334         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 335         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 336         check_added_monitors!(nodes[1], 1);
 337
 338         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 339         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 340         check_added_monitors!(nodes[0], 1);
 341
 342         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
 343         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 344         // No commitment_signed so get_event_msg's assert(len == 1) passes
 345         check_added_monitors!(nodes[0], 1);
 346
 347         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
 348         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 349         check_added_monitors!(nodes[1], 1);
 350 }
 351
 352 #[test]
 353 fn test_update_fee_that_funder_cannot_afford() {
 354         let nodes = create_network(2);
 355         let channel_value = 1888;
 356         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
 357         let channel_id = chan.2;
 358
 359         let feerate = 260;
 360         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 361         check_added_monitors!(nodes[0], 1);
 362         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 363
 364         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
 365
 366         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 367
 368         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 369         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 370         {
 371                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
 372                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
 373
 374                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 375                 let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
 376                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 377                 let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
 378                 actual_fee = channel_value - actual_fee;
 379                 assert_eq!(total_fee, actual_fee);
 380         } //drop the mutex
 381
 382         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 383         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 384         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 385         check_added_monitors!(nodes[0], 1);
 386
 387         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 388
 389         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
 390
 391         //While producing the commitment_signed response after handling a received update_fee request the
 392         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 393         //Should produce and error.
 394         let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
 395
 396         assert!(match err.err {
 397                 "Funding remote cannot afford proposed new fee" => true,
 398                 _ => false,
 399         });
 400
 401         //clear the message we could not handle
 402         nodes[1].node.get_and_clear_pending_msg_events();
 403 }
 404
 405 #[test]
 406 fn test_update_fee_with_fundee_update_add_htlc() {
 407         let mut nodes = create_network(2);
 408         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 409         let channel_id = chan.2;
 410
 411         // balancing
 412         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 413
 414         let feerate = get_feerate!(nodes[0], channel_id);
 415         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 416         check_added_monitors!(nodes[0], 1);
 417
 418         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 419         assert_eq!(events_0.len(), 1);
 420         let (update_msg, commitment_signed) = match events_0[0] {
 421                         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 } } => {
 422                         (update_fee.as_ref(), commitment_signed)
 423                 },
 424                 _ => panic!("Unexpected event"),
 425         };
 426         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 427         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 428         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 429         check_added_monitors!(nodes[1], 1);
 430
 431         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 432
 433         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 434
 435         // nothing happens since node[1] is in AwaitingRemoteRevoke
 436         nodes[1].node.send_payment(route, our_payment_hash).unwrap();
 437         {
 438                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 439                 assert_eq!(added_monitors.len(), 0);
 440                 added_monitors.clear();
 441         }
 442         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 443         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 444         // node[1] has nothing to do
 445
 446         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 447         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 448         check_added_monitors!(nodes[0], 1);
 449
 450         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
 451         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 452         // No commitment_signed so get_event_msg's assert(len == 1) passes
 453         check_added_monitors!(nodes[0], 1);
 454         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
 455         check_added_monitors!(nodes[1], 1);
 456         // AwaitingRemoteRevoke ends here
 457
 458         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 459         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 460         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 461         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 462         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 463         assert_eq!(commitment_update.update_fee.is_none(), true);
 464
 465         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
 466         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
 467         check_added_monitors!(nodes[0], 1);
 468         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 469
 470         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
 471         check_added_monitors!(nodes[1], 1);
 472         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 473
 474         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
 475         check_added_monitors!(nodes[1], 1);
 476         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 477         // No commitment_signed so get_event_msg's assert(len == 1) passes
 478
 479         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
 480         check_added_monitors!(nodes[0], 1);
 481         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 482
 483         expect_pending_htlcs_forwardable!(nodes[0]);
 484
 485         let events = nodes[0].node.get_and_clear_pending_events();
 486         assert_eq!(events.len(), 1);
 487         match events[0] {
 488                 Event::PaymentReceived { .. } => { },
 489                 _ => panic!("Unexpected event"),
 490         };
 491
 492         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 493
 494         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 495         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 496         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 497 }
 498
 499 #[test]
 500 fn test_update_fee() {
 501         let nodes = create_network(2);
 502         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 503         let channel_id = chan.2;
 504
 505         // A                                        B
 506         // (1) update_fee/commitment_signed      ->
 507         //                                       <- (2) revoke_and_ack
 508         //                                       .- send (3) commitment_signed
 509         // (4) update_fee/commitment_signed      ->
 510         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 511         //                                       <- (3) commitment_signed delivered
 512         // send (6) revoke_and_ack               -.
 513         //                                       <- (5) deliver revoke_and_ack
 514         // (6) deliver revoke_and_ack            ->
 515         //                                       .- send (7) commitment_signed in response to (4)
 516         //                                       <- (7) deliver commitment_signed
 517         // revoke_and_ack                        ->
 518
 519         // Create and deliver (1)...
 520         let feerate = get_feerate!(nodes[0], channel_id);
 521         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 522         check_added_monitors!(nodes[0], 1);
 523
 524         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 525         assert_eq!(events_0.len(), 1);
 526         let (update_msg, commitment_signed) = match events_0[0] {
 527                         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 } } => {
 528                         (update_fee.as_ref(), commitment_signed)
 529                 },
 530                 _ => panic!("Unexpected event"),
 531         };
 532         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 533
 534         // Generate (2) and (3):
 535         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 536         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 537         check_added_monitors!(nodes[1], 1);
 538
 539         // Deliver (2):
 540         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 541         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 542         check_added_monitors!(nodes[0], 1);
 543
 544         // Create and deliver (4)...
 545         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 546         check_added_monitors!(nodes[0], 1);
 547         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 548         assert_eq!(events_0.len(), 1);
 549         let (update_msg, commitment_signed) = match events_0[0] {
 550                         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 } } => {
 551                         (update_fee.as_ref(), commitment_signed)
 552                 },
 553                 _ => panic!("Unexpected event"),
 554         };
 555
 556         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 557         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 558         check_added_monitors!(nodes[1], 1);
 559         // ... creating (5)
 560         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 561         // No commitment_signed so get_event_msg's assert(len == 1) passes
 562
 563         // Handle (3), creating (6):
 564         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
 565         check_added_monitors!(nodes[0], 1);
 566         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 567         // No commitment_signed so get_event_msg's assert(len == 1) passes
 568
 569         // Deliver (5):
 570         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 571         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 572         check_added_monitors!(nodes[0], 1);
 573
 574         // Deliver (6), creating (7):
 575         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
 576         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 577         assert!(commitment_update.update_add_htlcs.is_empty());
 578         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 579         assert!(commitment_update.update_fail_htlcs.is_empty());
 580         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 581         assert!(commitment_update.update_fee.is_none());
 582         check_added_monitors!(nodes[1], 1);
 583
 584         // Deliver (7)
 585         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
 586         check_added_monitors!(nodes[0], 1);
 587         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 588         // No commitment_signed so get_event_msg's assert(len == 1) passes
 589
 590         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
 591         check_added_monitors!(nodes[1], 1);
 592         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 593
 594         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 595         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 596         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 597 }
 598
 599 #[test]
 600 fn pre_funding_lock_shutdown_test() {
 601         // Test sending a shutdown prior to funding_locked after funding generation
 602         let nodes = create_network(2);
 603         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
 604         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 605         nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
 606         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
 607
 608         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 609         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 610         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 611         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 612         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 613
 614         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 615         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 616         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 617         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 618         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 619         assert!(node_0_none.is_none());
 620
 621         assert!(nodes[0].node.list_channels().is_empty());
 622         assert!(nodes[1].node.list_channels().is_empty());
 623 }
 624
 625 #[test]
 626 fn updates_shutdown_wait() {
 627         // Test sending a shutdown with outstanding updates pending
 628         let mut nodes = create_network(3);
 629         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 630         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 631         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 632         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 633
 634         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 635
 636         nodes[0].node.close_channel(&chan_1.2).unwrap();
 637         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 638         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 639         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 640         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 641
 642         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 643         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 644
 645         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 646         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
 647         else { panic!("New sends should fail!") };
 648         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
 649         else { panic!("New sends should fail!") };
 650
 651         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 652         check_added_monitors!(nodes[2], 1);
 653         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 654         assert!(updates.update_add_htlcs.is_empty());
 655         assert!(updates.update_fail_htlcs.is_empty());
 656         assert!(updates.update_fail_malformed_htlcs.is_empty());
 657         assert!(updates.update_fee.is_none());
 658         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 659         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
 660         check_added_monitors!(nodes[1], 1);
 661         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 662         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 663
 664         assert!(updates_2.update_add_htlcs.is_empty());
 665         assert!(updates_2.update_fail_htlcs.is_empty());
 666         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 667         assert!(updates_2.update_fee.is_none());
 668         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 669         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
 670         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 671
 672         let events = nodes[0].node.get_and_clear_pending_events();
 673         assert_eq!(events.len(), 1);
 674         match events[0] {
 675                 Event::PaymentSent { ref payment_preimage } => {
 676                         assert_eq!(our_payment_preimage, *payment_preimage);
 677                 },
 678                 _ => panic!("Unexpected event"),
 679         }
 680
 681         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 682         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 683         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 684         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 685         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 686         assert!(node_0_none.is_none());
 687
 688         assert!(nodes[0].node.list_channels().is_empty());
 689
 690         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 691         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 692         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 693         assert!(nodes[1].node.list_channels().is_empty());
 694         assert!(nodes[2].node.list_channels().is_empty());
 695 }
 696
 697 #[test]
 698 fn htlc_fail_async_shutdown() {
 699         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 700         let mut nodes = create_network(3);
 701         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 702         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 703
 704         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 705         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 706         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
 707         check_added_monitors!(nodes[0], 1);
 708         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 709         assert_eq!(updates.update_add_htlcs.len(), 1);
 710         assert!(updates.update_fulfill_htlcs.is_empty());
 711         assert!(updates.update_fail_htlcs.is_empty());
 712         assert!(updates.update_fail_malformed_htlcs.is_empty());
 713         assert!(updates.update_fee.is_none());
 714
 715         nodes[1].node.close_channel(&chan_1.2).unwrap();
 716         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 717         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 718         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 719
 720         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
 721         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
 722         check_added_monitors!(nodes[1], 1);
 723         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 724         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 725
 726         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 727         assert!(updates_2.update_add_htlcs.is_empty());
 728         assert!(updates_2.update_fulfill_htlcs.is_empty());
 729         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 730         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 731         assert!(updates_2.update_fee.is_none());
 732
 733         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
 734         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 735
 736         let events = nodes[0].node.get_and_clear_pending_events();
 737         assert_eq!(events.len(), 1);
 738         match events[0] {
 739                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 740                         assert_eq!(our_payment_hash, *payment_hash);
 741                         assert!(!rejected_by_dest);
 742                 },
 743                 _ => panic!("Unexpected event"),
 744         }
 745
 746         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(msg_events.len(), 2);
 748         let node_0_closing_signed = match msg_events[0] {
 749                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 750                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 751                         (*msg).clone()
 752                 },
 753                 _ => panic!("Unexpected event"),
 754         };
 755         match msg_events[1] {
 756                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 757                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 758                 },
 759                 _ => panic!("Unexpected event"),
 760         }
 761
 762         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 763         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 764         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 765         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 766         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 767         assert!(node_0_none.is_none());
 768
 769         assert!(nodes[0].node.list_channels().is_empty());
 770
 771         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 772         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 773         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 774         assert!(nodes[1].node.list_channels().is_empty());
 775         assert!(nodes[2].node.list_channels().is_empty());
 776 }
 777
 778 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 779         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 780         // messages delivered prior to disconnect
 781         let nodes = create_network(3);
 782         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 783         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 784
 785         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 786
 787         nodes[1].node.close_channel(&chan_1.2).unwrap();
 788         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 789         if recv_count > 0 {
 790                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 791                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 792                 if recv_count > 1 {
 793                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 794                 }
 795         }
 796
 797         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 798         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 799
 800         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
 801         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 802         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
 803         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 804
 805         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
 806         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 807         assert!(node_1_shutdown == node_1_2nd_shutdown);
 808
 809         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
 810         let node_0_2nd_shutdown = if recv_count > 0 {
 811                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 812                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
 813                 node_0_2nd_shutdown
 814         } else {
 815                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 816                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
 817                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 818         };
 819         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
 820
 821         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 822         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 823
 824         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 825         check_added_monitors!(nodes[2], 1);
 826         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 827         assert!(updates.update_add_htlcs.is_empty());
 828         assert!(updates.update_fail_htlcs.is_empty());
 829         assert!(updates.update_fail_malformed_htlcs.is_empty());
 830         assert!(updates.update_fee.is_none());
 831         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 832         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
 833         check_added_monitors!(nodes[1], 1);
 834         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 835         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 836
 837         assert!(updates_2.update_add_htlcs.is_empty());
 838         assert!(updates_2.update_fail_htlcs.is_empty());
 839         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 840         assert!(updates_2.update_fee.is_none());
 841         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 842         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
 843         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 844
 845         let events = nodes[0].node.get_and_clear_pending_events();
 846         assert_eq!(events.len(), 1);
 847         match events[0] {
 848                 Event::PaymentSent { ref payment_preimage } => {
 849                         assert_eq!(our_payment_preimage, *payment_preimage);
 850                 },
 851                 _ => panic!("Unexpected event"),
 852         }
 853
 854         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 855         if recv_count > 0 {
 856                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 857                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 858                 assert!(node_1_closing_signed.is_some());
 859         }
 860
 861         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 862         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 863
 864         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
 865         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 866         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
 867         if recv_count == 0 {
 868                 // If all closing_signeds weren't delivered we can just resume where we left off...
 869                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 870
 871                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
 872                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 873                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 874
 875                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
 876                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 877                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 878
 879                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
 880                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 881
 882                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
 883                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 884                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
 885
 886                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
 887                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 888                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 889                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 890                 assert!(node_0_none.is_none());
 891         } else {
 892                 // If one node, however, received + responded with an identical closing_signed we end
 893                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
 894                 // There isn't really anything better we can do simply, but in the future we might
 895                 // explore storing a set of recently-closed channels that got disconnected during
 896                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
 897                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
 898                 // transaction.
 899                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 900
 901                 if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
 902                                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
 903                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
 904                         let msgs::ErrorMessage {ref channel_id, ..} = msg;
 905                         assert_eq!(*channel_id, chan_1.2);
 906                 } else { panic!("Needed SendErrorMessage close"); }
 907
 908                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
 909                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
 910                 // closing_signed so we do it ourselves
 911                 check_closed_broadcast!(nodes[0]);
 912         }
 913
 914         assert!(nodes[0].node.list_channels().is_empty());
 915
 916         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 917         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 918         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 919         assert!(nodes[1].node.list_channels().is_empty());
 920         assert!(nodes[2].node.list_channels().is_empty());
 921 }
 922
 923 #[test]
 924 fn test_shutdown_rebroadcast() {
 925         do_test_shutdown_rebroadcast(0);
 926         do_test_shutdown_rebroadcast(1);
 927         do_test_shutdown_rebroadcast(2);
 928 }
 929
 930 #[test]
 931 fn fake_network_test() {
 932         // Simple test which builds a network of ChannelManagers, connects them to each other, and
 933         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
 934         let nodes = create_network(4);
 935
 936         // Create some initial channels
 937         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 938         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 939         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
 940
 941         // Rebalance the network a bit by relaying one payment through all the channels...
 942         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 943         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 944         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 945         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 946
 947         // Send some more payments
 948         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
 949         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
 950         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
 951
 952         // Test failure packets
 953         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
 954         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
 955
 956         // Add a new channel that skips 3
 957         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
 958
 959         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
 960         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
 961         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 962         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 963         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 964         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 965         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 966
 967         // Do some rebalance loop payments, simultaneously
 968         let mut hops = Vec::with_capacity(3);
 969         hops.push(RouteHop {
 970                 pubkey: nodes[2].node.get_our_node_id(),
 971                 short_channel_id: chan_2.0.contents.short_channel_id,
 972                 fee_msat: 0,
 973                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
 974         });
 975         hops.push(RouteHop {
 976                 pubkey: nodes[3].node.get_our_node_id(),
 977                 short_channel_id: chan_3.0.contents.short_channel_id,
 978                 fee_msat: 0,
 979                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
 980         });
 981         hops.push(RouteHop {
 982                 pubkey: nodes[1].node.get_our_node_id(),
 983                 short_channel_id: chan_4.0.contents.short_channel_id,
 984                 fee_msat: 1000000,
 985                 cltv_expiry_delta: TEST_FINAL_CLTV,
 986         });
 987         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;
 988         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;
 989         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
 990
 991         let mut hops = Vec::with_capacity(3);
 992         hops.push(RouteHop {
 993                 pubkey: nodes[3].node.get_our_node_id(),
 994                 short_channel_id: chan_4.0.contents.short_channel_id,
 995                 fee_msat: 0,
 996                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
 997         });
 998         hops.push(RouteHop {
 999                 pubkey: nodes[2].node.get_our_node_id(),
1000                 short_channel_id: chan_3.0.contents.short_channel_id,
1001                 fee_msat: 0,
1002                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1003         });
1004         hops.push(RouteHop {
1005                 pubkey: nodes[1].node.get_our_node_id(),
1006                 short_channel_id: chan_2.0.contents.short_channel_id,
1007                 fee_msat: 1000000,
1008                 cltv_expiry_delta: TEST_FINAL_CLTV,
1009         });
1010         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;
1011         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;
1012         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1013
1014         // Claim the rebalances...
1015         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1016         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1017
1018         // Add a duplicate new channel from 2 to 4
1019         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
1020
1021         // Send some payments across both channels
1022         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1023         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1024         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1025
1026         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1027
1028         //TODO: Test that routes work again here as we've been notified that the channel is full
1029
1030         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1031         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1032         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1033
1034         // Close down the channels...
1035         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1036         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1037         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1038         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1039         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1040 }
1041
1042 #[test]
1043 fn holding_cell_htlc_counting() {
1044         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1045         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1046         // commitment dance rounds.
1047         let mut nodes = create_network(3);
1048         create_announced_chan_between_nodes(&nodes, 0, 1);
1049         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1050
1051         let mut payments = Vec::new();
1052         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1053                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1054                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1055                 nodes[1].node.send_payment(route, payment_hash).unwrap();
1056                 payments.push((payment_preimage, payment_hash));
1057         }
1058         check_added_monitors!(nodes[1], 1);
1059
1060         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1061         assert_eq!(events.len(), 1);
1062         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1063         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1064
1065         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1066         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1067         // another HTLC.
1068         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1069         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1070         if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1071                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1072         } else { panic!("Unexpected event"); }
1073
1074         // This should also be true if we try to forward a payment.
1075         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1076         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1077         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1078         check_added_monitors!(nodes[0], 1);
1079
1080         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1081         assert_eq!(events.len(), 1);
1082         let payment_event = SendEvent::from_event(events.pop().unwrap());
1083         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1084
1085         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
1086         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1087         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1088         // fails), the second will process the resulting failure and fail the HTLC backward.
1089         expect_pending_htlcs_forwardable!(nodes[1]);
1090         expect_pending_htlcs_forwardable!(nodes[1]);
1091         check_added_monitors!(nodes[1], 1);
1092
1093         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1094         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]).unwrap();
1095         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1096
1097         let events = nodes[0].node.get_and_clear_pending_msg_events();
1098         assert_eq!(events.len(), 1);
1099         match events[0] {
1100                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1101                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1102                 },
1103                 _ => panic!("Unexpected event"),
1104         }
1105
1106         let events = nodes[0].node.get_and_clear_pending_events();
1107         assert_eq!(events.len(), 1);
1108         match events[0] {
1109                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1110                         assert_eq!(payment_hash, payment_hash_2);
1111                         assert!(!rejected_by_dest);
1112                 },
1113                 _ => panic!("Unexpected event"),
1114         }
1115
1116         // Now forward all the pending HTLCs and claim them back
1117         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]).unwrap();
1118         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg).unwrap();
1119         check_added_monitors!(nodes[2], 1);
1120
1121         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1122         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1123         check_added_monitors!(nodes[1], 1);
1124         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1125
1126         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1127         check_added_monitors!(nodes[1], 1);
1128         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1129
1130         for ref update in as_updates.update_add_htlcs.iter() {
1131                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update).unwrap();
1132         }
1133         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed).unwrap();
1134         check_added_monitors!(nodes[2], 1);
1135         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
1136         check_added_monitors!(nodes[2], 1);
1137         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1138
1139         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1140         check_added_monitors!(nodes[1], 1);
1141         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1142         check_added_monitors!(nodes[1], 1);
1143         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1144
1145         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa).unwrap();
1146         check_added_monitors!(nodes[2], 1);
1147
1148         expect_pending_htlcs_forwardable!(nodes[2]);
1149
1150         let events = nodes[2].node.get_and_clear_pending_events();
1151         assert_eq!(events.len(), payments.len());
1152         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1153                 match event {
1154                         &Event::PaymentReceived { ref payment_hash, .. } => {
1155                                 assert_eq!(*payment_hash, *hash);
1156                         },
1157                         _ => panic!("Unexpected event"),
1158                 };
1159         }
1160
1161         for (preimage, _) in payments.drain(..) {
1162                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1163         }
1164
1165         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1166 }
1167
1168 #[test]
1169 fn duplicate_htlc_test() {
1170         // Test that we accept duplicate payment_hash HTLCs across the network and that
1171         // claiming/failing them are all separate and don't affect each other
1172         let mut nodes = create_network(6);
1173
1174         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1175         create_announced_chan_between_nodes(&nodes, 0, 3);
1176         create_announced_chan_between_nodes(&nodes, 1, 3);
1177         create_announced_chan_between_nodes(&nodes, 2, 3);
1178         create_announced_chan_between_nodes(&nodes, 3, 4);
1179         create_announced_chan_between_nodes(&nodes, 3, 5);
1180
1181         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1182
1183         *nodes[0].network_payment_count.borrow_mut() -= 1;
1184         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1185
1186         *nodes[0].network_payment_count.borrow_mut() -= 1;
1187         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1188
1189         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1190         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1191         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1192 }
1193
1194 fn do_channel_reserve_test(test_recv: bool) {
1195         use util::rng;
1196         use std::sync::atomic::Ordering;
1197         use ln::msgs::HandleError;
1198
1199         let mut nodes = create_network(3);
1200         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
1201         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
1202
1203         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1204         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1205
1206         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1207         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1208
1209         macro_rules! get_route_and_payment_hash {
1210                 ($recv_value: expr) => {{
1211                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1212                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1213                         (route, payment_hash, payment_preimage)
1214                 }}
1215         };
1216
1217         macro_rules! expect_forward {
1218                 ($node: expr) => {{
1219                         let mut events = $node.node.get_and_clear_pending_msg_events();
1220                         assert_eq!(events.len(), 1);
1221                         check_added_monitors!($node, 1);
1222                         let payment_event = SendEvent::from_event(events.remove(0));
1223                         payment_event
1224                 }}
1225         }
1226
1227         let feemsat = 239; // somehow we know?
1228         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1229
1230         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1231
1232         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1233         {
1234                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1235                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1236                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1237                 match err {
1238                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight"),
1239                         _ => panic!("Unknown error variants"),
1240                 }
1241         }
1242
1243         let mut htlc_id = 0;
1244         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1245         // nodes[0]'s wealth
1246         loop {
1247                 let amt_msat = recv_value_0 + total_fee_msat;
1248                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1249                         break;
1250                 }
1251                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1252                 htlc_id += 1;
1253
1254                 let (stat01_, stat11_, stat12_, stat22_) = (
1255                         get_channel_value_stat!(nodes[0], chan_1.2),
1256                         get_channel_value_stat!(nodes[1], chan_1.2),
1257                         get_channel_value_stat!(nodes[1], chan_2.2),
1258                         get_channel_value_stat!(nodes[2], chan_2.2),
1259                 );
1260
1261                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1262                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1263                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1264                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1265                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1266         }
1267
1268         {
1269                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1270                 // attempt to get channel_reserve violation
1271                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1272                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1273                 match err {
1274                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the reserve value"),
1275                         _ => panic!("Unknown error variants"),
1276                 }
1277         }
1278
1279         // adding pending output
1280         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1281         let amt_msat_1 = recv_value_1 + total_fee_msat;
1282
1283         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1284         let payment_event_1 = {
1285                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1286                 check_added_monitors!(nodes[0], 1);
1287
1288                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1289                 assert_eq!(events.len(), 1);
1290                 SendEvent::from_event(events.remove(0))
1291         };
1292         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
1293
1294         // channel reserve test with htlc pending output > 0
1295         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1296         {
1297                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1298                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1299                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the reserve value"),
1300                         _ => panic!("Unknown error variants"),
1301                 }
1302         }
1303
1304         {
1305                 // test channel_reserve test on nodes[1] side
1306                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1307
1308                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1309                 let secp_ctx = Secp256k1::new();
1310                 let session_priv = SecretKey::from_slice(&{
1311                         let mut session_key = [0; 32];
1312                         rng::fill_bytes(&mut session_key);
1313                         session_key
1314                 }).expect("RNG is bad!");
1315
1316                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1317                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1318                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1319                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
1320                 let msg = msgs::UpdateAddHTLC {
1321                         channel_id: chan_1.2,
1322                         htlc_id,
1323                         amount_msat: htlc_msat,
1324                         payment_hash: our_payment_hash,
1325                         cltv_expiry: htlc_cltv,
1326                         onion_routing_packet: onion_packet,
1327                 };
1328
1329                 if test_recv {
1330                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
1331                         match err {
1332                                 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
1333                         }
1334                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1335                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1336                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1337                         check_closed_broadcast!(nodes[1]);
1338                         return;
1339                 }
1340         }
1341
1342         // split the rest to test holding cell
1343         let recv_value_21 = recv_value_2/2;
1344         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1345         {
1346                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1347                 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat), stat.channel_reserve_msat);
1348         }
1349
1350         // now see if they go through on both sides
1351         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1352         // but this will stuck in the holding cell
1353         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1354         check_added_monitors!(nodes[0], 0);
1355         let events = nodes[0].node.get_and_clear_pending_events();
1356         assert_eq!(events.len(), 0);
1357
1358         // test with outbound holding cell amount > 0
1359         {
1360                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1361                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1362                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the reserve value"),
1363                         _ => panic!("Unknown error variants"),
1364                 }
1365         }
1366
1367         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1368         // this will also stuck in the holding cell
1369         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1370         check_added_monitors!(nodes[0], 0);
1371         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1372         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1373
1374         // flush the pending htlc
1375         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
1376         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1377         check_added_monitors!(nodes[1], 1);
1378
1379         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
1380         check_added_monitors!(nodes[0], 1);
1381         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1382
1383         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
1384         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1385         // No commitment_signed so get_event_msg's assert(len == 1) passes
1386         check_added_monitors!(nodes[0], 1);
1387
1388         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1389         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1390         check_added_monitors!(nodes[1], 1);
1391
1392         expect_pending_htlcs_forwardable!(nodes[1]);
1393
1394         let ref payment_event_11 = expect_forward!(nodes[1]);
1395         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
1396         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1397
1398         expect_pending_htlcs_forwardable!(nodes[2]);
1399         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1400
1401         // flush the htlcs in the holding cell
1402         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1403         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
1404         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
1405         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1406         expect_pending_htlcs_forwardable!(nodes[1]);
1407
1408         let ref payment_event_3 = expect_forward!(nodes[1]);
1409         assert_eq!(payment_event_3.msgs.len(), 2);
1410         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
1411         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
1412
1413         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1414         expect_pending_htlcs_forwardable!(nodes[2]);
1415
1416         let events = nodes[2].node.get_and_clear_pending_events();
1417         assert_eq!(events.len(), 2);
1418         match events[0] {
1419                 Event::PaymentReceived { ref payment_hash, amt } => {
1420                         assert_eq!(our_payment_hash_21, *payment_hash);
1421                         assert_eq!(recv_value_21, amt);
1422                 },
1423                 _ => panic!("Unexpected event"),
1424         }
1425         match events[1] {
1426                 Event::PaymentReceived { ref payment_hash, amt } => {
1427                         assert_eq!(our_payment_hash_22, *payment_hash);
1428                         assert_eq!(recv_value_22, amt);
1429                 },
1430                 _ => panic!("Unexpected event"),
1431         }
1432
1433         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1434         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1435         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1436
1437         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);
1438         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1439         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1440         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1441
1442         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1443         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1444 }
1445
1446 #[test]
1447 fn channel_reserve_test() {
1448         do_channel_reserve_test(false);
1449         do_channel_reserve_test(true);
1450 }
1451
1452 #[test]
1453 fn channel_reserve_in_flight_removes() {
1454         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1455         // can send to its counterparty, but due to update ordering, the other side may not yet have
1456         // considered those HTLCs fully removed.
1457         // This tests that we don't count HTLCs which will not be included in the next remote
1458         // commitment transaction towards the reserve value (as it implies no commitment transaction
1459         // will be generated which violates the remote reserve value).
1460         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1461         // To test this we:
1462         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1463         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1464         //    you only consider the value of the first HTLC, it may not),
1465         //  * start routing a third HTLC from A to B,
1466         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1467         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1468         //  * deliver the first fulfill from B
1469         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1470         //    claim,
1471         //  * deliver A's response CS and RAA.
1472         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1473         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1474         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1475         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1476         let mut nodes = create_network(2);
1477         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1478
1479         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1480         // Route the first two HTLCs.
1481         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1482         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1483
1484         // Start routing the third HTLC (this is just used to get everyone in the right state).
1485         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1486         let send_1 = {
1487                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1488                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1489                 check_added_monitors!(nodes[0], 1);
1490                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1491                 assert_eq!(events.len(), 1);
1492                 SendEvent::from_event(events.remove(0))
1493         };
1494
1495         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1496         // initial fulfill/CS.
1497         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1498         check_added_monitors!(nodes[1], 1);
1499         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1500
1501         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1502         // remove the second HTLC when we send the HTLC back from B to A.
1503         assert!(nodes[1].node.claim_funds(payment_preimage_2));
1504         check_added_monitors!(nodes[1], 1);
1505         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1506
1507         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]).unwrap();
1508         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed).unwrap();
1509         check_added_monitors!(nodes[0], 1);
1510         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1511         expect_payment_sent!(nodes[0], payment_preimage_1);
1512
1513         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]).unwrap();
1514         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg).unwrap();
1515         check_added_monitors!(nodes[1], 1);
1516         // B is already AwaitingRAA, so cant generate a CS here
1517         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1518
1519         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1520         check_added_monitors!(nodes[1], 1);
1521         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1522
1523         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1524         check_added_monitors!(nodes[0], 1);
1525         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1526
1527         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1528         check_added_monitors!(nodes[1], 1);
1529         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1530
1531         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1532         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1533         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1534         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1535         // on-chain as necessary).
1536         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]).unwrap();
1537         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
1538         check_added_monitors!(nodes[0], 1);
1539         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1540         expect_payment_sent!(nodes[0], payment_preimage_2);
1541
1542         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1543         check_added_monitors!(nodes[1], 1);
1544         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1545
1546         expect_pending_htlcs_forwardable!(nodes[1]);
1547         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1548
1549         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1550         // resolve the second HTLC from A's point of view.
1551         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1552         check_added_monitors!(nodes[0], 1);
1553         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1554
1555         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1556         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1557         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1558         let send_2 = {
1559                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1560                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1561                 check_added_monitors!(nodes[1], 1);
1562                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1563                 assert_eq!(events.len(), 1);
1564                 SendEvent::from_event(events.remove(0))
1565         };
1566
1567         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]).unwrap();
1568         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg).unwrap();
1569         check_added_monitors!(nodes[0], 1);
1570         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1571
1572         // Now just resolve all the outstanding messages/HTLCs for completeness...
1573
1574         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1575         check_added_monitors!(nodes[1], 1);
1576         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1577
1578         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1579         check_added_monitors!(nodes[1], 1);
1580
1581         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1582         check_added_monitors!(nodes[0], 1);
1583         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1584
1585         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1586         check_added_monitors!(nodes[1], 1);
1587         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1588
1589         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1590         check_added_monitors!(nodes[0], 1);
1591
1592         expect_pending_htlcs_forwardable!(nodes[0]);
1593         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1594
1595         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
1596         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1597 }
1598
1599 #[test]
1600 fn channel_monitor_network_test() {
1601         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1602         // tests that ChannelMonitor is able to recover from various states.
1603         let nodes = create_network(5);
1604
1605         // Create some initial channels
1606         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1607         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1608         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
1609         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
1610
1611         // Rebalance the network a bit by relaying one payment through all the channels...
1612         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1613         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1614         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1615         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1616
1617         // Simple case with no pending HTLCs:
1618         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1619         {
1620                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1621                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1622                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1623                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1624         }
1625         get_announce_close_broadcast_events(&nodes, 0, 1);
1626         assert_eq!(nodes[0].node.list_channels().len(), 0);
1627         assert_eq!(nodes[1].node.list_channels().len(), 1);
1628
1629         // One pending HTLC is discarded by the force-close:
1630         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1631
1632         // Simple case of one pending HTLC to HTLC-Timeout
1633         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1634         {
1635                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1636                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1637                 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1638                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1639         }
1640         get_announce_close_broadcast_events(&nodes, 1, 2);
1641         assert_eq!(nodes[1].node.list_channels().len(), 0);
1642         assert_eq!(nodes[2].node.list_channels().len(), 1);
1643
1644         macro_rules! claim_funds {
1645                 ($node: expr, $prev_node: expr, $preimage: expr) => {
1646                         {
1647                                 assert!($node.node.claim_funds($preimage));
1648                                 check_added_monitors!($node, 1);
1649
1650                                 let events = $node.node.get_and_clear_pending_msg_events();
1651                                 assert_eq!(events.len(), 1);
1652                                 match events[0] {
1653                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1654                                                 assert!(update_add_htlcs.is_empty());
1655                                                 assert!(update_fail_htlcs.is_empty());
1656                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1657                                         },
1658                                         _ => panic!("Unexpected event"),
1659                                 };
1660                         }
1661                 }
1662         }
1663
1664         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1665         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1666         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1667         {
1668                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1669
1670                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1671                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
1672
1673                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1674                 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1675
1676                 check_preimage_claim(&nodes[3], &node_txn);
1677         }
1678         get_announce_close_broadcast_events(&nodes, 2, 3);
1679         assert_eq!(nodes[2].node.list_channels().len(), 0);
1680         assert_eq!(nodes[3].node.list_channels().len(), 1);
1681
1682         { // Cheat and reset nodes[4]'s height to 1
1683                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1684                 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
1685         }
1686
1687         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1688         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1689         // One pending HTLC to time out:
1690         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1691         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1692         // buffer space).
1693
1694         {
1695                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1696                 nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1697                 for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
1698                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1699                         nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1700                 }
1701
1702                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1703
1704                 // Claim the payment on nodes[4], giving it knowledge of the preimage
1705                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
1706
1707                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1708                 nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1709                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1710                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1711                         nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1712                 }
1713
1714                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1715
1716                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1717                 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1718
1719                 check_preimage_claim(&nodes[4], &node_txn);
1720         }
1721         get_announce_close_broadcast_events(&nodes, 3, 4);
1722         assert_eq!(nodes[3].node.list_channels().len(), 0);
1723         assert_eq!(nodes[4].node.list_channels().len(), 0);
1724 }
1725
1726 #[test]
1727 fn test_justice_tx() {
1728         // Test justice txn built on revoked HTLC-Success tx, against both sides
1729
1730         let nodes = create_network(2);
1731         // Create some new channels:
1732         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
1733
1734         // A pending HTLC which will be revoked:
1735         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1736         // Get the will-be-revoked local txn from nodes[0]
1737         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
1738         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1739         assert_eq!(revoked_local_txn[0].input.len(), 1);
1740         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1741         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1742         assert_eq!(revoked_local_txn[1].input.len(), 1);
1743         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1744         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1745         // Revoke the old state
1746         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
1747
1748         {
1749                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1750                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1751                 {
1752                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1753                         assert_eq!(node_txn.len(), 3);
1754                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1755                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1756
1757                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1758                         node_txn.swap_remove(0);
1759                 }
1760                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1761
1762                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1763                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1764                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1765                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1766                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
1767         }
1768         get_announce_close_broadcast_events(&nodes, 0, 1);
1769
1770         assert_eq!(nodes[0].node.list_channels().len(), 0);
1771         assert_eq!(nodes[1].node.list_channels().len(), 0);
1772
1773         // We test justice_tx build by A on B's revoked HTLC-Success tx
1774         // Create some new channels:
1775         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
1776
1777         // A pending HTLC which will be revoked:
1778         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1779         // Get the will-be-revoked local txn from B
1780         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
1781         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1782         assert_eq!(revoked_local_txn[0].input.len(), 1);
1783         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1784         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1785         // Revoke the old state
1786         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
1787         {
1788                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1789                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1790                 {
1791                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
1792                         assert_eq!(node_txn.len(), 3);
1793                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1794                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
1795
1796                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1797                         node_txn.swap_remove(0);
1798                 }
1799                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
1800
1801                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1802                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
1803                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1804                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1805                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
1806         }
1807         get_announce_close_broadcast_events(&nodes, 0, 1);
1808         assert_eq!(nodes[0].node.list_channels().len(), 0);
1809         assert_eq!(nodes[1].node.list_channels().len(), 0);
1810 }
1811
1812 #[test]
1813 fn revoked_output_claim() {
1814         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
1815         // transaction is broadcast by its counterparty
1816         let nodes = create_network(2);
1817         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1818         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
1819         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1820         assert_eq!(revoked_local_txn.len(), 1);
1821         // Only output is the full channel value back to nodes[0]:
1822         assert_eq!(revoked_local_txn[0].output.len(), 1);
1823         // Send a payment through, updating everyone's latest commitment txn
1824         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
1825
1826         // Inform nodes[1] that nodes[0] broadcast a stale tx
1827         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1828         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1829         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1830         assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
1831
1832         assert_eq!(node_txn[0], node_txn[2]);
1833
1834         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1835         check_spends!(node_txn[1], chan_1.3.clone());
1836
1837         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
1838         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1839         get_announce_close_broadcast_events(&nodes, 0, 1);
1840 }
1841
1842 #[test]
1843 fn claim_htlc_outputs_shared_tx() {
1844         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
1845         let nodes = create_network(2);
1846
1847         // Create some new channel:
1848         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1849
1850         // Rebalance the network to generate htlc in the two directions
1851         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1852         // 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
1853         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1854         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
1855
1856         // Get the will-be-revoked local txn from node[0]
1857         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1858         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
1859         assert_eq!(revoked_local_txn[0].input.len(), 1);
1860         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
1861         assert_eq!(revoked_local_txn[1].input.len(), 1);
1862         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1863         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1864         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
1865
1866         //Revoke the old state
1867         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
1868
1869         {
1870                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1871                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1872                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1873
1874                 let events = nodes[1].node.get_and_clear_pending_events();
1875                 assert_eq!(events.len(), 1);
1876                 match events[0] {
1877                         Event::PaymentFailed { payment_hash, .. } => {
1878                                 assert_eq!(payment_hash, payment_hash_2);
1879                         },
1880                         _ => panic!("Unexpected event"),
1881                 }
1882
1883                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1884                 assert_eq!(node_txn.len(), 4);
1885
1886                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
1887                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1888
1889                 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
1890
1891                 let mut witness_lens = BTreeSet::new();
1892                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
1893                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
1894                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
1895                 assert_eq!(witness_lens.len(), 3);
1896                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
1897                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
1898                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
1899
1900                 // Next nodes[1] broadcasts its current local tx state:
1901                 assert_eq!(node_txn[1].input.len(), 1);
1902                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
1903
1904                 assert_eq!(node_txn[2].input.len(), 1);
1905                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
1906                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
1907                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
1908                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
1909                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
1910         }
1911         get_announce_close_broadcast_events(&nodes, 0, 1);
1912         assert_eq!(nodes[0].node.list_channels().len(), 0);
1913         assert_eq!(nodes[1].node.list_channels().len(), 0);
1914 }
1915
1916 #[test]
1917 fn claim_htlc_outputs_single_tx() {
1918         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
1919         let nodes = create_network(2);
1920
1921         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1922
1923         // Rebalance the network to generate htlc in the two directions
1924         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1925         // 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
1926         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
1927         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1928         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
1929
1930         // Get the will-be-revoked local txn from node[0]
1931         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1932
1933         //Revoke the old state
1934         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
1935
1936         {
1937                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1938                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
1939                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
1940
1941                 let events = nodes[1].node.get_and_clear_pending_events();
1942                 assert_eq!(events.len(), 1);
1943                 match events[0] {
1944                         Event::PaymentFailed { payment_hash, .. } => {
1945                                 assert_eq!(payment_hash, payment_hash_2);
1946                         },
1947                         _ => panic!("Unexpected event"),
1948                 }
1949
1950                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1951                 assert_eq!(node_txn.len(), 12); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan)
1952
1953                 assert_eq!(node_txn[0], node_txn[7]);
1954                 assert_eq!(node_txn[1], node_txn[8]);
1955                 assert_eq!(node_txn[2], node_txn[9]);
1956                 assert_eq!(node_txn[3], node_txn[10]);
1957                 assert_eq!(node_txn[4], node_txn[11]);
1958                 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
1959                 assert_eq!(node_txn[4], node_txn[6]);
1960
1961                 assert_eq!(node_txn[0].input.len(), 1);
1962                 assert_eq!(node_txn[1].input.len(), 1);
1963                 assert_eq!(node_txn[2].input.len(), 1);
1964
1965                 let mut revoked_tx_map = HashMap::new();
1966                 revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
1967                 node_txn[0].verify(&revoked_tx_map).unwrap();
1968                 node_txn[1].verify(&revoked_tx_map).unwrap();
1969                 node_txn[2].verify(&revoked_tx_map).unwrap();
1970
1971                 let mut witness_lens = BTreeSet::new();
1972                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
1973                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
1974                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
1975                 assert_eq!(witness_lens.len(), 3);
1976                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
1977                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
1978                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
1979
1980                 assert_eq!(node_txn[3].input.len(), 1);
1981                 check_spends!(node_txn[3], chan_1.3.clone());
1982
1983                 assert_eq!(node_txn[4].input.len(), 1);
1984                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
1985                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
1986                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
1987                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
1988                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
1989         }
1990         get_announce_close_broadcast_events(&nodes, 0, 1);
1991         assert_eq!(nodes[0].node.list_channels().len(), 0);
1992         assert_eq!(nodes[1].node.list_channels().len(), 0);
1993 }
1994
1995 #[test]
1996 fn test_htlc_on_chain_success() {
1997         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
1998         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
1999         // broadcasting the right event to other nodes in payment path.
2000         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2001         // A --------------------> B ----------------------> C (preimage)
2002         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2003         // commitment transaction was broadcast.
2004         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2005         // towards B.
2006         // B should be able to claim via preimage if A then broadcasts its local tx.
2007         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2008         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2009         // PaymentSent event).
2010
2011         let nodes = create_network(3);
2012
2013         // Create some initial channels
2014         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2015         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2016
2017         // Rebalance the network a bit by relaying one payment through all the channels...
2018         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2019         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2020
2021         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2022         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2023         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2024
2025         // Broadcast legit commitment tx from C on B's chain
2026         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2027         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2028         assert_eq!(commitment_tx.len(), 1);
2029         check_spends!(commitment_tx[0], chan_2.3.clone());
2030         nodes[2].node.claim_funds(our_payment_preimage);
2031         nodes[2].node.claim_funds(our_payment_preimage_2);
2032         check_added_monitors!(nodes[2], 2);
2033         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2034         assert!(updates.update_add_htlcs.is_empty());
2035         assert!(updates.update_fail_htlcs.is_empty());
2036         assert!(updates.update_fail_malformed_htlcs.is_empty());
2037         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2038
2039         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2040         check_closed_broadcast!(nodes[2]);
2041         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2042         assert_eq!(node_txn.len(), 5);
2043         assert_eq!(node_txn[0], node_txn[3]);
2044         assert_eq!(node_txn[1], node_txn[4]);
2045         assert_eq!(node_txn[2], commitment_tx[0]);
2046         check_spends!(node_txn[0], commitment_tx[0].clone());
2047         check_spends!(node_txn[1], commitment_tx[0].clone());
2048         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2049         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2050         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2051         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2052         assert_eq!(node_txn[0].lock_time, 0);
2053         assert_eq!(node_txn[1].lock_time, 0);
2054
2055         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2056         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: node_txn}, 1);
2057         let events = nodes[1].node.get_and_clear_pending_msg_events();
2058         {
2059                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2060                 assert_eq!(added_monitors.len(), 2);
2061                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2062                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2063                 added_monitors.clear();
2064         }
2065         assert_eq!(events.len(), 2);
2066         match events[0] {
2067                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2068                 _ => panic!("Unexpected event"),
2069         }
2070         match events[1] {
2071                 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, .. } } => {
2072                         assert!(update_add_htlcs.is_empty());
2073                         assert!(update_fail_htlcs.is_empty());
2074                         assert_eq!(update_fulfill_htlcs.len(), 1);
2075                         assert!(update_fail_malformed_htlcs.is_empty());
2076                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2077                 },
2078                 _ => panic!("Unexpected event"),
2079         };
2080         macro_rules! check_tx_local_broadcast {
2081                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2082                         // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2083                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2084                         assert_eq!(node_txn.len(), 7);
2085                         assert_eq!(node_txn[0], node_txn[5]);
2086                         assert_eq!(node_txn[1], node_txn[6]);
2087                         check_spends!(node_txn[0], $commitment_tx.clone());
2088                         check_spends!(node_txn[1], $commitment_tx.clone());
2089                         assert_ne!(node_txn[0].lock_time, 0);
2090                         assert_ne!(node_txn[1].lock_time, 0);
2091                         if $htlc_offered {
2092                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2093                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2094                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2095                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2096                         } else {
2097                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2098                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2099                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2100                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2101                         }
2102                         check_spends!(node_txn[2], $chan_tx.clone());
2103                         check_spends!(node_txn[3], node_txn[2].clone());
2104                         check_spends!(node_txn[4], node_txn[2].clone());
2105                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2106                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2107                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2108                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2109                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2110                         assert_ne!(node_txn[3].lock_time, 0);
2111                         assert_ne!(node_txn[4].lock_time, 0);
2112                         node_txn.clear();
2113                 } }
2114         }
2115         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2116         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2117         // timeout-claim of the output that nodes[2] just claimed via success.
2118         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2119
2120         // Broadcast legit commitment tx from A on B's chain
2121         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2122         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2123         check_spends!(commitment_tx[0], chan_1.3.clone());
2124         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2125         check_closed_broadcast!(nodes[1]);
2126         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2127         assert_eq!(node_txn.len(), 3);
2128         assert_eq!(node_txn[0], node_txn[2]);
2129         check_spends!(node_txn[0], commitment_tx[0].clone());
2130         assert_eq!(node_txn[0].input.len(), 2);
2131         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2132         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2133         assert_eq!(node_txn[0].lock_time, 0);
2134         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2135         check_spends!(node_txn[1], chan_1.3.clone());
2136         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2137         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2138         // we already checked the same situation with A.
2139
2140         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2141         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2142         check_closed_broadcast!(nodes[0]);
2143         let events = nodes[0].node.get_and_clear_pending_events();
2144         assert_eq!(events.len(), 2);
2145         let mut first_claimed = false;
2146         for event in events {
2147                 match event {
2148                         Event::PaymentSent { payment_preimage } => {
2149                                 if payment_preimage == our_payment_preimage {
2150                                         assert!(!first_claimed);
2151                                         first_claimed = true;
2152                                 } else {
2153                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2154                                 }
2155                         },
2156                         _ => panic!("Unexpected event"),
2157                 }
2158         }
2159         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2160 }
2161
2162 #[test]
2163 fn test_htlc_on_chain_timeout() {
2164         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2165         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2166         // broadcasting the right event to other nodes in payment path.
2167         // A ------------------> B ----------------------> C (timeout)
2168         //    B's commitment tx                 C's commitment tx
2169         //            \                                  \
2170         //         B's HTLC timeout tx               B's timeout tx
2171
2172         let nodes = create_network(3);
2173
2174         // Create some intial channels
2175         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2176         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2177
2178         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2181
2182         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2183         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2184
2185         // Broadcast legit commitment tx from C on B's chain
2186         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2187         check_spends!(commitment_tx[0], chan_2.3.clone());
2188         nodes[2].node.fail_htlc_backwards(&payment_hash);
2189         check_added_monitors!(nodes[2], 0);
2190         expect_pending_htlcs_forwardable!(nodes[2]);
2191         check_added_monitors!(nodes[2], 1);
2192
2193         let events = nodes[2].node.get_and_clear_pending_msg_events();
2194         assert_eq!(events.len(), 1);
2195         match events[0] {
2196                 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, .. } } => {
2197                         assert!(update_add_htlcs.is_empty());
2198                         assert!(!update_fail_htlcs.is_empty());
2199                         assert!(update_fulfill_htlcs.is_empty());
2200                         assert!(update_fail_malformed_htlcs.is_empty());
2201                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2202                 },
2203                 _ => panic!("Unexpected event"),
2204         };
2205         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2206         check_closed_broadcast!(nodes[2]);
2207         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2208         assert_eq!(node_txn.len(), 1);
2209         check_spends!(node_txn[0], chan_2.3.clone());
2210         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2211
2212         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2213         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2214         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2215         let timeout_tx;
2216         {
2217                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2218                 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2219                 assert_eq!(node_txn[0], node_txn[5]);
2220                 assert_eq!(node_txn[1], node_txn[6]);
2221                 assert_eq!(node_txn[2], node_txn[7]);
2222                 check_spends!(node_txn[0], commitment_tx[0].clone());
2223                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2224                 check_spends!(node_txn[1], chan_2.3.clone());
2225                 check_spends!(node_txn[2], node_txn[1].clone());
2226                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2227                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2228                 check_spends!(node_txn[3], chan_2.3.clone());
2229                 check_spends!(node_txn[4], node_txn[3].clone());
2230                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2231                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2232                 timeout_tx = node_txn[0].clone();
2233                 node_txn.clear();
2234         }
2235
2236         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![timeout_tx]}, 1);
2237         check_added_monitors!(nodes[1], 0);
2238         check_closed_broadcast!(nodes[1]);
2239
2240         expect_pending_htlcs_forwardable!(nodes[1]);
2241         check_added_monitors!(nodes[1], 1);
2242         let events = nodes[1].node.get_and_clear_pending_msg_events();
2243         assert_eq!(events.len(), 1);
2244         match events[0] {
2245                 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, .. } } => {
2246                         assert!(update_add_htlcs.is_empty());
2247                         assert!(!update_fail_htlcs.is_empty());
2248                         assert!(update_fulfill_htlcs.is_empty());
2249                         assert!(update_fail_malformed_htlcs.is_empty());
2250                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2251                 },
2252                 _ => panic!("Unexpected event"),
2253         };
2254         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
2255         assert_eq!(node_txn.len(), 0);
2256
2257         // Broadcast legit commitment tx from B on A's chain
2258         let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2259         check_spends!(commitment_tx[0], chan_1.3.clone());
2260
2261         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2262         check_closed_broadcast!(nodes[0]);
2263         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2264         assert_eq!(node_txn.len(), 4);
2265         assert_eq!(node_txn[0], node_txn[3]);
2266         check_spends!(node_txn[0], commitment_tx[0].clone());
2267         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2268         check_spends!(node_txn[1], chan_1.3.clone());
2269         check_spends!(node_txn[2], node_txn[1].clone());
2270         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2271         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2272 }
2273
2274 #[test]
2275 fn test_simple_commitment_revoked_fail_backward() {
2276         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2277         // and fail backward accordingly.
2278
2279         let nodes = create_network(3);
2280
2281         // Create some initial channels
2282         create_announced_chan_between_nodes(&nodes, 0, 1);
2283         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2284
2285         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2286         // Get the will-be-revoked local txn from nodes[2]
2287         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2288         // Revoke the old state
2289         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2290
2291         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2292
2293         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2294         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2295         check_added_monitors!(nodes[1], 0);
2296         check_closed_broadcast!(nodes[1]);
2297
2298         expect_pending_htlcs_forwardable!(nodes[1]);
2299         check_added_monitors!(nodes[1], 1);
2300         let events = nodes[1].node.get_and_clear_pending_msg_events();
2301         assert_eq!(events.len(), 1);
2302         match events[0] {
2303                 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, .. } } => {
2304                         assert!(update_add_htlcs.is_empty());
2305                         assert_eq!(update_fail_htlcs.len(), 1);
2306                         assert!(update_fulfill_htlcs.is_empty());
2307                         assert!(update_fail_malformed_htlcs.is_empty());
2308                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2309
2310                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2311                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2312
2313                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2314                         assert_eq!(events.len(), 1);
2315                         match events[0] {
2316                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2317                                 _ => panic!("Unexpected event"),
2318                         }
2319                         let events = nodes[0].node.get_and_clear_pending_events();
2320                         assert_eq!(events.len(), 1);
2321                         match events[0] {
2322                                 Event::PaymentFailed { .. } => {},
2323                                 _ => panic!("Unexpected event"),
2324                         }
2325                 },
2326                 _ => panic!("Unexpected event"),
2327         }
2328 }
2329
2330 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2331         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2332         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2333         // commitment transaction anymore.
2334         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2335         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2336         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2337         // technically disallowed and we should probably handle it reasonably.
2338         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2339         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2340         // transactions:
2341         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2342         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2343         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2344         //   and once they revoke the previous commitment transaction (allowing us to send a new
2345         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2346         let mut nodes = create_network(3);
2347
2348         // Create some initial channels
2349         create_announced_chan_between_nodes(&nodes, 0, 1);
2350         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2351
2352         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2353         // Get the will-be-revoked local txn from nodes[2]
2354         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2355         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2356         // Revoke the old state
2357         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2358
2359         let value = if use_dust {
2360                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2361                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2362                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2363         } else { 3000000 };
2364
2365         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2366         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2367         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2368
2369         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2370         expect_pending_htlcs_forwardable!(nodes[2]);
2371         check_added_monitors!(nodes[2], 1);
2372         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2373         assert!(updates.update_add_htlcs.is_empty());
2374         assert!(updates.update_fulfill_htlcs.is_empty());
2375         assert!(updates.update_fail_malformed_htlcs.is_empty());
2376         assert_eq!(updates.update_fail_htlcs.len(), 1);
2377         assert!(updates.update_fee.is_none());
2378         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2379         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2380         // Drop the last RAA from 3 -> 2
2381
2382         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2383         expect_pending_htlcs_forwardable!(nodes[2]);
2384         check_added_monitors!(nodes[2], 1);
2385         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2386         assert!(updates.update_add_htlcs.is_empty());
2387         assert!(updates.update_fulfill_htlcs.is_empty());
2388         assert!(updates.update_fail_malformed_htlcs.is_empty());
2389         assert_eq!(updates.update_fail_htlcs.len(), 1);
2390         assert!(updates.update_fee.is_none());
2391         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2392         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
2393         check_added_monitors!(nodes[1], 1);
2394         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2395         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2396         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
2397         check_added_monitors!(nodes[2], 1);
2398
2399         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2400         expect_pending_htlcs_forwardable!(nodes[2]);
2401         check_added_monitors!(nodes[2], 1);
2402         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2403         assert!(updates.update_add_htlcs.is_empty());
2404         assert!(updates.update_fulfill_htlcs.is_empty());
2405         assert!(updates.update_fail_malformed_htlcs.is_empty());
2406         assert_eq!(updates.update_fail_htlcs.len(), 1);
2407         assert!(updates.update_fee.is_none());
2408         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2409         // At this point first_payment_hash has dropped out of the latest two commitment
2410         // transactions that nodes[1] is tracking...
2411         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
2412         check_added_monitors!(nodes[1], 1);
2413         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2414         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2415         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
2416         check_added_monitors!(nodes[2], 1);
2417
2418         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2419         // on nodes[2]'s RAA.
2420         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2421         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2422         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2423         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2424         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2425         check_added_monitors!(nodes[1], 0);
2426
2427         if deliver_bs_raa {
2428                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa).unwrap();
2429                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2430                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2431                 check_added_monitors!(nodes[1], 1);
2432                 let events = nodes[1].node.get_and_clear_pending_events();
2433                 assert_eq!(events.len(), 1);
2434                 match events[0] {
2435                         Event::PendingHTLCsForwardable { .. } => { },
2436                         _ => panic!("Unexpected event"),
2437                 };
2438                 // Deliberately don't process the pending fail-back so they all fail back at once after
2439                 // block connection just like the !deliver_bs_raa case
2440         }
2441
2442         let mut failed_htlcs = HashSet::new();
2443         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2444
2445         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2446         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2447
2448         let events = nodes[1].node.get_and_clear_pending_events();
2449         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2450         match events[0] {
2451                 Event::PaymentFailed { ref payment_hash, .. } => {
2452                         assert_eq!(*payment_hash, fourth_payment_hash);
2453                 },
2454                 _ => panic!("Unexpected event"),
2455         }
2456         if !deliver_bs_raa {
2457                 match events[1] {
2458                         Event::PendingHTLCsForwardable { .. } => { },
2459                         _ => panic!("Unexpected event"),
2460                 };
2461         }
2462         nodes[1].node.process_pending_htlc_forwards();
2463         check_added_monitors!(nodes[1], 1);
2464
2465         let events = nodes[1].node.get_and_clear_pending_msg_events();
2466         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2467         match events[if deliver_bs_raa { 1 } else { 0 }] {
2468                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2469                 _ => panic!("Unexpected event"),
2470         }
2471         if deliver_bs_raa {
2472                 match events[0] {
2473                         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, .. } } => {
2474                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2475                                 assert_eq!(update_add_htlcs.len(), 1);
2476                                 assert!(update_fulfill_htlcs.is_empty());
2477                                 assert!(update_fail_htlcs.is_empty());
2478                                 assert!(update_fail_malformed_htlcs.is_empty());
2479                         },
2480                         _ => panic!("Unexpected event"),
2481                 }
2482         }
2483         match events[if deliver_bs_raa { 2 } else { 1 }] {
2484                 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, .. } } => {
2485                         assert!(update_add_htlcs.is_empty());
2486                         assert_eq!(update_fail_htlcs.len(), 3);
2487                         assert!(update_fulfill_htlcs.is_empty());
2488                         assert!(update_fail_malformed_htlcs.is_empty());
2489                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2490
2491                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2492                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]).unwrap();
2493                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]).unwrap();
2494
2495                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2496
2497                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2498                         // If we delivered B's RAA we got an unknown preimage error, not something
2499                         // that we should update our routing table for.
2500                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2501                         for event in events {
2502                                 match event {
2503                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2504                                         _ => panic!("Unexpected event"),
2505                                 }
2506                         }
2507                         let events = nodes[0].node.get_and_clear_pending_events();
2508                         assert_eq!(events.len(), 3);
2509                         match events[0] {
2510                                 Event::PaymentFailed { ref payment_hash, .. } => {
2511                                         assert!(failed_htlcs.insert(payment_hash.0));
2512                                 },
2513                                 _ => panic!("Unexpected event"),
2514                         }
2515                         match events[1] {
2516                                 Event::PaymentFailed { ref payment_hash, .. } => {
2517                                         assert!(failed_htlcs.insert(payment_hash.0));
2518                                 },
2519                                 _ => panic!("Unexpected event"),
2520                         }
2521                         match events[2] {
2522                                 Event::PaymentFailed { ref payment_hash, .. } => {
2523                                         assert!(failed_htlcs.insert(payment_hash.0));
2524                                 },
2525                                 _ => panic!("Unexpected event"),
2526                         }
2527                 },
2528                 _ => panic!("Unexpected event"),
2529         }
2530
2531         assert!(failed_htlcs.contains(&first_payment_hash.0));
2532         assert!(failed_htlcs.contains(&second_payment_hash.0));
2533         assert!(failed_htlcs.contains(&third_payment_hash.0));
2534 }
2535
2536 #[test]
2537 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2538         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2539         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2540         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2541         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2542 }
2543
2544 #[test]
2545 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2546         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2547         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2548         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2549         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2550 }
2551
2552 #[test]
2553 fn test_htlc_ignore_latest_remote_commitment() {
2554         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2555         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2556         let nodes = create_network(2);
2557         create_announced_chan_between_nodes(&nodes, 0, 1);
2558
2559         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2560         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2561         check_closed_broadcast!(nodes[0]);
2562
2563         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2564         assert_eq!(node_txn.len(), 2);
2565
2566         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2567         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
2568         check_closed_broadcast!(nodes[1]);
2569
2570         // Duplicate the block_connected call since this may happen due to other listeners
2571         // registering new transactions
2572         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
2573 }
2574
2575 #[test]
2576 fn test_force_close_fail_back() {
2577         // Check which HTLCs are failed-backwards on channel force-closure
2578         let mut nodes = create_network(3);
2579         create_announced_chan_between_nodes(&nodes, 0, 1);
2580         create_announced_chan_between_nodes(&nodes, 1, 2);
2581
2582         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2583
2584         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2585
2586         let mut payment_event = {
2587                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2588                 check_added_monitors!(nodes[0], 1);
2589
2590                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2591                 assert_eq!(events.len(), 1);
2592                 SendEvent::from_event(events.remove(0))
2593         };
2594
2595         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2596         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2597
2598         expect_pending_htlcs_forwardable!(nodes[1]);
2599
2600         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2601         assert_eq!(events_2.len(), 1);
2602         payment_event = SendEvent::from_event(events_2.remove(0));
2603         assert_eq!(payment_event.msgs.len(), 1);
2604
2605         check_added_monitors!(nodes[1], 1);
2606         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2607         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2608         check_added_monitors!(nodes[2], 1);
2609         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2610
2611         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2612         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2613         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2614
2615         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2616         check_closed_broadcast!(nodes[2]);
2617         let tx = {
2618                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2619                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2620                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2621                 // back to nodes[1] upon timeout otherwise.
2622                 assert_eq!(node_txn.len(), 1);
2623                 node_txn.remove(0)
2624         };
2625
2626         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2627         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
2628
2629         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2630         check_closed_broadcast!(nodes[1]);
2631
2632         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2633         {
2634                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2635                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2636                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2637         }
2638         nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
2639         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2640         assert_eq!(node_txn.len(), 1);
2641         assert_eq!(node_txn[0].input.len(), 1);
2642         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2643         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2644         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2645
2646         check_spends!(node_txn[0], tx);
2647 }
2648
2649 #[test]
2650 fn test_unconf_chan() {
2651         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2652         let nodes = create_network(2);
2653         create_announced_chan_between_nodes(&nodes, 0, 1);
2654
2655         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2656         assert_eq!(channel_state.by_id.len(), 1);
2657         assert_eq!(channel_state.short_to_id.len(), 1);
2658         mem::drop(channel_state);
2659
2660         let mut headers = Vec::new();
2661         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2662         headers.push(header.clone());
2663         for _i in 2..100 {
2664                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2665                 headers.push(header.clone());
2666         }
2667         while !headers.is_empty() {
2668                 nodes[0].node.block_disconnected(&headers.pop().unwrap());
2669         }
2670         check_closed_broadcast!(nodes[0]);
2671         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2672         assert_eq!(channel_state.by_id.len(), 0);
2673         assert_eq!(channel_state.short_to_id.len(), 0);
2674 }
2675
2676 #[test]
2677 fn test_simple_peer_disconnect() {
2678         // Test that we can reconnect when there are no lost messages
2679         let nodes = create_network(3);
2680         create_announced_chan_between_nodes(&nodes, 0, 1);
2681         create_announced_chan_between_nodes(&nodes, 1, 2);
2682
2683         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2684         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2685         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2686
2687         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2688         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2689         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2690         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
2691
2692         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2693         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2694         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2695
2696         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2697         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2698         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2699         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2700
2701         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2702         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2703
2704         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
2705         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2706
2707         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2708         {
2709                 let events = nodes[0].node.get_and_clear_pending_events();
2710                 assert_eq!(events.len(), 2);
2711                 match events[0] {
2712                         Event::PaymentSent { payment_preimage } => {
2713                                 assert_eq!(payment_preimage, payment_preimage_3);
2714                         },
2715                         _ => panic!("Unexpected event"),
2716                 }
2717                 match events[1] {
2718                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2719                                 assert_eq!(payment_hash, payment_hash_5);
2720                                 assert!(rejected_by_dest);
2721                         },
2722                         _ => panic!("Unexpected event"),
2723                 }
2724         }
2725
2726         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
2727         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2728 }
2729
2730 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2731         // Test that we can reconnect when in-flight HTLC updates get dropped
2732         let mut nodes = create_network(2);
2733         if messages_delivered == 0 {
2734                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
2735                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2736         } else {
2737                 create_announced_chan_between_nodes(&nodes, 0, 1);
2738         }
2739
2740         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2741         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2742
2743         let payment_event = {
2744                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
2745                 check_added_monitors!(nodes[0], 1);
2746
2747                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2748                 assert_eq!(events.len(), 1);
2749                 SendEvent::from_event(events.remove(0))
2750         };
2751         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
2752
2753         if messages_delivered < 2 {
2754                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
2755         } else {
2756                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2757                 if messages_delivered >= 3 {
2758                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2759                         check_added_monitors!(nodes[1], 1);
2760                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2761
2762                         if messages_delivered >= 4 {
2763                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2764                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2765                                 check_added_monitors!(nodes[0], 1);
2766
2767                                 if messages_delivered >= 5 {
2768                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
2769                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2770                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
2771                                         check_added_monitors!(nodes[0], 1);
2772
2773                                         if messages_delivered >= 6 {
2774                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2775                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2776                                                 check_added_monitors!(nodes[1], 1);
2777                                         }
2778                                 }
2779                         }
2780                 }
2781         }
2782
2783         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2784         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2785         if messages_delivered < 3 {
2786                 // Even if the funding_locked messages get exchanged, as long as nothing further was
2787                 // received on either side, both sides will need to resend them.
2788                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
2789         } else if messages_delivered == 3 {
2790                 // nodes[0] still wants its RAA + commitment_signed
2791                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
2792         } else if messages_delivered == 4 {
2793                 // nodes[0] still wants its commitment_signed
2794                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2795         } else if messages_delivered == 5 {
2796                 // nodes[1] still wants its final RAA
2797                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
2798         } else if messages_delivered == 6 {
2799                 // Everything was delivered...
2800                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2801         }
2802
2803         let events_1 = nodes[1].node.get_and_clear_pending_events();
2804         assert_eq!(events_1.len(), 1);
2805         match events_1[0] {
2806                 Event::PendingHTLCsForwardable { .. } => { },
2807                 _ => panic!("Unexpected event"),
2808         };
2809
2810         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2811         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2812         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2813
2814         nodes[1].node.process_pending_htlc_forwards();
2815
2816         let events_2 = nodes[1].node.get_and_clear_pending_events();
2817         assert_eq!(events_2.len(), 1);
2818         match events_2[0] {
2819                 Event::PaymentReceived { ref payment_hash, amt } => {
2820                         assert_eq!(payment_hash_1, *payment_hash);
2821                         assert_eq!(amt, 1000000);
2822                 },
2823                 _ => panic!("Unexpected event"),
2824         }
2825
2826         nodes[1].node.claim_funds(payment_preimage_1);
2827         check_added_monitors!(nodes[1], 1);
2828
2829         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
2830         assert_eq!(events_3.len(), 1);
2831         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
2832                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2833                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2834                         assert!(updates.update_add_htlcs.is_empty());
2835                         assert!(updates.update_fail_htlcs.is_empty());
2836                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2837                         assert!(updates.update_fail_malformed_htlcs.is_empty());
2838                         assert!(updates.update_fee.is_none());
2839                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2840                 },
2841                 _ => panic!("Unexpected event"),
2842         };
2843
2844         if messages_delivered >= 1 {
2845                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
2846
2847                 let events_4 = nodes[0].node.get_and_clear_pending_events();
2848                 assert_eq!(events_4.len(), 1);
2849                 match events_4[0] {
2850                         Event::PaymentSent { ref payment_preimage } => {
2851                                 assert_eq!(payment_preimage_1, *payment_preimage);
2852                         },
2853                         _ => panic!("Unexpected event"),
2854                 }
2855
2856                 if messages_delivered >= 2 {
2857                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
2858                         check_added_monitors!(nodes[0], 1);
2859                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2860
2861                         if messages_delivered >= 3 {
2862                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2863                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2864                                 check_added_monitors!(nodes[1], 1);
2865
2866                                 if messages_delivered >= 4 {
2867                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
2868                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2869                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
2870                                         check_added_monitors!(nodes[1], 1);
2871
2872                                         if messages_delivered >= 5 {
2873                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2874                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2875                                                 check_added_monitors!(nodes[0], 1);
2876                                         }
2877                                 }
2878                         }
2879                 }
2880         }
2881
2882         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2883         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2884         if messages_delivered < 2 {
2885                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2886                 //TODO: Deduplicate PaymentSent events, then enable this if:
2887                 //if messages_delivered < 1 {
2888                         let events_4 = nodes[0].node.get_and_clear_pending_events();
2889                         assert_eq!(events_4.len(), 1);
2890                         match events_4[0] {
2891                                 Event::PaymentSent { ref payment_preimage } => {
2892                                         assert_eq!(payment_preimage_1, *payment_preimage);
2893                                 },
2894                                 _ => panic!("Unexpected event"),
2895                         }
2896                 //}
2897         } else if messages_delivered == 2 {
2898                 // nodes[0] still wants its RAA + commitment_signed
2899                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
2900         } else if messages_delivered == 3 {
2901                 // nodes[0] still wants its commitment_signed
2902                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
2903         } else if messages_delivered == 4 {
2904                 // nodes[1] still wants its final RAA
2905                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
2906         } else if messages_delivered == 5 {
2907                 // Everything was delivered...
2908                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2909         }
2910
2911         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2912         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2913         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2914
2915         // Channel should still work fine...
2916         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
2917         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2918 }
2919
2920 #[test]
2921 fn test_drop_messages_peer_disconnect_a() {
2922         do_test_drop_messages_peer_disconnect(0);
2923         do_test_drop_messages_peer_disconnect(1);
2924         do_test_drop_messages_peer_disconnect(2);
2925         do_test_drop_messages_peer_disconnect(3);
2926 }
2927
2928 #[test]
2929 fn test_drop_messages_peer_disconnect_b() {
2930         do_test_drop_messages_peer_disconnect(4);
2931         do_test_drop_messages_peer_disconnect(5);
2932         do_test_drop_messages_peer_disconnect(6);
2933 }
2934
2935 #[test]
2936 fn test_funding_peer_disconnect() {
2937         // Test that we can lock in our funding tx while disconnected
2938         let nodes = create_network(2);
2939         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
2940
2941         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2942         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2943
2944         confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
2945         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
2946         assert_eq!(events_1.len(), 1);
2947         match events_1[0] {
2948                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
2949                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
2950                 },
2951                 _ => panic!("Unexpected event"),
2952         }
2953
2954         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2955
2956         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2957         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2958
2959         confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
2960         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2961         assert_eq!(events_2.len(), 2);
2962         match events_2[0] {
2963                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
2964                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2965                 },
2966                 _ => panic!("Unexpected event"),
2967         }
2968         match events_2[1] {
2969                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
2970                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2971                 },
2972                 _ => panic!("Unexpected event"),
2973         }
2974
2975         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2976
2977         // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
2978         // rebroadcasting announcement_signatures upon reconnect.
2979
2980         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2981         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
2982         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
2983 }
2984
2985 #[test]
2986 fn test_drop_messages_peer_disconnect_dual_htlc() {
2987         // Test that we can handle reconnecting when both sides of a channel have pending
2988         // commitment_updates when we disconnect.
2989         let mut nodes = create_network(2);
2990         create_announced_chan_between_nodes(&nodes, 0, 1);
2991
2992         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2993
2994         // Now try to send a second payment which will fail to send
2995         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2996         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
2997
2998         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
2999         check_added_monitors!(nodes[0], 1);
3000
3001         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3002         assert_eq!(events_1.len(), 1);
3003         match events_1[0] {
3004                 MessageSendEvent::UpdateHTLCs { .. } => {},
3005                 _ => panic!("Unexpected event"),
3006         }
3007
3008         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3009         check_added_monitors!(nodes[1], 1);
3010
3011         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3012         assert_eq!(events_2.len(), 1);
3013         match events_2[0] {
3014                 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 } } => {
3015                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3016                         assert!(update_add_htlcs.is_empty());
3017                         assert_eq!(update_fulfill_htlcs.len(), 1);
3018                         assert!(update_fail_htlcs.is_empty());
3019                         assert!(update_fail_malformed_htlcs.is_empty());
3020                         assert!(update_fee.is_none());
3021
3022                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3023                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3024                         assert_eq!(events_3.len(), 1);
3025                         match events_3[0] {
3026                                 Event::PaymentSent { ref payment_preimage } => {
3027                                         assert_eq!(*payment_preimage, payment_preimage_1);
3028                                 },
3029                                 _ => panic!("Unexpected event"),
3030                         }
3031
3032                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3033                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3034                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3035                         check_added_monitors!(nodes[0], 1);
3036                 },
3037                 _ => panic!("Unexpected event"),
3038         }
3039
3040         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3041         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3042
3043         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3044         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3045         assert_eq!(reestablish_1.len(), 1);
3046         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3047         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3048         assert_eq!(reestablish_2.len(), 1);
3049
3050         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3051         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3052         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3053         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3054
3055         assert!(as_resp.0.is_none());
3056         assert!(bs_resp.0.is_none());
3057
3058         assert!(bs_resp.1.is_none());
3059         assert!(bs_resp.2.is_none());
3060
3061         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3062
3063         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3064         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3065         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3066         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3067         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3068         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
3069         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
3070         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3071         // No commitment_signed so get_event_msg's assert(len == 1) passes
3072         check_added_monitors!(nodes[1], 1);
3073
3074         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
3075         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3076         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3077         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3078         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3079         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3080         assert!(bs_second_commitment_signed.update_fee.is_none());
3081         check_added_monitors!(nodes[1], 1);
3082
3083         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3084         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3085         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3086         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3087         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3088         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3089         assert!(as_commitment_signed.update_fee.is_none());
3090         check_added_monitors!(nodes[0], 1);
3091
3092         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
3093         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3094         // No commitment_signed so get_event_msg's assert(len == 1) passes
3095         check_added_monitors!(nodes[0], 1);
3096
3097         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
3098         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3099         // No commitment_signed so get_event_msg's assert(len == 1) passes
3100         check_added_monitors!(nodes[1], 1);
3101
3102         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3103         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3104         check_added_monitors!(nodes[1], 1);
3105
3106         expect_pending_htlcs_forwardable!(nodes[1]);
3107
3108         let events_5 = nodes[1].node.get_and_clear_pending_events();
3109         assert_eq!(events_5.len(), 1);
3110         match events_5[0] {
3111                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3112                         assert_eq!(payment_hash_2, *payment_hash);
3113                 },
3114                 _ => panic!("Unexpected event"),
3115         }
3116
3117         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
3118         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3119         check_added_monitors!(nodes[0], 1);
3120
3121         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3122 }
3123
3124 #[test]
3125 fn test_invalid_channel_announcement() {
3126         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3127         let secp_ctx = Secp256k1::new();
3128         let nodes = create_network(2);
3129
3130         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
3131
3132         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3133         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3134         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3135         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3136
3137         let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3138
3139         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
3140         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
3141
3142         let as_network_key = nodes[0].node.get_our_node_id();
3143         let bs_network_key = nodes[1].node.get_our_node_id();
3144
3145         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3146
3147         let mut chan_announcement;
3148
3149         macro_rules! dummy_unsigned_msg {
3150                 () => {
3151                         msgs::UnsignedChannelAnnouncement {
3152                                 features: msgs::GlobalFeatures::new(),
3153                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3154                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3155                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3156                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3157                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3158                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3159                                 excess_data: Vec::new(),
3160                         };
3161                 }
3162         }
3163
3164         macro_rules! sign_msg {
3165                 ($unsigned_msg: expr) => {
3166                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3167                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
3168                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
3169                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3170                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3171                         chan_announcement = msgs::ChannelAnnouncement {
3172                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3173                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3174                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3175                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3176                                 contents: $unsigned_msg
3177                         }
3178                 }
3179         }
3180
3181         let unsigned_msg = dummy_unsigned_msg!();
3182         sign_msg!(unsigned_msg);
3183         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3184         let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3185
3186         // Configured with Network::Testnet
3187         let mut unsigned_msg = dummy_unsigned_msg!();
3188         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3189         sign_msg!(unsigned_msg);
3190         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3191
3192         let mut unsigned_msg = dummy_unsigned_msg!();
3193         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3194         sign_msg!(unsigned_msg);
3195         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3196 }
3197
3198 #[test]
3199 fn test_no_txn_manager_serialize_deserialize() {
3200         let mut nodes = create_network(2);
3201
3202         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
3203
3204         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3205
3206         let nodes_0_serialized = nodes[0].node.encode();
3207         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3208         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3209
3210         nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3211         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3212         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3213         assert!(chan_0_monitor_read.is_empty());
3214
3215         let mut nodes_0_read = &nodes_0_serialized[..];
3216         let config = UserConfig::new();
3217         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3218         let (_, nodes_0_deserialized) = {
3219                 let mut channel_monitors = HashMap::new();
3220                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3221                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3222                         default_config: config,
3223                         keys_manager,
3224                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3225                         monitor: nodes[0].chan_monitor.clone(),
3226                         chain_monitor: nodes[0].chain_monitor.clone(),
3227                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3228                         logger: Arc::new(test_utils::TestLogger::new()),
3229                         channel_monitors: &channel_monitors,
3230                 }).unwrap()
3231         };
3232         assert!(nodes_0_read.is_empty());
3233
3234         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3235         nodes[0].node = Arc::new(nodes_0_deserialized);
3236         let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
3237         nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
3238         assert_eq!(nodes[0].node.list_channels().len(), 1);
3239         check_added_monitors!(nodes[0], 1);
3240
3241         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3242         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3243         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3244         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3245
3246         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3247         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3248         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3249         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3250
3251         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3252         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3253         for node in nodes.iter() {
3254                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3255                 node.router.handle_channel_update(&as_update).unwrap();
3256                 node.router.handle_channel_update(&bs_update).unwrap();
3257         }
3258
3259         send_payment(&nodes[0], &[&nodes[1]], 1000000);
3260 }
3261
3262 #[test]
3263 fn test_simple_manager_serialize_deserialize() {
3264         let mut nodes = create_network(2);
3265         create_announced_chan_between_nodes(&nodes, 0, 1);
3266
3267         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3268         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3269
3270         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3271
3272         let nodes_0_serialized = nodes[0].node.encode();
3273         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3274         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3275
3276         nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3277         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3278         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3279         assert!(chan_0_monitor_read.is_empty());
3280
3281         let mut nodes_0_read = &nodes_0_serialized[..];
3282         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3283         let (_, nodes_0_deserialized) = {
3284                 let mut channel_monitors = HashMap::new();
3285                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3286                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3287                         default_config: UserConfig::new(),
3288                         keys_manager,
3289                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3290                         monitor: nodes[0].chan_monitor.clone(),
3291                         chain_monitor: nodes[0].chain_monitor.clone(),
3292                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3293                         logger: Arc::new(test_utils::TestLogger::new()),
3294                         channel_monitors: &channel_monitors,
3295                 }).unwrap()
3296         };
3297         assert!(nodes_0_read.is_empty());
3298
3299         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3300         nodes[0].node = Arc::new(nodes_0_deserialized);
3301         check_added_monitors!(nodes[0], 1);
3302
3303         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3304
3305         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3306         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
3307 }
3308
3309 #[test]
3310 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3311         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3312         let mut nodes = create_network(4);
3313         create_announced_chan_between_nodes(&nodes, 0, 1);
3314         create_announced_chan_between_nodes(&nodes, 2, 0);
3315         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
3316
3317         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3318
3319         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3320         let nodes_0_serialized = nodes[0].node.encode();
3321
3322         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3323         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3324         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3325         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3326
3327         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3328         // nodes[3])
3329         let mut node_0_monitors_serialized = Vec::new();
3330         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3331                 let mut writer = test_utils::TestVecWriter(Vec::new());
3332                 monitor.1.write_for_disk(&mut writer).unwrap();
3333                 node_0_monitors_serialized.push(writer.0);
3334         }
3335
3336         nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3337         let mut node_0_monitors = Vec::new();
3338         for serialized in node_0_monitors_serialized.iter() {
3339                 let mut read = &serialized[..];
3340                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3341                 assert!(read.is_empty());
3342                 node_0_monitors.push(monitor);
3343         }
3344
3345         let mut nodes_0_read = &nodes_0_serialized[..];
3346         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3347         let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3348                 default_config: UserConfig::new(),
3349                 keys_manager,
3350                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3351                 monitor: nodes[0].chan_monitor.clone(),
3352                 chain_monitor: nodes[0].chain_monitor.clone(),
3353                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3354                 logger: Arc::new(test_utils::TestLogger::new()),
3355                 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3356         }).unwrap();
3357         assert!(nodes_0_read.is_empty());
3358
3359         { // Channel close should result in a commitment tx and an HTLC tx
3360                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3361                 assert_eq!(txn.len(), 2);
3362                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3363                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3364         }
3365
3366         for monitor in node_0_monitors.drain(..) {
3367                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3368                 check_added_monitors!(nodes[0], 1);
3369         }
3370         nodes[0].node = Arc::new(nodes_0_deserialized);
3371
3372         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3373         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3374         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3375         //... and we can even still claim the payment!
3376         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
3377
3378         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
3379         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3380         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
3381         if let Err(msgs::HandleError { action: Some(msgs::ErrorAction::SendErrorMessage { msg }), .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
3382                 assert_eq!(msg.channel_id, channel_id);
3383         } else { panic!("Unexpected result"); }
3384 }
3385
3386 macro_rules! check_spendable_outputs {
3387         ($node: expr, $der_idx: expr) => {
3388                 {
3389                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3390                         let mut txn = Vec::new();
3391                         for event in events {
3392                                 match event {
3393                                         Event::SpendableOutputs { ref outputs } => {
3394                                                 for outp in outputs {
3395                                                         match *outp {
3396                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3397                                                                         let input = TxIn {
3398                                                                                 previous_output: outpoint.clone(),
3399                                                                                 script_sig: Script::new(),
3400                                                                                 sequence: 0,
3401                                                                                 witness: Vec::new(),
3402                                                                         };
3403                                                                         let outp = TxOut {
3404                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3405                                                                                 value: output.value,
3406                                                                         };
3407                                                                         let mut spend_tx = Transaction {
3408                                                                                 version: 2,
3409                                                                                 lock_time: 0,
3410                                                                                 input: vec![input],
3411                                                                                 output: vec![outp],
3412                                                                         };
3413                                                                         let secp_ctx = Secp256k1::new();
3414                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3415                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3416                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3417                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3418                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3419                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3420                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3421                                                                         txn.push(spend_tx);
3422                                                                 },
3423                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3424                                                                         let input = TxIn {
3425                                                                                 previous_output: outpoint.clone(),
3426                                                                                 script_sig: Script::new(),
3427                                                                                 sequence: *to_self_delay as u32,
3428                                                                                 witness: Vec::new(),
3429                                                                         };
3430                                                                         let outp = TxOut {
3431                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3432                                                                                 value: output.value,
3433                                                                         };
3434                                                                         let mut spend_tx = Transaction {
3435                                                                                 version: 2,
3436                                                                                 lock_time: 0,
3437                                                                                 input: vec![input],
3438                                                                                 output: vec![outp],
3439                                                                         };
3440                                                                         let secp_ctx = Secp256k1::new();
3441                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3442                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3443                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3444                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3445                                                                         spend_tx.input[0].witness.push(vec!(0));
3446                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3447                                                                         txn.push(spend_tx);
3448                                                                 },
3449                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3450                                                                         let secp_ctx = Secp256k1::new();
3451                                                                         let input = TxIn {
3452                                                                                 previous_output: outpoint.clone(),
3453                                                                                 script_sig: Script::new(),
3454                                                                                 sequence: 0,
3455                                                                                 witness: Vec::new(),
3456                                                                         };
3457                                                                         let outp = TxOut {
3458                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3459                                                                                 value: output.value,
3460                                                                         };
3461                                                                         let mut spend_tx = Transaction {
3462                                                                                 version: 2,
3463                                                                                 lock_time: 0,
3464                                                                                 input: vec![input],
3465                                                                                 output: vec![outp.clone()],
3466                                                                         };
3467                                                                         let secret = {
3468                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3469                                                                                         Ok(master_key) => {
3470                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3471                                                                                                         Ok(key) => key,
3472                                                                                                         Err(_) => panic!("Your RNG is busted"),
3473                                                                                                 }
3474                                                                                         }
3475                                                                                         Err(_) => panic!("Your rng is busted"),
3476                                                                                 }
3477                                                                         };
3478                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3479                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3480                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3481                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3482                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3483                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3484                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3485                                                                         txn.push(spend_tx);
3486                                                                 },
3487                                                         }
3488                                                 }
3489                                         },
3490                                         _ => panic!("Unexpected event"),
3491                                 };
3492                         }
3493                         txn
3494                 }
3495         }
3496 }
3497
3498 #[test]
3499 fn test_claim_sizeable_push_msat() {
3500         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3501         let nodes = create_network(2);
3502
3503         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
3504         nodes[1].node.force_close_channel(&chan.2);
3505         check_closed_broadcast!(nodes[1]);
3506         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3507         assert_eq!(node_txn.len(), 1);
3508         check_spends!(node_txn[0], chan.3.clone());
3509         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
3510
3511         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3512         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3513         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3514         assert_eq!(spend_txn.len(), 1);
3515         check_spends!(spend_txn[0], node_txn[0].clone());
3516 }
3517
3518 #[test]
3519 fn test_claim_on_remote_sizeable_push_msat() {
3520         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3521         // to_remote output is encumbered by a P2WPKH
3522
3523         let nodes = create_network(2);
3524
3525         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
3526         nodes[0].node.force_close_channel(&chan.2);
3527         check_closed_broadcast!(nodes[0]);
3528
3529         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3530         assert_eq!(node_txn.len(), 1);
3531         check_spends!(node_txn[0], chan.3.clone());
3532         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
3533
3534         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3535         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3536         check_closed_broadcast!(nodes[1]);
3537         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3538         assert_eq!(spend_txn.len(), 2);
3539         assert_eq!(spend_txn[0], spend_txn[1]);
3540         check_spends!(spend_txn[0], node_txn[0].clone());
3541 }
3542
3543 #[test]
3544 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3545         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3546         // to_remote output is encumbered by a P2WPKH
3547
3548         let nodes = create_network(2);
3549
3550         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
3551         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3552         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
3553         assert_eq!(revoked_local_txn[0].input.len(), 1);
3554         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3555
3556         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3557         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3558         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3559         check_closed_broadcast!(nodes[1]);
3560
3561         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3562         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3563         assert_eq!(spend_txn.len(), 4);
3564         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3565         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3566         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3567         check_spends!(spend_txn[1], node_txn[0].clone());
3568 }
3569
3570 #[test]
3571 fn test_static_spendable_outputs_preimage_tx() {
3572         let nodes = create_network(2);
3573
3574         // Create some initial channels
3575         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3576
3577         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3578
3579         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3580         assert_eq!(commitment_tx[0].input.len(), 1);
3581         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3582
3583         // Settle A's commitment tx on B's chain
3584         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3585         assert!(nodes[1].node.claim_funds(payment_preimage));
3586         check_added_monitors!(nodes[1], 1);
3587         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3588         let events = nodes[1].node.get_and_clear_pending_msg_events();
3589         match events[0] {
3590                 MessageSendEvent::UpdateHTLCs { .. } => {},
3591                 _ => panic!("Unexpected event"),
3592         }
3593         match events[1] {
3594                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3595                 _ => panic!("Unexepected event"),
3596         }
3597
3598         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3599         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
3600         check_spends!(node_txn[0], commitment_tx[0].clone());
3601         assert_eq!(node_txn[0], node_txn[2]);
3602         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3603         check_spends!(node_txn[1], chan_1.3.clone());
3604
3605         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3606         assert_eq!(spend_txn.len(), 2);
3607         assert_eq!(spend_txn[0], spend_txn[1]);
3608         check_spends!(spend_txn[0], node_txn[0].clone());
3609 }
3610
3611 #[test]
3612 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3613         let nodes = create_network(2);
3614
3615         // Create some initial channels
3616         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3617
3618         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3619         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3620         assert_eq!(revoked_local_txn[0].input.len(), 1);
3621         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3622
3623         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3624
3625         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3626         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3627         check_closed_broadcast!(nodes[1]);
3628
3629         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3630         assert_eq!(node_txn.len(), 3);
3631         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3632         assert_eq!(node_txn[0].input.len(), 2);
3633         check_spends!(node_txn[0], revoked_local_txn[0].clone());
3634
3635         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3636         assert_eq!(spend_txn.len(), 2);
3637         assert_eq!(spend_txn[0], spend_txn[1]);
3638         check_spends!(spend_txn[0], node_txn[0].clone());
3639 }
3640
3641 #[test]
3642 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3643         let nodes = create_network(2);
3644
3645         // Create some initial channels
3646         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3647
3648         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3649         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3650         assert_eq!(revoked_local_txn[0].input.len(), 1);
3651         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3652
3653         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3654
3655         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3656         // A will generate HTLC-Timeout from revoked commitment tx
3657         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3658         check_closed_broadcast!(nodes[0]);
3659
3660         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3661         assert_eq!(revoked_htlc_txn.len(), 3);
3662         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3663         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3664         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3665         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3666         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3667
3668         // B will generate justice tx from A's revoked commitment/HTLC tx
3669         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3670         check_closed_broadcast!(nodes[1]);
3671
3672         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3673         assert_eq!(node_txn.len(), 4);
3674         assert_eq!(node_txn[3].input.len(), 1);
3675         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3676
3677         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
3678         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3679         assert_eq!(spend_txn.len(), 3);
3680         assert_eq!(spend_txn[0], spend_txn[1]);
3681         check_spends!(spend_txn[0], node_txn[0].clone());
3682         check_spends!(spend_txn[2], node_txn[3].clone());
3683 }
3684
3685 #[test]
3686 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
3687         let nodes = create_network(2);
3688
3689         // Create some initial channels
3690         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3691
3692         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3693         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3694         assert_eq!(revoked_local_txn[0].input.len(), 1);
3695         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3696
3697         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3698
3699         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3700         // B will generate HTLC-Success from revoked commitment tx
3701         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3702         check_closed_broadcast!(nodes[1]);
3703         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3704
3705         assert_eq!(revoked_htlc_txn.len(), 3);
3706         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3707         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3708         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3709         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3710
3711         // A will generate justice tx from B's revoked commitment/HTLC tx
3712         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3713         check_closed_broadcast!(nodes[0]);
3714
3715         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3716         assert_eq!(node_txn.len(), 4);
3717         assert_eq!(node_txn[3].input.len(), 1);
3718         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3719
3720         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
3721         let spend_txn = check_spendable_outputs!(nodes[0], 1);
3722         assert_eq!(spend_txn.len(), 5);
3723         assert_eq!(spend_txn[0], spend_txn[2]);
3724         assert_eq!(spend_txn[1], spend_txn[3]);
3725         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
3726         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
3727         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
3728 }
3729
3730 #[test]
3731 fn test_onchain_to_onchain_claim() {
3732         // Test that in case of channel closure, we detect the state of output thanks to
3733         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
3734         // First, have C claim an HTLC against its own latest commitment transaction.
3735         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
3736         // channel.
3737         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
3738         // gets broadcast.
3739
3740         let nodes = create_network(3);
3741
3742         // Create some initial channels
3743         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3744         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3745
3746         // Rebalance the network a bit by relaying one payment through all the channels ...
3747         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3748         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3749
3750         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3751         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3752         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3753         check_spends!(commitment_tx[0], chan_2.3.clone());
3754         nodes[2].node.claim_funds(payment_preimage);
3755         check_added_monitors!(nodes[2], 1);
3756         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3757         assert!(updates.update_add_htlcs.is_empty());
3758         assert!(updates.update_fail_htlcs.is_empty());
3759         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3760         assert!(updates.update_fail_malformed_htlcs.is_empty());
3761
3762         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3763         check_closed_broadcast!(nodes[2]);
3764
3765         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
3766         assert_eq!(c_txn.len(), 3);
3767         assert_eq!(c_txn[0], c_txn[2]);
3768         assert_eq!(commitment_tx[0], c_txn[1]);
3769         check_spends!(c_txn[1], chan_2.3.clone());
3770         check_spends!(c_txn[2], c_txn[1].clone());
3771         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
3772         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3773         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3774         assert_eq!(c_txn[0].lock_time, 0); // Success tx
3775
3776         // 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
3777         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
3778         {
3779                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3780                 assert_eq!(b_txn.len(), 4);
3781                 assert_eq!(b_txn[0], b_txn[3]);
3782                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
3783                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
3784                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3785                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3786                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3787                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
3788                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3789                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3790                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3791                 b_txn.clear();
3792         }
3793         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
3794         check_added_monitors!(nodes[1], 1);
3795         match msg_events[0] {
3796                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
3797                 _ => panic!("Unexpected event"),
3798         }
3799         match msg_events[1] {
3800                 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, .. } } => {
3801                         assert!(update_add_htlcs.is_empty());
3802                         assert!(update_fail_htlcs.is_empty());
3803                         assert_eq!(update_fulfill_htlcs.len(), 1);
3804                         assert!(update_fail_malformed_htlcs.is_empty());
3805                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3806                 },
3807                 _ => panic!("Unexpected event"),
3808         };
3809         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
3810         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3811         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3812         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3813         assert_eq!(b_txn.len(), 3);
3814         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
3815         assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
3816         check_spends!(b_txn[0], commitment_tx[0].clone());
3817         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3818         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3819         assert_eq!(b_txn[2].lock_time, 0); // Success tx
3820
3821         check_closed_broadcast!(nodes[1]);
3822 }
3823
3824 #[test]
3825 fn test_duplicate_payment_hash_one_failure_one_success() {
3826         // Topology : A --> B --> C
3827         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
3828         let mut nodes = create_network(3);
3829
3830         create_announced_chan_between_nodes(&nodes, 0, 1);
3831         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3832
3833         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
3834         *nodes[0].network_payment_count.borrow_mut() -= 1;
3835         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
3836
3837         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3838         assert_eq!(commitment_txn[0].input.len(), 1);
3839         check_spends!(commitment_txn[0], chan_2.3.clone());
3840
3841         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3842         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
3843         check_closed_broadcast!(nodes[1]);
3844
3845         let htlc_timeout_tx;
3846         { // Extract one of the two HTLC-Timeout transaction
3847                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3848                 assert_eq!(node_txn.len(), 7);
3849                 assert_eq!(node_txn[0], node_txn[5]);
3850                 assert_eq!(node_txn[1], node_txn[6]);
3851                 check_spends!(node_txn[0], commitment_txn[0].clone());
3852                 assert_eq!(node_txn[0].input.len(), 1);
3853                 check_spends!(node_txn[1], commitment_txn[0].clone());
3854                 assert_eq!(node_txn[1].input.len(), 1);
3855                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
3856                 check_spends!(node_txn[2], chan_2.3.clone());
3857                 check_spends!(node_txn[3], node_txn[2].clone());
3858                 check_spends!(node_txn[4], node_txn[2].clone());
3859                 htlc_timeout_tx = node_txn[1].clone();
3860         }
3861
3862         nodes[2].node.claim_funds(our_payment_preimage);
3863         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
3864         check_added_monitors!(nodes[2], 2);
3865         let events = nodes[2].node.get_and_clear_pending_msg_events();
3866         match events[0] {
3867                 MessageSendEvent::UpdateHTLCs { .. } => {},
3868                 _ => panic!("Unexpected event"),
3869         }
3870         match events[1] {
3871                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3872                 _ => panic!("Unexepected event"),
3873         }
3874         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
3875         assert_eq!(htlc_success_txn.len(), 5);
3876         check_spends!(htlc_success_txn[2], chan_2.3.clone());
3877         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
3878         assert_eq!(htlc_success_txn[0].input.len(), 1);
3879         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3880         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
3881         assert_eq!(htlc_success_txn[1].input.len(), 1);
3882         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3883         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
3884         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
3885         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
3886
3887         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
3888         expect_pending_htlcs_forwardable!(nodes[1]);
3889         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3890         assert!(htlc_updates.update_add_htlcs.is_empty());
3891         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
3892         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
3893         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
3894         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
3895         check_added_monitors!(nodes[1], 1);
3896
3897         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
3898         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3899         {
3900                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
3901                 let events = nodes[0].node.get_and_clear_pending_msg_events();
3902                 assert_eq!(events.len(), 1);
3903                 match events[0] {
3904                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
3905                         },
3906                         _ => { panic!("Unexpected event"); }
3907                 }
3908         }
3909         let events = nodes[0].node.get_and_clear_pending_events();
3910         match events[0] {
3911                 Event::PaymentFailed { ref payment_hash, .. } => {
3912                         assert_eq!(*payment_hash, duplicate_payment_hash);
3913                 }
3914                 _ => panic!("Unexpected event"),
3915         }
3916
3917         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
3918         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
3919         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3920         assert!(updates.update_add_htlcs.is_empty());
3921         assert!(updates.update_fail_htlcs.is_empty());
3922         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3923         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
3924         assert!(updates.update_fail_malformed_htlcs.is_empty());
3925         check_added_monitors!(nodes[1], 1);
3926
3927         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
3928         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
3929
3930         let events = nodes[0].node.get_and_clear_pending_events();
3931         match events[0] {
3932                 Event::PaymentSent { ref payment_preimage } => {
3933                         assert_eq!(*payment_preimage, our_payment_preimage);
3934                 }
3935                 _ => panic!("Unexpected event"),
3936         }
3937 }
3938
3939 #[test]
3940 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
3941         let nodes = create_network(2);
3942
3943         // Create some initial channels
3944         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3945
3946         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
3947         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3948         assert_eq!(local_txn[0].input.len(), 1);
3949         check_spends!(local_txn[0], chan_1.3.clone());
3950
3951         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
3952         nodes[1].node.claim_funds(payment_preimage);
3953         check_added_monitors!(nodes[1], 1);
3954         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3955         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
3956         let events = nodes[1].node.get_and_clear_pending_msg_events();
3957         match events[0] {
3958                 MessageSendEvent::UpdateHTLCs { .. } => {},
3959                 _ => panic!("Unexpected event"),
3960         }
3961         match events[1] {
3962                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3963                 _ => panic!("Unexepected event"),
3964         }
3965         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3966         assert_eq!(node_txn[0].input.len(), 1);
3967         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3968         check_spends!(node_txn[0], local_txn[0].clone());
3969
3970         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
3971         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3972         assert_eq!(spend_txn.len(), 2);
3973         check_spends!(spend_txn[0], node_txn[0].clone());
3974         check_spends!(spend_txn[1], node_txn[2].clone());
3975 }
3976
3977 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
3978         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
3979         // unrevoked commitment transaction.
3980         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
3981         // a remote RAA before they could be failed backwards (and combinations thereof).
3982         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
3983         // use the same payment hashes.
3984         // Thus, we use a six-node network:
3985         //
3986         // A \         / E
3987         //    - C - D -
3988         // B /         \ F
3989         // And test where C fails back to A/B when D announces its latest commitment transaction
3990         let nodes = create_network(6);
3991
3992         create_announced_chan_between_nodes(&nodes, 0, 2);
3993         create_announced_chan_between_nodes(&nodes, 1, 2);
3994         let chan = create_announced_chan_between_nodes(&nodes, 2, 3);
3995         create_announced_chan_between_nodes(&nodes, 3, 4);
3996         create_announced_chan_between_nodes(&nodes, 3, 5);
3997
3998         // Rebalance and check output sanity...
3999         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
4000         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
4001         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 2);
4002
4003         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4004         // 0th HTLC:
4005         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
4006         // 1st HTLC:
4007         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
4008         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4009         // 2nd HTLC:
4010         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
4011         // 3rd HTLC:
4012         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
4013         // 4th HTLC:
4014         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4015         // 5th HTLC:
4016         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4017         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4018         // 6th HTLC:
4019         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4020         // 7th HTLC:
4021         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4022
4023         // 8th HTLC:
4024         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4025         // 9th HTLC:
4026         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4027         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
4028
4029         // 10th HTLC:
4030         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
4031         // 11th HTLC:
4032         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4033         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4034
4035         // Double-check that six of the new HTLC were added
4036         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4037         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4038         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.len(), 1);
4039         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 8);
4040
4041         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4042         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4043         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4044         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4045         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4046         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4047         check_added_monitors!(nodes[4], 0);
4048         expect_pending_htlcs_forwardable!(nodes[4]);
4049         check_added_monitors!(nodes[4], 1);
4050
4051         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4052         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]).unwrap();
4053         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]).unwrap();
4054         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]).unwrap();
4055         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]).unwrap();
4056         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4057
4058         // Fail 3rd below-dust and 7th above-dust HTLCs
4059         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4060         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4061         check_added_monitors!(nodes[5], 0);
4062         expect_pending_htlcs_forwardable!(nodes[5]);
4063         check_added_monitors!(nodes[5], 1);
4064
4065         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4066         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]).unwrap();
4067         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]).unwrap();
4068         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4069
4070         let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4071
4072         expect_pending_htlcs_forwardable!(nodes[3]);
4073         check_added_monitors!(nodes[3], 1);
4074         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4075         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]).unwrap();
4076         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]).unwrap();
4077         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]).unwrap();
4078         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]).unwrap();
4079         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]).unwrap();
4080         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]).unwrap();
4081         if deliver_last_raa {
4082                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4083         } else {
4084                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4085         }
4086
4087         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4088         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4089         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4090         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4091         //
4092         // We now broadcast the latest commitment transaction, which *should* result in failures for
4093         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4094         // the non-broadcast above-dust HTLCs.
4095         //
4096         // Alternatively, we may broadcast the previous commitment transaction, which should only
4097         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4098         let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4099
4100         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4101         if announce_latest {
4102                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_last_commitment_tx[0]], &[1; 1]);
4103         } else {
4104                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_prev_commitment_tx[0]], &[1; 1]);
4105         }
4106         check_closed_broadcast!(nodes[2]);
4107         expect_pending_htlcs_forwardable!(nodes[2]);
4108         check_added_monitors!(nodes[2], 2);
4109
4110         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4111         assert_eq!(cs_msgs.len(), 2);
4112         let mut a_done = false;
4113         for msg in cs_msgs {
4114                 match msg {
4115                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4116                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4117                                 // should be failed-backwards here.
4118                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4119                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4120                                         for htlc in &updates.update_fail_htlcs {
4121                                                 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 });
4122                                         }
4123                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4124                                         assert!(!a_done);
4125                                         a_done = true;
4126                                         &nodes[0]
4127                                 } else {
4128                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4129                                         for htlc in &updates.update_fail_htlcs {
4130                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4131                                         }
4132                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4133                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4134                                         &nodes[1]
4135                                 };
4136                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4137                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]).unwrap();
4138                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]).unwrap();
4139                                 if announce_latest {
4140                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]).unwrap();
4141                                         if *node_id == nodes[0].node.get_our_node_id() {
4142                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]).unwrap();
4143                                         }
4144                                 }
4145                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4146                         },
4147                         _ => panic!("Unexpected event"),
4148                 }
4149         }
4150
4151         let as_events = nodes[0].node.get_and_clear_pending_events();
4152         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4153         let mut as_failds = HashSet::new();
4154         for event in as_events.iter() {
4155                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4156                         assert!(as_failds.insert(*payment_hash));
4157                         if *payment_hash != payment_hash_2 {
4158                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4159                         } else {
4160                                 assert!(!rejected_by_dest);
4161                         }
4162                 } else { panic!("Unexpected event"); }
4163         }
4164         assert!(as_failds.contains(&payment_hash_1));
4165         assert!(as_failds.contains(&payment_hash_2));
4166         if announce_latest {
4167                 assert!(as_failds.contains(&payment_hash_3));
4168                 assert!(as_failds.contains(&payment_hash_5));
4169         }
4170         assert!(as_failds.contains(&payment_hash_6));
4171
4172         let bs_events = nodes[1].node.get_and_clear_pending_events();
4173         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4174         let mut bs_failds = HashSet::new();
4175         for event in bs_events.iter() {
4176                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4177                         assert!(bs_failds.insert(*payment_hash));
4178                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4179                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4180                         } else {
4181                                 assert!(!rejected_by_dest);
4182                         }
4183                 } else { panic!("Unexpected event"); }
4184         }
4185         assert!(bs_failds.contains(&payment_hash_1));
4186         assert!(bs_failds.contains(&payment_hash_2));
4187         if announce_latest {
4188                 assert!(bs_failds.contains(&payment_hash_4));
4189         }
4190         assert!(bs_failds.contains(&payment_hash_5));
4191
4192         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4193         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4194         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4195         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4196         // PaymentFailureNetworkUpdates.
4197         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4198         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4199         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4200         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4201         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4202                 match event {
4203                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4204                         _ => panic!("Unexpected event"),
4205                 }
4206         }
4207 }
4208
4209 #[test]
4210 fn test_fail_backwards_latest_remote_announce_a() {
4211         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4212 }
4213
4214 #[test]
4215 fn test_fail_backwards_latest_remote_announce_b() {
4216         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4217 }
4218
4219 #[test]
4220 fn test_fail_backwards_previous_remote_announce() {
4221         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4222         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4223         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4224 }
4225
4226 #[test]
4227 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4228         let nodes = create_network(2);
4229
4230         // Create some initial channels
4231         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4232
4233         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4234         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4235         assert_eq!(local_txn[0].input.len(), 1);
4236         check_spends!(local_txn[0], chan_1.3.clone());
4237
4238         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4239         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4240         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4241         check_closed_broadcast!(nodes[0]);
4242
4243         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4244         assert_eq!(node_txn[0].input.len(), 1);
4245         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4246         check_spends!(node_txn[0], local_txn[0].clone());
4247
4248         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4249         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4250         assert_eq!(spend_txn.len(), 8);
4251         assert_eq!(spend_txn[0], spend_txn[2]);
4252         assert_eq!(spend_txn[0], spend_txn[4]);
4253         assert_eq!(spend_txn[0], spend_txn[6]);
4254         assert_eq!(spend_txn[1], spend_txn[3]);
4255         assert_eq!(spend_txn[1], spend_txn[5]);
4256         assert_eq!(spend_txn[1], spend_txn[7]);
4257         check_spends!(spend_txn[0], local_txn[0].clone());
4258         check_spends!(spend_txn[1], node_txn[0].clone());
4259 }
4260
4261 #[test]
4262 fn test_static_output_closing_tx() {
4263         let nodes = create_network(2);
4264
4265         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4266
4267         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4268         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4269
4270         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4271         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4272         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4273         assert_eq!(spend_txn.len(), 1);
4274         check_spends!(spend_txn[0], closing_tx.clone());
4275
4276         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4277         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4278         assert_eq!(spend_txn.len(), 1);
4279         check_spends!(spend_txn[0], closing_tx);
4280 }
4281
4282 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4283         let nodes = create_network(2);
4284         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4285
4286         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4287
4288         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4289         // present in B's local commitment transaction, but none of A's commitment transactions.
4290         assert!(nodes[1].node.claim_funds(our_payment_preimage));
4291         check_added_monitors!(nodes[1], 1);
4292
4293         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4294         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]).unwrap();
4295         let events = nodes[0].node.get_and_clear_pending_events();
4296         assert_eq!(events.len(), 1);
4297         match events[0] {
4298                 Event::PaymentSent { payment_preimage } => {
4299                         assert_eq!(payment_preimage, our_payment_preimage);
4300                 },
4301                 _ => panic!("Unexpected event"),
4302         }
4303
4304         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4305         check_added_monitors!(nodes[0], 1);
4306         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4307         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4308         check_added_monitors!(nodes[1], 1);
4309
4310         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4311         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4312                 nodes[1].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4313                 header.prev_blockhash = header.bitcoin_hash();
4314         }
4315         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4316         check_closed_broadcast!(nodes[1]);
4317 }
4318
4319 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4320         let mut nodes = create_network(2);
4321         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4322
4323         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV).unwrap();
4324         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4325         nodes[0].node.send_payment(route, payment_hash).unwrap();
4326         check_added_monitors!(nodes[0], 1);
4327
4328         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4329
4330         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4331         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4332         // to "time out" the HTLC.
4333
4334         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4335         for i in 1..TEST_FINAL_CLTV + HTLC_FAIL_TIMEOUT_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4336                 nodes[0].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4337                 header.prev_blockhash = header.bitcoin_hash();
4338         }
4339         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4340         check_closed_broadcast!(nodes[0]);
4341 }
4342
4343 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4344         let nodes = create_network(3);
4345         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4346
4347         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4348         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4349         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4350         // actually revoked.
4351         let htlc_value = if use_dust { 50000 } else { 3000000 };
4352         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4353         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4354         expect_pending_htlcs_forwardable!(nodes[1]);
4355         check_added_monitors!(nodes[1], 1);
4356
4357         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4358         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]).unwrap();
4359         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4360         check_added_monitors!(nodes[0], 1);
4361         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4362         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4363         check_added_monitors!(nodes[1], 1);
4364         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1).unwrap();
4365         check_added_monitors!(nodes[1], 1);
4366         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4367
4368         if check_revoke_no_close {
4369                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4370                 check_added_monitors!(nodes[0], 1);
4371         }
4372
4373         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4374         for i in 1..TEST_FINAL_CLTV + HTLC_FAIL_TIMEOUT_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4375                 nodes[0].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4376                 header.prev_blockhash = header.bitcoin_hash();
4377         }
4378         if !check_revoke_no_close {
4379                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4380                 check_closed_broadcast!(nodes[0]);
4381         } else {
4382                 let events = nodes[0].node.get_and_clear_pending_events();
4383                 assert_eq!(events.len(), 1);
4384                 match events[0] {
4385                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4386                                 assert_eq!(payment_hash, our_payment_hash);
4387                                 assert!(rejected_by_dest);
4388                         },
4389                         _ => panic!("Unexpected event"),
4390                 }
4391         }
4392 }
4393
4394 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4395 // There are only a few cases to test here:
4396 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4397 //    broadcastable commitment transactions result in channel closure,
4398 //  * its included in an unrevoked-but-previous remote commitment transaction,
4399 //  * its included in the latest remote or local commitment transactions.
4400 // We test each of the three possible commitment transactions individually and use both dust and
4401 // non-dust HTLCs.
4402 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4403 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4404 // tested for at least one of the cases in other tests.
4405 #[test]
4406 fn htlc_claim_single_commitment_only_a() {
4407         do_htlc_claim_local_commitment_only(true);
4408         do_htlc_claim_local_commitment_only(false);
4409
4410         do_htlc_claim_current_remote_commitment_only(true);
4411         do_htlc_claim_current_remote_commitment_only(false);
4412 }
4413
4414 #[test]
4415 fn htlc_claim_single_commitment_only_b() {
4416         do_htlc_claim_previous_remote_commitment_only(true, false);
4417         do_htlc_claim_previous_remote_commitment_only(false, false);
4418         do_htlc_claim_previous_remote_commitment_only(true, true);
4419         do_htlc_claim_previous_remote_commitment_only(false, true);
4420 }
4421
4422 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>)
4423         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4424                                 F2: FnMut(),
4425 {
4426         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);
4427 }
4428
4429 // test_case
4430 // 0: node1 fails backward
4431 // 1: final node fails backward
4432 // 2: payment completed but the user rejects the payment
4433 // 3: final node fails backward (but tamper onion payloads from node0)
4434 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4435 // 200: trigger error in the final node and tamper returning fail_htlc
4436 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>)
4437         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4438                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4439                                 F3: FnMut(),
4440 {
4441         use ln::msgs::HTLCFailChannelUpdate;
4442
4443         // reset block height
4444         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4445         for ix in 0..nodes.len() {
4446                 nodes[ix].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
4447         }
4448
4449         macro_rules! expect_event {
4450                 ($node: expr, $event_type: path) => {{
4451                         let events = $node.node.get_and_clear_pending_events();
4452                         assert_eq!(events.len(), 1);
4453                         match events[0] {
4454                                 $event_type { .. } => {},
4455                                 _ => panic!("Unexpected event"),
4456                         }
4457                 }}
4458         }
4459
4460         macro_rules! expect_htlc_forward {
4461                 ($node: expr) => {{
4462                         expect_event!($node, Event::PendingHTLCsForwardable);
4463                         $node.node.process_pending_htlc_forwards();
4464                 }}
4465         }
4466
4467         // 0 ~~> 2 send payment
4468         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4469         check_added_monitors!(nodes[0], 1);
4470         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4471         // temper update_add (0 => 1)
4472         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4473         if test_case == 0 || test_case == 3 || test_case == 100 {
4474                 callback_msg(&mut update_add_0);
4475                 callback_node();
4476         }
4477         // 0 => 1 update_add & CS
4478         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
4479         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4480
4481         let update_1_0 = match test_case {
4482                 0|100 => { // intermediate node failure; fail backward to 0
4483                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4484                         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));
4485                         update_1_0
4486                 },
4487                 1|2|3|200 => { // final node failure; forwarding to 2
4488                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4489                         // forwarding on 1
4490                         if test_case != 200 {
4491                                 callback_node();
4492                         }
4493                         expect_htlc_forward!(&nodes[1]);
4494
4495                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4496                         check_added_monitors!(&nodes[1], 1);
4497                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4498                         // tamper update_add (1 => 2)
4499                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4500                         if test_case != 3 && test_case != 200 {
4501                                 callback_msg(&mut update_add_1);
4502                         }
4503
4504                         // 1 => 2
4505                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
4506                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4507
4508                         if test_case == 2 || test_case == 200 {
4509                                 expect_htlc_forward!(&nodes[2]);
4510                                 expect_event!(&nodes[2], Event::PaymentReceived);
4511                                 callback_node();
4512                                 expect_pending_htlcs_forwardable!(nodes[2]);
4513                         }
4514
4515                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4516                         if test_case == 2 || test_case == 200 {
4517                                 check_added_monitors!(&nodes[2], 1);
4518                         }
4519                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4520
4521                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4522                         if test_case == 200 {
4523                                 callback_fail(&mut fail_msg);
4524                         }
4525
4526                         // 2 => 1
4527                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
4528                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4529
4530                         // backward fail on 1
4531                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4532                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4533                         update_1_0
4534                 },
4535                 _ => unreachable!(),
4536         };
4537
4538         // 1 => 0 commitment_signed_dance
4539         if update_1_0.update_fail_htlcs.len() > 0 {
4540                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4541                 if test_case == 100 {
4542                         callback_fail(&mut fail_msg);
4543                 }
4544                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
4545         } else {
4546                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
4547         };
4548
4549         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4550
4551         let events = nodes[0].node.get_and_clear_pending_events();
4552         assert_eq!(events.len(), 1);
4553         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4554                 assert_eq!(*rejected_by_dest, !expected_retryable);
4555                 assert_eq!(*error_code, expected_error_code);
4556         } else {
4557                 panic!("Uexpected event");
4558         }
4559
4560         let events = nodes[0].node.get_and_clear_pending_msg_events();
4561         if expected_channel_update.is_some() {
4562                 assert_eq!(events.len(), 1);
4563                 match events[0] {
4564                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4565                                 match update {
4566                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4567                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4568                                                         panic!("channel_update not found!");
4569                                                 }
4570                                         },
4571                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4572                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4573                                                         assert!(*short_channel_id == *expected_short_channel_id);
4574                                                         assert!(*is_permanent == *expected_is_permanent);
4575                                                 } else {
4576                                                         panic!("Unexpected message event");
4577                                                 }
4578                                         },
4579                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4580                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4581                                                         assert!(*node_id == *expected_node_id);
4582                                                         assert!(*is_permanent == *expected_is_permanent);
4583                                                 } else {
4584                                                         panic!("Unexpected message event");
4585                                                 }
4586                                         },
4587                                 }
4588                         },
4589                         _ => panic!("Unexpected message event"),
4590                 }
4591         } else {
4592                 assert_eq!(events.len(), 0);
4593         }
4594 }
4595
4596 impl msgs::ChannelUpdate {
4597         fn dummy() -> msgs::ChannelUpdate {
4598                 use secp256k1::ffi::Signature as FFISignature;
4599                 use secp256k1::Signature;
4600                 msgs::ChannelUpdate {
4601                         signature: Signature::from(FFISignature::new()),
4602                         contents: msgs::UnsignedChannelUpdate {
4603                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4604                                 short_channel_id: 0,
4605                                 timestamp: 0,
4606                                 flags: 0,
4607                                 cltv_expiry_delta: 0,
4608                                 htlc_minimum_msat: 0,
4609                                 fee_base_msat: 0,
4610                                 fee_proportional_millionths: 0,
4611                                 excess_data: vec![],
4612                         }
4613                 }
4614         }
4615 }
4616
4617 #[test]
4618 fn test_onion_failure() {
4619         use ln::msgs::ChannelUpdate;
4620         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4621         use secp256k1;
4622
4623         const BADONION: u16 = 0x8000;
4624         const PERM: u16 = 0x4000;
4625         const NODE: u16 = 0x2000;
4626         const UPDATE: u16 = 0x1000;
4627
4628         let mut nodes = create_network(3);
4629         for node in nodes.iter() {
4630                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4631         }
4632         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
4633         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4634         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
4635         // positve case
4636         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
4637
4638         // intermediate node failure
4639         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
4640                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4641                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4642                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4643                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4644                 onion_payloads[0].realm = 3;
4645                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4646         }, ||{}, true, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
4647
4648         // final node failure
4649         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
4650                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4651                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4652                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4653                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4654                 onion_payloads[1].realm = 3;
4655                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4656         }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4657
4658         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
4659         // receiving simulated fail messages
4660         // intermediate node failure
4661         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4662                 // trigger error
4663                 msg.amount_msat -= 1;
4664         }, |msg| {
4665                 // and tamper returning error message
4666                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4667                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4668                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
4669         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
4670
4671         // final node failure
4672         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4673                 // and tamper returning error message
4674                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4675                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4676                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
4677         }, ||{
4678                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4679         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
4680
4681         // intermediate node failure
4682         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4683                 msg.amount_msat -= 1;
4684         }, |msg| {
4685                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4686                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4687                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
4688         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4689
4690         // final node failure
4691         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4692                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4693                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4694                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
4695         }, ||{
4696                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4697         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4698
4699         // intermediate node failure
4700         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4701                 msg.amount_msat -= 1;
4702         }, |msg| {
4703                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4704                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4705                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
4706         }, ||{
4707                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4708         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4709
4710         // final node failure
4711         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4712                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4713                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4714                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
4715         }, ||{
4716                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4717         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4718
4719         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
4720                 Some(BADONION|PERM|4), None);
4721
4722         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
4723                 Some(BADONION|PERM|5), None);
4724
4725         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
4726                 Some(BADONION|PERM|6), None);
4727
4728         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4729                 msg.amount_msat -= 1;
4730         }, |msg| {
4731                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4732                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4733                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
4734         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4735
4736         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4737                 msg.amount_msat -= 1;
4738         }, |msg| {
4739                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4740                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4741                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
4742                 // short_channel_id from the processing node
4743         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4744
4745         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4746                 msg.amount_msat -= 1;
4747         }, |msg| {
4748                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4749                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4750                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
4751                 // short_channel_id from the processing node
4752         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4753
4754         let mut bogus_route = route.clone();
4755         bogus_route.hops[1].short_channel_id -= 1;
4756         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
4757           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
4758
4759         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
4760         let mut bogus_route = route.clone();
4761         let route_len = bogus_route.hops.len();
4762         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
4763         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4764
4765         //TODO: with new config API, we will be able to generate both valid and
4766         //invalid channel_update cases.
4767         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
4768                 msg.amount_msat -= 1;
4769         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4770
4771         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
4772                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
4773                 msg.cltv_expiry -= 1;
4774         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4775
4776         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
4777                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
4778                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4779                 nodes[1].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
4780         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4781
4782         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
4783                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4784         }, false, Some(PERM|15), None);
4785
4786         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
4787                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
4788                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4789                 nodes[2].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
4790         }, || {}, true, Some(17), None);
4791
4792         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
4793                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4794                         for f in pending_forwards.iter_mut() {
4795                                 match f {
4796                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4797                                                 forward_info.outgoing_cltv_value += 1,
4798                                         _ => {},
4799                                 }
4800                         }
4801                 }
4802         }, true, Some(18), None);
4803
4804         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
4805                 // violate amt_to_forward > msg.amount_msat
4806                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4807                         for f in pending_forwards.iter_mut() {
4808                                 match f {
4809                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4810                                                 forward_info.amt_to_forward -= 1,
4811                                         _ => {},
4812                                 }
4813                         }
4814                 }
4815         }, true, Some(19), None);
4816
4817         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
4818                 // disconnect event to the channel between nodes[1] ~ nodes[2]
4819                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
4820                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4821         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4822         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4823
4824         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
4825                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4826                 let mut route = route.clone();
4827                 let height = 1;
4828                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
4829                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4830                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
4831                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4832                 msg.cltv_expiry = htlc_cltv;
4833                 msg.onion_routing_packet = onion_packet;
4834         }, ||{}, true, Some(21), None);
4835 }
4836
4837 #[test]
4838 #[should_panic]
4839 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
4840         let nodes = create_network(2);
4841         //Force duplicate channel ids
4842         for node in nodes.iter() {
4843                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
4844         }
4845
4846         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
4847         let channel_value_satoshis=10000;
4848         let push_msat=10001;
4849         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
4850         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
4851         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel).unwrap();
4852
4853         //Create a second channel with a channel_id collision
4854         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4855 }
4856
4857 #[test]
4858 fn bolt2_open_channel_sending_node_checks_part2() {
4859         let nodes = create_network(2);
4860
4861         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
4862         let channel_value_satoshis=2^24;
4863         let push_msat=10001;
4864         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4865
4866         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
4867         let channel_value_satoshis=10000;
4868         // Test when push_msat is equal to 1000 * funding_satoshis.
4869         let push_msat=1000*channel_value_satoshis+1;
4870         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4871
4872         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
4873         let channel_value_satoshis=10000;
4874         let push_msat=10001;
4875         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_ok()); //Create a valid channel
4876         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
4877         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
4878
4879         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
4880         // 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
4881         assert!(node0_to_1_send_open_channel.channel_flags<=1);
4882
4883         // 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.
4884         assert!(BREAKDOWN_TIMEOUT>0);
4885         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
4886
4887         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
4888         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
4889         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
4890
4891         // 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.
4892         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
4893         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
4894         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
4895         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
4896         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
4897 }
4898
4899 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
4900 // 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.
4901 //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.
4902
4903 #[test]
4904 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
4905         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
4906         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
4907         let mut nodes = create_network(2);
4908         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
4909         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4910         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4911
4912         route.hops[0].fee_msat = 0;
4913
4914         let err = nodes[0].node.send_payment(route, our_payment_hash);
4915
4916         if let Err(APIError::ChannelUnavailable{err}) = err {
4917                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
4918         } else {
4919                 assert!(false);
4920         }
4921 }
4922
4923 #[test]
4924 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
4925         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
4926         //It is enforced when constructing a route.
4927         let mut nodes = create_network(2);
4928         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0);
4929         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
4930         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4931
4932         let err = nodes[0].node.send_payment(route, our_payment_hash);
4933
4934         if let Err(APIError::RouteError{err}) = err {
4935                 assert_eq!(err, "Channel CLTV overflowed?!");
4936         } else {
4937                 assert!(false);
4938         }
4939 }
4940
4941 #[test]
4942 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
4943         //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.
4944         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
4945         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
4946         let mut nodes = create_network(2);
4947         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
4948         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
4949
4950         for i in 0..max_accepted_htlcs {
4951                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4952                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4953                 let payment_event = {
4954                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4955                         check_added_monitors!(nodes[0], 1);
4956
4957                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4958                         assert_eq!(events.len(), 1);
4959                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
4960                                 assert_eq!(htlcs[0].htlc_id, i);
4961                         } else {
4962                                 assert!(false);
4963                         }
4964                         SendEvent::from_event(events.remove(0))
4965                 };
4966                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4967                 check_added_monitors!(nodes[1], 0);
4968                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4969
4970                 expect_pending_htlcs_forwardable!(nodes[1]);
4971                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
4972         }
4973         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4974         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4975         let err = nodes[0].node.send_payment(route, our_payment_hash);
4976
4977         if let Err(APIError::ChannelUnavailable{err}) = err {
4978                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
4979         } else {
4980                 assert!(false);
4981         }
4982 }
4983
4984 #[test]
4985 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
4986         //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.
4987         let mut nodes = create_network(2);
4988         let channel_value = 100000;
4989         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0);
4990         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
4991
4992         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
4993
4994         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
4995         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4996         let err = nodes[0].node.send_payment(route, our_payment_hash);
4997
4998         if let Err(APIError::ChannelUnavailable{err}) = err {
4999                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight");
5000         } else {
5001                 assert!(false);
5002         }
5003
5004         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
5005 }
5006
5007 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5008 #[test]
5009 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5010         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5011         let mut nodes = create_network(2);
5012         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5013         let htlc_minimum_msat: u64;
5014         {
5015                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5016                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5017                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5018         }
5019         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5020         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5021         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5022         check_added_monitors!(nodes[0], 1);
5023         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5024         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5025         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5026         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5027                 assert_eq!(err, "Remote side tried to send less than our minimum HTLC value");
5028         } else {
5029                 assert!(false);
5030         }
5031         assert!(nodes[1].node.list_channels().is_empty());
5032         check_closed_broadcast!(nodes[1]);
5033 }
5034
5035 #[test]
5036 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5037         //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
5038         let mut nodes = create_network(2);
5039         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5040
5041         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5042
5043         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5044         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5045         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5046         check_added_monitors!(nodes[0], 1);
5047         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5048
5049         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5050         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5051
5052         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5053                 assert_eq!(err, "Remote HTLC add would put them over their reserve value");
5054         } else {
5055                 assert!(false);
5056         }
5057
5058         assert!(nodes[1].node.list_channels().is_empty());
5059         check_closed_broadcast!(nodes[1]);
5060 }
5061
5062 #[test]
5063 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5064         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5065         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5066         let mut nodes = create_network(2);
5067         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5068         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5069         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5070
5071         let session_priv = SecretKey::from_slice(&{
5072                 let mut session_key = [0; 32];
5073                 rng::fill_bytes(&mut session_key);
5074                 session_key
5075         }).expect("RNG is bad!");
5076
5077         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5078         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5079         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5080         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5081
5082         let mut msg = msgs::UpdateAddHTLC {
5083                 channel_id: chan.2,
5084                 htlc_id: 0,
5085                 amount_msat: 1000,
5086                 payment_hash: our_payment_hash,
5087                 cltv_expiry: htlc_cltv,
5088                 onion_routing_packet: onion_packet.clone(),
5089         };
5090
5091         for i in 0..super::channel::OUR_MAX_HTLCS {
5092                 msg.htlc_id = i as u64;
5093                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).unwrap();
5094         }
5095         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5096         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5097
5098         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5099                 assert_eq!(err, "Remote tried to push more than our max accepted HTLCs");
5100         } else {
5101                 assert!(false);
5102         }
5103
5104         assert!(nodes[1].node.list_channels().is_empty());
5105         check_closed_broadcast!(nodes[1]);
5106 }
5107
5108 #[test]
5109 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5110         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5111         let mut nodes = create_network(2);
5112         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5113         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5114         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5115         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5116         check_added_monitors!(nodes[0], 1);
5117         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5118         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5119         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5120
5121         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5122                 assert_eq!(err,"Remote HTLC add would put them over their max HTLC value in flight");
5123         } else {
5124                 assert!(false);
5125         }
5126
5127         assert!(nodes[1].node.list_channels().is_empty());
5128         check_closed_broadcast!(nodes[1]);
5129 }
5130
5131 #[test]
5132 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5133         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5134         let mut nodes = create_network(2);
5135         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5136         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5137         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5138         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5139         check_added_monitors!(nodes[0], 1);
5140         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5141         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5142         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5143
5144         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5145                 assert_eq!(err,"Remote provided CLTV expiry in seconds instead of block height");
5146         } else {
5147                 assert!(false);
5148         }
5149
5150         assert!(nodes[1].node.list_channels().is_empty());
5151         check_closed_broadcast!(nodes[1]);
5152 }
5153
5154 #[test]
5155 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5156         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5157         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5158         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5159         let mut nodes = create_network(2);
5160         create_announced_chan_between_nodes(&nodes, 0, 1);
5161         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5162         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5163         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5164         check_added_monitors!(nodes[0], 1);
5165         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5166         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5167
5168         //Disconnect and Reconnect
5169         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5170         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5171         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5172         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5173         assert_eq!(reestablish_1.len(), 1);
5174         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5175         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5176         assert_eq!(reestablish_2.len(), 1);
5177         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5178         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5179         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5180         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5181
5182         //Resend HTLC
5183         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5184         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5185         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
5186         check_added_monitors!(nodes[1], 1);
5187         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5188
5189         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5190         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5191                 assert_eq!(err, "Remote skipped HTLC ID");
5192         } else {
5193                 assert!(false);
5194         }
5195
5196         assert!(nodes[1].node.list_channels().is_empty());
5197         check_closed_broadcast!(nodes[1]);
5198 }
5199
5200 #[test]
5201 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5202         //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.
5203
5204         let mut nodes = create_network(2);
5205         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5206
5207         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5208         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5209         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5210         check_added_monitors!(nodes[0], 1);
5211         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5212         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5213
5214         let update_msg = msgs::UpdateFulfillHTLC{
5215                 channel_id: chan.2,
5216                 htlc_id: 0,
5217                 payment_preimage: our_payment_preimage,
5218         };
5219
5220         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5221
5222         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5223                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5224         } else {
5225                 assert!(false);
5226         }
5227
5228         assert!(nodes[0].node.list_channels().is_empty());
5229         check_closed_broadcast!(nodes[0]);
5230 }
5231
5232 #[test]
5233 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5234         //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.
5235
5236         let mut nodes = create_network(2);
5237         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5238
5239         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5240         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5241         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5242         check_added_monitors!(nodes[0], 1);
5243         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5244         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5245
5246         let update_msg = msgs::UpdateFailHTLC{
5247                 channel_id: chan.2,
5248                 htlc_id: 0,
5249                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5250         };
5251
5252         let err = nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5253
5254         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5255                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5256         } else {
5257                 assert!(false);
5258         }
5259
5260         assert!(nodes[0].node.list_channels().is_empty());
5261         check_closed_broadcast!(nodes[0]);
5262 }
5263
5264 #[test]
5265 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5266         //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.
5267
5268         let mut nodes = create_network(2);
5269         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5270
5271         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5272         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5273         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5274         check_added_monitors!(nodes[0], 1);
5275         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5276         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5277
5278         let update_msg = msgs::UpdateFailMalformedHTLC{
5279                 channel_id: chan.2,
5280                 htlc_id: 0,
5281                 sha256_of_onion: [1; 32],
5282                 failure_code: 0x8000,
5283         };
5284
5285         let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5286
5287         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5288                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5289         } else {
5290                 assert!(false);
5291         }
5292
5293         assert!(nodes[0].node.list_channels().is_empty());
5294         check_closed_broadcast!(nodes[0]);
5295 }
5296
5297 #[test]
5298 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5299         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5300
5301         let nodes = create_network(2);
5302         create_announced_chan_between_nodes(&nodes, 0, 1);
5303
5304         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5305
5306         nodes[1].node.claim_funds(our_payment_preimage);
5307         check_added_monitors!(nodes[1], 1);
5308
5309         let events = nodes[1].node.get_and_clear_pending_msg_events();
5310         assert_eq!(events.len(), 1);
5311         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5312                 match events[0] {
5313                         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, .. } } => {
5314                                 assert!(update_add_htlcs.is_empty());
5315                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5316                                 assert!(update_fail_htlcs.is_empty());
5317                                 assert!(update_fail_malformed_htlcs.is_empty());
5318                                 assert!(update_fee.is_none());
5319                                 update_fulfill_htlcs[0].clone()
5320                         },
5321                         _ => panic!("Unexpected event"),
5322                 }
5323         };
5324
5325         update_fulfill_msg.htlc_id = 1;
5326
5327         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5328         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5329                 assert_eq!(err, "Remote tried to fulfill/fail an HTLC we couldn't find");
5330         } else {
5331                 assert!(false);
5332         }
5333
5334         assert!(nodes[0].node.list_channels().is_empty());
5335         check_closed_broadcast!(nodes[0]);
5336 }
5337
5338 #[test]
5339 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5340         //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.
5341
5342         let nodes = create_network(2);
5343         create_announced_chan_between_nodes(&nodes, 0, 1);
5344
5345         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5346
5347         nodes[1].node.claim_funds(our_payment_preimage);
5348         check_added_monitors!(nodes[1], 1);
5349
5350         let events = nodes[1].node.get_and_clear_pending_msg_events();
5351         assert_eq!(events.len(), 1);
5352         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5353                 match events[0] {
5354                         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, .. } } => {
5355                                 assert!(update_add_htlcs.is_empty());
5356                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5357                                 assert!(update_fail_htlcs.is_empty());
5358                                 assert!(update_fail_malformed_htlcs.is_empty());
5359                                 assert!(update_fee.is_none());
5360                                 update_fulfill_htlcs[0].clone()
5361                         },
5362                         _ => panic!("Unexpected event"),
5363                 }
5364         };
5365
5366         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5367
5368         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5369         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5370                 assert_eq!(err, "Remote tried to fulfill HTLC with an incorrect preimage");
5371         } else {
5372                 assert!(false);
5373         }
5374
5375         assert!(nodes[0].node.list_channels().is_empty());
5376         check_closed_broadcast!(nodes[0]);
5377 }
5378
5379
5380 #[test]
5381 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5382         //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.
5383
5384         let mut nodes = create_network(2);
5385         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5386         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5387         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5388         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5389         check_added_monitors!(nodes[0], 1);
5390
5391         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5392         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5393
5394         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5395         check_added_monitors!(nodes[1], 0);
5396         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5397
5398         let events = nodes[1].node.get_and_clear_pending_msg_events();
5399
5400         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5401                 match events[0] {
5402                         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, .. } } => {
5403                                 assert!(update_add_htlcs.is_empty());
5404                                 assert!(update_fulfill_htlcs.is_empty());
5405                                 assert!(update_fail_htlcs.is_empty());
5406                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5407                                 assert!(update_fee.is_none());
5408                                 update_fail_malformed_htlcs[0].clone()
5409                         },
5410                         _ => panic!("Unexpected event"),
5411                 }
5412         };
5413         update_msg.failure_code &= !0x8000;
5414         let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5415         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5416                 assert_eq!(err, "Got update_fail_malformed_htlc with BADONION not set");
5417         } else {
5418                 assert!(false);
5419         }
5420
5421         assert!(nodes[0].node.list_channels().is_empty());
5422         check_closed_broadcast!(nodes[0]);
5423 }
5424
5425 #[test]
5426 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5427         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5428         //    * 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.
5429
5430         let mut nodes = create_network(3);
5431         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5432         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000);
5433
5434         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5435         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5436
5437         //First hop
5438         let mut payment_event = {
5439                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5440                 check_added_monitors!(nodes[0], 1);
5441                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5442                 assert_eq!(events.len(), 1);
5443                 SendEvent::from_event(events.remove(0))
5444         };
5445         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5446         check_added_monitors!(nodes[1], 0);
5447         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5448         expect_pending_htlcs_forwardable!(nodes[1]);
5449         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5450         assert_eq!(events_2.len(), 1);
5451         check_added_monitors!(nodes[1], 1);
5452         payment_event = SendEvent::from_event(events_2.remove(0));
5453         assert_eq!(payment_event.msgs.len(), 1);
5454
5455         //Second Hop
5456         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5457         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5458         check_added_monitors!(nodes[2], 0);
5459         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5460
5461         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5462         assert_eq!(events_3.len(), 1);
5463         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5464                 match events_3[0] {
5465                         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 } } => {
5466                                 assert!(update_add_htlcs.is_empty());
5467                                 assert!(update_fulfill_htlcs.is_empty());
5468                                 assert!(update_fail_htlcs.is_empty());
5469                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5470                                 assert!(update_fee.is_none());
5471                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5472                         },
5473                         _ => panic!("Unexpected event"),
5474                 }
5475         };
5476
5477         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0).unwrap();
5478
5479         check_added_monitors!(nodes[1], 0);
5480         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5481         expect_pending_htlcs_forwardable!(nodes[1]);
5482         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5483         assert_eq!(events_4.len(), 1);
5484
5485         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5486         match events_4[0] {
5487                 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, .. } } => {
5488                         assert!(update_add_htlcs.is_empty());
5489                         assert!(update_fulfill_htlcs.is_empty());
5490                         assert_eq!(update_fail_htlcs.len(), 1);
5491                         assert!(update_fail_malformed_htlcs.is_empty());
5492                         assert!(update_fee.is_none());
5493                 },
5494                 _ => panic!("Unexpected event"),
5495         };
5496
5497         check_added_monitors!(nodes[1], 1);
5498 }